Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Quiz Submission User List API

2 actions 2 updates phrasing extends openapi/canvas-quiz-submission-user-list-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['/v1/courses/{course_id}/quizzes/{id}/submission_users/message'].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 Quiz Submission User List API
  version: 1.0.0
extends: openapi/canvas-quiz-submission-user-list-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['/v1/courses/{course_id}/quizzes/{id}/submission_users/message'].post
  update:
    x-apievangelist-phrasing:
      intent: Message students who have or haven't taken a quiz
      effect: write
      questions:
      - Can I remind everyone who hasn't taken a quiz yet with one message?
      - Is messaging only the students who already submitted a quiz possible?
      instructions:
      - text: Message the students who haven't submitted quiz {id} in course {course_id}.
        slots:
          id: path.id
          course_id: path.course_id
      - text: Send {conversations} to quiz {id} takers in course {course_id}.
        slots:
          conversations: requestBody.conversations
          id: path.id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'