Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Account Domain Lookups API

2 actions 2 updates phrasing extends openapi/canvas-account-domain-lookups-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/accounts/search'].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 Account Domain Lookups API
  version: 1.0.0
extends: openapi/canvas-account-domain-lookups-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/accounts/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Find a school's Canvas domain
      effect: read
      questions:
      - How can I find my school's Canvas login domain by its name?
      - Can I search institutions near a location?
      - How many matches does the account domain search return?
      instructions:
      - text: Find the account domain for {name}.
        slots:
          name: query.name
      - text: Search account domains matching {domain}.
        slots:
          domain: query.domain
      - text: Find schools near latitude {latitude} and longitude {longitude}.
        slots:
          latitude: query.latitude
          longitude: query.longitude
      method: generated
      generated: '2026-10-01'