Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Conferences API

4 actions 4 updates phrasing extends openapi/canvas-conferences-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 4

$.info
$.paths['/v1/courses/{course_id}/conferences'].get
$.paths['/v1/groups/{group_id}/conferences'].get
$.paths['/v1/conferences'].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 Conferences API
  version: 1.0.0
extends: openapi/canvas-conferences-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: 3
- target: $.paths['/v1/courses/{course_id}/conferences'].get
  update:
    x-apievangelist-phrasing:
      intent: List a course's web conferences
      effect: read
      questions:
      - What web conferences are scheduled in my course?
      - Can I see all the online class meetings set up for one course?
      instructions:
      - text: List conferences in course {course_id}.
        slots:
          course_id: path.course_id
      - text: Show the web conferences set up for course {course_id}.
        slots:
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/groups/{group_id}/conferences'].get
  update:
    x-apievangelist-phrasing:
      intent: List a group's web conferences
      effect: read
      questions:
      - What conferences does my student group have?
      - Can I list online meetings created inside a group rather than a course?
      instructions:
      - text: List conferences in group {group_id}.
        slots:
          group_id: path.group_id
      - text: Show the web conferences for group {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/conferences'].get
  update:
    x-apievangelist-phrasing:
      intent: List conferences across all my courses and groups
      effect: read
      questions:
      - Which conferences am I part of across every course and group?
      - Can I see only my live conferences right now?
      instructions:
      - text: List all my conferences across courses and groups.
      - text: Show my conferences in the {state} state.
        slots:
          state: query.state
      method: generated
      generated: '2026-10-01'