Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Quiz Submission Questions API

6 actions 6 updates phrasing extends openapi/canvas-quiz-submission-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/quiz_submissions/{quiz_submission_id}/questions'].get

$.paths['/v1/quiz_submissions/{quiz_submission_id}/questions'].post

$.paths['/v1/quiz_submissions/{quiz_submission_id}/questions/{id}/formatted_answer'].get

$.paths['/v1/quiz_submissions/{quiz_submission_id}/questions/{id}/flag'].put

$.paths['/v1/quiz_submissions/{quiz_submission_id}/questions/{id}/unflag'].put

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 Submission Questions API
  version: 1.0.0
extends: openapi/canvas-quiz-submission-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/quiz_submissions/{quiz_submission_id}/questions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the questions in a quiz submission
      effect: read
      questions:
      - How do I see every question record in a student's quiz attempt?
      - Can I include the quiz questions themselves alongside the submission records?
      instructions:
      - text: List the questions for quiz submission {quiz_submission_id}.
        slots:
          quiz_submission_id: path.quiz_submission_id
      - text: Show all question records in quiz submission {quiz_submission_id}.
        slots:
          quiz_submission_id: path.quiz_submission_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/quiz_submissions/{quiz_submission_id}/questions'].post
  update:
    x-apievangelist-phrasing:
      intent: Answer questions in a quiz submission
      effect: write
      questions:
      - How do I submit or change answers for questions in a quiz attempt?
      - What does answering a quiz question require, like the attempt number and validation token?
      instructions:
      - text: Save answers {quiz_questions} for attempt {attempt} of quiz submission {quiz_submission_id} using token {validation_token}.
        slots:
          quiz_questions: requestBody.quiz_questions
          attempt: requestBody.attempt
          quiz_submission_id: path.quiz_submission_id
          validation_token: requestBody.validation_token
      - text: Answer questions in quiz submission {quiz_submission_id}, attempt {attempt}, token {validation_token}.
        slots:
          quiz_submission_id: path.quiz_submission_id
          attempt: requestBody.attempt
          validation_token: requestBody.validation_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/quiz_submissions/{quiz_submission_id}/questions/{id}/formatted_answer'].get
  update:
    x-apievangelist-phrasing:
      intent: Format a student's numerical answer
      effect: read
      questions:
      - How will Canvas format a number a student types into a numerical question?
      - Can I preview the formatted value of a numerical answer?
      instructions:
      - text: Format answer {answer} for question {id} in quiz submission {quiz_submission_id}.
        slots:
          answer: query.answer
          id: path.id
          quiz_submission_id: path.quiz_submission_id
      - text: Show how {answer} would display for numerical question {id} in submission {quiz_submission_id}.
        slots:
          answer: query.answer
          id: path.id
          quiz_submission_id: path.quiz_submission_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/quiz_submissions/{quiz_submission_id}/questions/{id}/flag'].put
  update:
    x-apievangelist-phrasing:
      intent: Flag a quiz question to revisit
      effect: write
      questions:
      - How do I flag a quiz question so I can come back to it later?
      - Can a student mark a question for review during a quiz?
      instructions:
      - text: Flag question {id} in quiz submission {quiz_submission_id} for attempt {attempt} with token {validation_token}.
        slots:
          id: path.id
          quiz_submission_id: path.quiz_submission_id
          attempt: requestBody.attempt
          validation_token: requestBody.validation_token
      - text: Mark question {id} for review in quiz submission {quiz_submission_id}, attempt {attempt}, token {validation_token}.
        slots:
          id: path.id
          quiz_submission_id: path.quiz_submission_id
          attempt: requestBody.attempt
          validation_token: requestBody.validation_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/quiz_submissions/{quiz_submission_id}/questions/{id}/unflag'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove the flag from a quiz question
      effect: write
      questions:
      - How do I unflag a quiz question after returning to it?
      - Can I clear a review flag I set on a question?
      instructions:
      - text: Unflag question {id} in quiz submission {quiz_submission_id} for attempt {attempt} with token {validation_token}.
        slots:
          id: path.id
          quiz_submission_id: path.quiz_submission_id
          attempt: requestBody.attempt
          validation_token: requestBody.validation_token
      - text: Clear the review flag on question {id} in submission {quiz_submission_id}, attempt {attempt}, token {validation_token}.
        slots:
          id: path.id
          quiz_submission_id: path.quiz_submission_id
          attempt: requestBody.attempt
          validation_token: requestBody.validation_token
      method: generated
      generated: '2026-10-01'