Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Comm Messages API

2 actions 2 updates phrasing extends openapi/canvas-comm-messages-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Canvas's API. It is a proposal applied on top of the contract, not a document Canvas publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/v1/comm_messages'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Canvas LMS REST Comm Messages API
  version: 1.0.0
extends: openapi/canvas-comm-messages-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/v1/comm_messages'].get
  update:
    x-apievangelist-phrasing:
      intent: List notification messages sent to a user
      effect: read
      questions:
      - What emails and notifications has Canvas sent to a user?
      - Can I see messages sent to someone within a date range?
      instructions:
      - text: List messages sent to user {user_id}.
        slots:
          user_id: query.user_id
      - text: Show messages sent to user {user_id} between {start_time} and {end_time}.
        slots:
          user_id: query.user_id
          start_time: query.start_time
          end_time: query.end_time
      method: generated
      generated: '2026-10-01'