Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Accessibility Course Scans API

2 actions 2 updates phrasing extends openapi/canvas-accessibility-course-scans-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/users/{user_id}/educator_accessibility_course_scan'].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 Accessibility Course Scans API
  version: 1.0.0
extends: openapi/canvas-accessibility-course-scans-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/users/{user_id}/educator_accessibility_course_scan'].post
  update:
    x-apievangelist-phrasing:
      intent: Scan my courses for accessibility issues
      effect: write
      questions:
      - How do I run an accessibility check across all the courses I teach?
      - What happens if I trigger an accessibility scan while one is already running?
      instructions:
      - text: Trigger an accessibility course scan for user {user_id}.
        slots:
          user_id: path.user_id
      - text: Scan all my teaching courses for accessibility problems as user {user_id}.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-10-01'