Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Api Token Scopes API

2 actions 2 updates phrasing extends openapi/canvas-api-token-scopes-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/{account_id}/scopes'].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 Api Token Scopes API
  version: 1.0.0
extends: openapi/canvas-api-token-scopes-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/{account_id}/scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: List API scopes for developer keys and tokens
      effect: read
      questions:
      - Which API scopes can I apply to a Canvas developer key or access token?
      - Can I get the available scopes grouped by resource?
      instructions:
      - text: List the API token scopes for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show scopes available in account {account_id} grouped by {group_by}.
        slots:
          account_id: path.account_id
          group_by: query.group_by
      method: generated
      generated: '2026-10-01'