Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Outcomes API

4 actions 4 updates phrasing extends openapi/canvas-outcomes-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 4

$.info

$.paths['/v1/outcomes/{id}'].get

$.paths['/v1/outcomes/{id}'].put

$.paths['/v1/courses/{course_id}/outcome_alignments'].get

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 Outcomes API
  version: 1.0.0
extends: openapi/canvas-outcomes-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: 3
- target: $.paths['/v1/outcomes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a learning outcome
      effect: read
      questions:
      - What are the mastery points and rating scale for a Canvas learning outcome?
      - Can I see an outcome with the account's default ratings filled in?
      instructions:
      - text: Show learning outcome {id}.
        slots:
          id: path.id
      - text: Get outcome {id} with default ratings set to {add_defaults}.
        slots:
          id: path.id
          add_defaults: query.add_defaults
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/outcomes/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a learning outcome
      effect: write
      questions:
      - Can I change the mastery threshold or calculation method of an outcome?
      - Do new ratings replace the existing rubric criterion on an outcome?
      instructions:
      - text: Rename outcome {id} to {title}.
        slots:
          id: path.id
          title: requestBody.title
      - text: Set mastery points on outcome {id} to {mastery_points} using {calculation_method}.
        slots:
          id: path.id
          mastery_points: requestBody.mastery_points
          calculation_method: requestBody.calculation_method
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/outcome_alignments'].get
  update:
    x-apievangelist-phrasing:
      intent: Get outcome alignments for a student or assignment
      effect: read
      questions:
      - Which outcomes is a given assignment aligned to in my course?
      - Can I see the outcome alignments for one student?
      instructions:
      - text: Get outcome alignments for assignment {assignment_id} in course {course_id}.
        slots:
          assignment_id: query.assignment_id
          course_id: path.course_id
      - text: Show outcome alignments for student {student_id} in {course_id}.
        slots:
          student_id: query.student_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'