Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Services API

3 actions 3 updates phrasing extends openapi/canvas-services-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/services/kaltura'].get

$.paths['/v1/services/kaltura_session'].post

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 Services API
  version: 1.0.0
extends: openapi/canvas-services-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/services/kaltura'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Kaltura plugin configuration
      effect: read
      questions:
      - Is Kaltura media enabled on this Canvas instance?
      - What Kaltura settings does Canvas expose?
      instructions:
      - text: Get the Kaltura configuration.
      - text: Show the Kaltura plugin settings for this instance.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/services/kaltura_session'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a Kaltura upload session
      effect: write
      questions:
      - How do I start a Kaltura session so I can record and upload media?
      - What do I need before uploading new media to Kaltura?
      instructions:
      - text: Start a new Kaltura session.
      - text: Open a Kaltura session so I can upload a recording.
      method: generated
      generated: '2026-10-01'