Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Search API

4 actions 4 updates phrasing extends openapi/canvas-search-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/conversations/find_recipients'].get

$.paths['/v1/search/recipients'].get

$.paths['/v1/search/all_courses'].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 Search API
  version: 1.0.0
extends: openapi/canvas-search-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/conversations/find_recipients'].get
  update:
    x-apievangelist-phrasing:
      intent: Find message recipients (deprecated conversations path)
      effect: read
      questions:
      - Is the old conversations find_recipients endpoint still usable for looking up who I can message?
      - What does the deprecated conversations recipient lookup return?
      instructions:
      - text: Use the deprecated conversations endpoint to find recipients matching {search}.
        slots:
          search: query.search
      - text: Look up messageable users in {context} through the legacy conversations find_recipients path.
        slots:
          context: query.context
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/search/recipients'].get
  update:
    x-apievangelist-phrasing:
      intent: Find people, courses and groups I can message
      effect: read
      questions:
      - Who can I send a message to whose name starts with a few letters?
      - Can I limit recipient search to just users or just groups?
      - Which students in a specific course can I message?
      instructions:
      - text: Search recipients I can message matching {search}.
        slots:
          search: query.search
      - text: Find {type} recipients in {context} that I can send messages to.
        slots:
          type: query.type
          context: query.context
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/search/all_courses'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse courses in the public course index
      effect: read
      questions:
      - Which courses are listed in the public course index?
      - Can I find only courses open for self-enrollment?
      instructions:
      - text: Search the public course index for {search}.
        slots:
          search: query.search
      - text: List public index courses with open enrollment only set to {open_enrollment_only}.
        slots:
          open_enrollment_only: query.open_enrollment_only
      method: generated
      generated: '2026-10-01'