Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Accounts (Lti) API

2 actions 2 updates phrasing extends openapi/canvas-accounts-lti-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['/lti/accounts/{account_id}'].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 Accounts (Lti) API
  version: 1.0.0
extends: openapi/canvas-accounts-lti-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['/lti/accounts/{account_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get account details for an LTI tool
      effect: read
      questions:
      - How can an LTI tool look up the account it's installed in?
      - Can I retrieve an account using its global ID from an LTI integration?
      instructions:
      - text: Get account {account_id} for my LTI tool.
        slots:
          account_id: path.account_id
      - text: Look up LTI account {account_id} by local or global ID.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'