Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Quiz Questions API

6 actions 6 updates phrasing extends openapi/canvas-quiz-questions-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['/v1/courses/{course_id}/quizzes/{quiz_id}/questions'].get

$.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/questions'].post

$.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/questions/{id}'].get

$.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/questions/{id}'].put

$.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/questions/{id}'].delete

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 Quiz Questions API
  version: 1.0.0
extends: openapi/canvas-quiz-questions-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['/v1/courses/{course_id}/quizzes/{quiz_id}/questions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the questions in a classic quiz
      effect: read
      questions:
      - What questions are in a classic Canvas quiz?
      - Can I see the exact questions a student got on a specific quiz attempt?
      instructions:
      - text: List the questions in quiz {quiz_id} of course {course_id}.
        slots:
          quiz_id: path.quiz_id
          course_id: path.course_id
      - text: Show questions from submission {quiz_submission_id} attempt {attempt} of quiz {quiz_id} in {course_id}.
        slots:
          quiz_submission_id: query.quiz_submission_id
          attempt: query.quiz_submission_attempt
          quiz_id: path.quiz_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/questions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a question to a classic quiz
      effect: write
      questions:
      - How do I add a new question to an existing classic quiz?
      - Can I set the point value and question type when creating a quiz question?
      instructions:
      - text: Add a question {question_name} to quiz {quiz_id} in course {course_id}.
        slots:
          question_name: requestBody.question[question_name]
          quiz_id: path.quiz_id
          course_id: path.course_id
      - text: Create a {question_type} question worth {points} points in quiz {quiz_id} of {course_id}.
        slots:
          question_type: requestBody.question[question_type]
          points: requestBody.question[points_possible]
          quiz_id: path.quiz_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/questions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one classic quiz question
      effect: read
      questions:
      - Can I fetch a single quiz question with its answers?
      - What does a classic quiz question record contain?
      instructions:
      - text: Get question {id} from quiz {quiz_id} in course {course_id}.
        slots:
          id: path.id
          quiz_id: path.quiz_id
          course_id: path.course_id
      - text: Show quiz {quiz_id} question {id} in {course_id}.
        slots:
          quiz_id: path.quiz_id
          id: path.id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/questions/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a classic quiz question
      effect: write
      questions:
      - Can I fix a typo in a quiz question that's already published?
      - Is changing the points on an existing quiz question allowed?
      instructions:
      - text: Change the text of question {id} in quiz {quiz_id} of course {course_id} to {question_text}.
        slots:
          id: path.id
          quiz_id: path.quiz_id
          course_id: path.course_id
          question_text: requestBody.question[question_text]
      - text: Make quiz {quiz_id} question {id} in {course_id} worth {points} points.
        slots:
          quiz_id: path.quiz_id
          id: path.id
          course_id: path.course_id
          points: requestBody.question[points_possible]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/questions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a classic quiz question
      effect: destructive
      questions:
      - Can I remove a question from a classic quiz?
      - What response confirms a quiz question was deleted?
      instructions:
      - text: Delete question {id} from quiz {quiz_id} in course {course_id}.
        slots:
          id: path.id
          quiz_id: path.quiz_id
          course_id: path.course_id
      - text: Remove quiz {quiz_id} question {id} in {course_id}.
        slots:
          quiz_id: path.quiz_id
          id: path.id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'