Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Quiz Reports API

5 actions 5 updates phrasing extends openapi/canvas-quiz-reports-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 5

$.info

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

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

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

$.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/reports/{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 Reports API
  version: 1.0.0
extends: openapi/canvas-quiz-reports-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: 4
- target: $.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List a quiz's reports
      effect: read
      questions:
      - What reports are available for a classic quiz?
      - Can I list quiz reports that cover all submission versions?
      instructions:
      - text: List the reports for quiz {quiz_id} in course {course_id}.
        slots:
          quiz_id: path.quiz_id
          course_id: path.course_id
      - text: 'Show quiz {quiz_id} reports in course {course_id}, all versions: {includes_all_versions}.'
        slots:
          quiz_id: path.quiz_id
          course_id: path.course_id
          includes_all_versions: query.includes_all_versions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/reports'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a quiz report
      effect: write
      questions:
      - How do I generate a new statistics report for a classic quiz?
      - Will requesting a quiz report again reuse one that's still current?
      instructions:
      - text: Generate a {report_type} report for quiz {quiz_id} in course {course_id}.
        slots:
          report_type: requestBody.quiz_report[report_type]
          quiz_id: path.quiz_id
          course_id: path.course_id
      - text: 'Create a {report_type} report on quiz {quiz_id} of course {course_id} including all versions: {includes_all_versions}.'
        slots:
          report_type: requestBody.quiz_report[report_type]
          quiz_id: path.quiz_id
          course_id: path.course_id
          includes_all_versions: requestBody.quiz_report[includes_all_versions]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/reports/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one quiz report
      effect: read
      questions:
      - How do I fetch the data of a quiz report I already generated?
      - Can I check a single quiz report's progress and file?
      instructions:
      - text: Get report {id} for quiz {quiz_id} in course {course_id}.
        slots:
          id: path.id
          quiz_id: path.quiz_id
          course_id: path.course_id
      - text: Show quiz report {id} of quiz {quiz_id}, course {course_id}, including {include}.
        slots:
          id: path.id
          quiz_id: path.quiz_id
          course_id: path.course_id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/reports/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel or remove a quiz report
      effect: destructive
      questions:
      - Can I stop a quiz report that's still generating?
      - How do I delete an old quiz report so I can regenerate it?
      instructions:
      - text: Abort or remove report {id} for quiz {quiz_id} in course {course_id}.
        slots:
          id: path.id
          quiz_id: path.quiz_id
          course_id: path.course_id
      - text: Cancel generation of quiz report {id} (quiz {quiz_id}, course {course_id}).
        slots:
          id: path.id
          quiz_id: path.quiz_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'