Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Smart Search API

2 actions 2 updates phrasing extends openapi/canvas-smart-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 2

$.info

$.paths['/v1/courses/{course_id}/smartsearch'].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 Smart Search API
  version: 1.0.0
extends: openapi/canvas-smart-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: 1
- target: $.paths['/v1/courses/{course_id}/smartsearch'].get
  update:
    x-apievangelist-phrasing:
      intent: Search course content by meaning
      effect: read
      questions:
      - Where in my course is a topic covered, even if the exact words differ?
      - Can I run a meaning-based search limited to pages or assignments?
      instructions:
      - text: Search course {course_id} content for {q}.
        slots:
          course_id: path.course_id
          q: query.q
      - text: Find {filter} in course {course_id} related to {q}.
        slots:
          filter: query.filter
          course_id: path.course_id
          q: query.q
      method: generated
      generated: '2026-10-01'