Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST New Quizzes API

6 actions 6 updates phrasing extends openapi/canvas-new-quizzes-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 6

$.info

$.paths['/quiz/v1/courses/{course_id}/quizzes/{assignment_id}'].get

$.paths['/quiz/v1/courses/{course_id}/quizzes/{assignment_id}'].delete

$.paths['/quiz/v1/courses/{course_id}/quizzes/{assignment_id}'].patch

$.paths['/quiz/v1/courses/{course_id}/quizzes'].get

$.paths['/quiz/v1/courses/{course_id}/quizzes'].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 API
  version: 1.0.0
extends: openapi/canvas-new-quizzes-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: 5
- target: $.paths['/quiz/v1/courses/{course_id}/quizzes/{assignment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a New Quiz
      effect: read
      questions:
      - How do I get the settings of a single New Quiz?
      - Can I read a New Quizzes assessment by its assignment id?
      instructions:
      - text: Show New Quiz {assignment_id} in course {course_id}.
        slots:
          assignment_id: path.assignment_id
          course_id: path.course_id
      - text: Get the details of quiz {assignment_id} from course {course_id} in New Quizzes.
        slots:
          assignment_id: path.assignment_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/quiz/v1/courses/{course_id}/quizzes/{assignment_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a New Quiz
      effect: destructive
      questions:
      - How do I delete a quiz built in New Quizzes?
      - Can I remove one New Quiz from a course?
      instructions:
      - text: Delete New Quiz {assignment_id} from course {course_id}.
        slots:
          assignment_id: path.assignment_id
          course_id: path.course_id
      - text: Remove the New Quizzes assessment {assignment_id} in course {course_id}.
        slots:
          assignment_id: path.assignment_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/quiz/v1/courses/{course_id}/quizzes/{assignment_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a New Quiz
      effect: write
      questions:
      - Can I change a New Quiz's due date or time limit?
      - How do I allow multiple attempts or shuffle answers on an existing New Quiz?
      instructions:
      - text: Change New Quiz {assignment_id} in course {course_id} to be due {due_at}.
        slots:
          assignment_id: path.assignment_id
          course_id: path.course_id
          due_at: requestBody.quiz[due_at]
      - text: Set a {session_time_limit_in_seconds} second time limit on New Quiz {assignment_id} in course {course_id}.
        slots:
          session_time_limit_in_seconds: requestBody.quiz[quiz_settings][session_time_limit_in_seconds]
          assignment_id: path.assignment_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/quiz/v1/courses/{course_id}/quizzes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a course's New Quizzes
      effect: read
      questions:
      - Which New Quizzes exist in a course?
      - Can I list all the New Quizzes assessments in one course?
      instructions:
      - text: List New Quizzes in course {course_id}.
        slots:
          course_id: path.course_id
      - text: Show every New Quiz for course {course_id}.
        slots:
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/quiz/v1/courses/{course_id}/quizzes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a New Quiz
      effect: write
      questions:
      - How do I create a quiz in New Quizzes for a course?
      - Can I require a student access code when creating a New Quiz?
      instructions:
      - text: Create a New Quiz titled {title} in course {course_id}.
        slots:
          title: requestBody.quiz[title]
          course_id: path.course_id
      - text: Add New Quiz {title} worth {points_possible} points to course {course_id}.
        slots:
          title: requestBody.quiz[title]
          points_possible: requestBody.quiz[points_possible]
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'