Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Jw Ts API

3 actions 3 updates phrasing extends openapi/canvas-jwts-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 3

$.info
$.paths['/v1/jwts'].post
$.paths['/v1/jwts/refresh'].post

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 Jw Ts API
  version: 1.0.0
extends: openapi/canvas-jwts-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: 2
- target: $.paths['/v1/jwts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a JWT for other Canvas services
      effect: write
      questions:
      - How do I get a short-lived JWT to call other Canvas services?
      - How long does a newly created Canvas JWT stay valid?
      instructions:
      - text: Create a JWT for workflows {workflows}.
        slots:
          workflows: requestBody.workflows
      - text: Generate a JWT scoped to {context_type} {context_id} for audience {canvas_audience}.
        slots:
          context_type: requestBody.context_type
          context_id: requestBody.context_id
          canvas_audience: requestBody.canvas_audience
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/jwts/refresh'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh an existing JWT
      effect: write
      questions:
      - Can I swap an expiring JWT for a fresh one?
      - What do I send to get a refreshed token from an old JWT?
      instructions:
      - text: Refresh JWT {jwt}.
        slots:
          jwt: requestBody.jwt
      - text: Exchange my old token {jwt} for a new one-hour JWT.
        slots:
          jwt: requestBody.jwt
      method: generated
      generated: '2026-10-01'