Canvas · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/canvas-accessibility-course-statistics-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/users/{user_id}/educator_accessibility_course_statistics'].get

$.paths['/v1/users/{user_id}/educator_accessibility_course_terms'].get

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 Statistics API
  version: 1.0.0
extends: openapi/canvas-accessibility-course-statistics-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/users/{user_id}/educator_accessibility_course_statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: List accessibility issue counts per course I teach
      effect: read
      questions:
      - How many accessibility issues does each of my Canvas courses have?
      - Can I see accessibility checker statistics for only one enrollment term?
      instructions:
      - text: List accessibility course statistics for user {user_id}.
        slots:
          user_id: path.user_id
      - text: Show accessibility issue counts for {user_id}'s courses in term {enrollment_term_id}.
        slots:
          user_id: path.user_id
          enrollment_term_id: query.enrollment_term_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/users/{user_id}/educator_accessibility_course_terms'].get
  update:
    x-apievangelist-phrasing:
      intent: List terms for the accessibility statistics filter
      effect: read
      questions:
      - Which enrollment terms can I filter my accessibility course statistics by?
      - What terms do my active teacher and designer courses belong to?
      instructions:
      - text: List the accessibility statistic terms for user {user_id}.
        slots:
          user_id: path.user_id
      - text: Get the term options for user {user_id}'s accessibility report filter.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-10-01'