Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Names And Role API

3 actions 3 updates phrasing extends openapi/canvas-names-and-role-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 3

$.info

$.paths['/lti/courses/{course_id}/names_and_roles'].get

$.paths['/lti/groups/{group_id}/names_and_roles'].get

OpenAPI Overlay

# 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 Names And Role API
  version: 1.0.0
extends: openapi/canvas-names-and-role-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: 2
- target: $.paths['/lti/courses/{course_id}/names_and_roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List a course roster for an LTI tool
      effect: read
      questions:
      - How does an LTI tool get the names and roles of everyone in a Canvas course?
      - Can a course membership list be filtered to only learners?
      instructions:
      - text: List the names and roles roster for course {course_id}.
        slots:
          course_id: path.course_id
      - text: Get course {course_id} members with role {role}, {limit} per page.
        slots:
          course_id: path.course_id
          role: query.role
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lti/groups/{group_id}/names_and_roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List a group roster for an LTI tool
      effect: read
      questions:
      - Can my LTI tool pull the active members of a Canvas group?
      - Is filtering a group's membership by role supported?
      instructions:
      - text: List the names and roles of members in group {group_id}.
        slots:
          group_id: path.group_id
      - text: Get group {group_id} members whose role is {role}.
        slots:
          group_id: path.group_id
          role: query.role
      method: generated
      generated: '2026-10-01'