Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Collaborations API

6 actions 6 updates phrasing extends openapi/canvas-collaborations-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 6

$.info

$.paths['/v1/courses/{course_id}/collaborations'].get

$.paths['/v1/groups/{group_id}/collaborations'].get

$.paths['/v1/collaborations/{id}/members'].get

$.paths['/v1/courses/{course_id}/potential_collaborators'].get

$.paths['/v1/groups/{group_id}/potential_collaborators'].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 Collaborations API
  version: 1.0.0
extends: openapi/canvas-collaborations-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: 5
- target: $.paths['/v1/courses/{course_id}/collaborations'].get
  update:
    x-apievangelist-phrasing:
      intent: List a course's collaborations
      effect: read
      questions:
      - What collaborative documents exist in my Canvas course?
      - Does the course collaborations list include only external tool collaborations?
      instructions:
      - text: List the collaborations in course {course_id}.
        slots:
          course_id: path.course_id
      - text: Show the shared collaboration docs I can access in course {course_id}.
        slots:
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/groups/{group_id}/collaborations'].get
  update:
    x-apievangelist-phrasing:
      intent: List a group's collaborations
      effect: read
      questions:
      - Which collaborations has a student group created?
      - Can I see external tool collaborations for a group?
      instructions:
      - text: List the collaborations in group {group_id}.
        slots:
          group_id: path.group_id
      - text: Show collaboration docs for group {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/collaborations/{id}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List members of a collaboration
      effect: read
      questions:
      - Who is part of a given collaboration?
      - Can I include collaborator avatars when listing a collaboration's members?
      instructions:
      - text: List the members of collaboration {id}.
        slots:
          id: path.id
      - text: Show collaborators on {id} including {include}.
        slots:
          id: path.id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/potential_collaborators'].get
  update:
    x-apievangelist-phrasing:
      intent: List users who could join a course collaboration
      effect: read
      questions:
      - Who can I add to a collaboration in my course?
      - Are all enrolled users eligible as course collaborators?
      instructions:
      - text: List potential collaborators in course {course_id}.
        slots:
          course_id: path.course_id
      - text: Show who I could invite to a collaboration in course {course_id}.
        slots:
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/groups/{group_id}/potential_collaborators'].get
  update:
    x-apievangelist-phrasing:
      intent: List users who could join a group collaboration
      effect: read
      questions:
      - Who is eligible to be added to a group collaboration?
      - Do course admins count as potential collaborators for a group?
      instructions:
      - text: List potential collaborators in group {group_id}.
        slots:
          group_id: path.group_id
      - text: Show who could be invited to a collaboration in group {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-10-01'