Canvas · OpenAPI Overlay 1.0.0

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

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

$.info

$.paths['/quiz/v1/courses/{course_id}/quizzes/{assignment_id}/reports'].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 Reports API
  version: 1.0.0
extends: openapi/canvas-new-quizzes-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: 1
- target: $.paths['/quiz/v1/courses/{course_id}/quizzes/{assignment_id}/reports'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a New Quiz report
      effect: write
      questions:
      - Can I export student analysis or item analysis for a New Quiz?
      - What happens if a report of the same type is already being generated?
      instructions:
      - text: Generate a {report_type} report as {format} for new quiz {assignment_id} in course {course_id}.
        slots:
          report_type: requestBody.quiz_report[report_type]
          format: requestBody.quiz_report[format]
          assignment_id: path.assignment_id
          course_id: path.course_id
      - text: Start a CSV {report_type} export for quiz {assignment_id} of {course_id}.
        slots:
          report_type: requestBody.quiz_report[report_type]
          assignment_id: path.assignment_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'