Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Live Assessments API

5 actions 5 updates phrasing extends openapi/canvas-live-assessments-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}/live_assessments/{assessment_id}/results'].get
$.paths['/v1/courses/{course_id}/live_assessments/{assessment_id}/results'].post
$.paths['/v1/courses/{course_id}/live_assessments'].get
$.paths['/v1/courses/{course_id}/live_assessments'].post

OpenAPI Overlay

Raw ↑ 
# 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 Live Assessments API
  version: 1.0.0
extends: openapi/canvas-live-assessments-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}/live_assessments/{assessment_id}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: List results recorded for a live assessment
      effect: read
      questions:
      - What results have been recorded for an in-class live assessment?
      - Can I see one student's live assessment results?
      instructions:
      - text: List the results for live assessment {assessment_id} in course {course_id}.
        slots:
          assessment_id: path.assessment_id
          course_id: path.course_id
      - text: Show user {user_id}'s results on live assessment {assessment_id} in course {course_id}.
        slots:
          user_id: query.user_id
          assessment_id: path.assessment_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/live_assessments/{assessment_id}/results'].post
  update:
    x-apievangelist-phrasing:
      intent: Record results for a live assessment
      effect: write
      questions:
      - How do I record students' scores from a live, in-class assessment?
      - Can I add a batch of results to an existing live assessment?
      instructions:
      - text: Add results to live assessment {assessment_id} in course {course_id}.
        slots:
          assessment_id: path.assessment_id
          course_id: path.course_id
      - text: Record these student scores on live assessment {assessment_id} for course {course_id}.
        slots:
          assessment_id: path.assessment_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/live_assessments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a course's live assessments
      effect: read
      questions:
      - Which live assessments exist in my course?
      - What in-class assessments have been set up for this course?
      instructions:
      - text: List the live assessments in course {course_id}.
        slots:
          course_id: path.course_id
      - text: Show every in-class assessment set up in course {course_id}.
        slots:
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/live_assessments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or find a live assessment by key
      effect: write
      questions:
      - How do I set up a live assessment aligned to a learning outcome?
      - Will creating a live assessment with an existing key return the one I already have?
      instructions:
      - text: Create or find a live assessment in course {course_id}.
        slots:
          course_id: path.course_id
      - text: Set up an outcome-aligned live assessment in course {course_id}.
        slots:
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'