Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST New Quizzes Accommodations API

3 actions 3 updates phrasing extends openapi/canvas-new-quizzes-accommodations-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['/quiz/v1/courses/{course_id}/quizzes/{assignment_id}/accommodations'].post

$.paths['/quiz/v1/courses/{course_id}/accommodations'].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 New Quizzes Accommodations API
  version: 1.0.0
extends: openapi/canvas-new-quizzes-accommodations-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['/quiz/v1/courses/{course_id}/quizzes/{assignment_id}/accommodations'].post
  update:
    x-apievangelist-phrasing:
      intent: Give a student accommodations on one quiz
      effect: write
      questions:
      - How do I give a student extra time on just one New Quiz?
      - Can I grant extra attempts or reduced answer choices for a single quiz?
      instructions:
      - text: Give student {user_id} {extra_time} extra minutes on quiz {assignment_id} in course {course_id}.
        slots:
          user_id: requestBody.user_id
          extra_time: requestBody.extra_time
          assignment_id: path.assignment_id
          course_id: path.course_id
      - text: Grant student {user_id} {extra_attempts} extra attempts on quiz {assignment_id} in course {course_id}.
        slots:
          user_id: requestBody.user_id
          extra_attempts: requestBody.extra_attempts
          assignment_id: path.assignment_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/quiz/v1/courses/{course_id}/accommodations'].post
  update:
    x-apievangelist-phrasing:
      intent: Give a student accommodations across a course
      effect: write
      questions:
      - How do I give a student extra time on every quiz in a course?
      - Can course-wide accommodations apply to quiz sessions already in progress?
      instructions:
      - text: Give student {user_id} {extra_time} extra minutes on all quizzes in course {course_id}.
        slots:
          user_id: requestBody.user_id
          extra_time: requestBody.extra_time
          course_id: path.course_id
      - text: Turn on reduced answer choices for student {user_id} across course {course_id}.
        slots:
          user_id: requestBody.user_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'