Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Score API

2 actions 2 updates phrasing extends openapi/canvas-score-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['/lti/courses/{course_id}/line_items/{line_item_id}/scores'].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 Score API
  version: 1.0.0
extends: openapi/canvas-score-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['/lti/courses/{course_id}/line_items/{line_item_id}/scores'].post
  update:
    x-apievangelist-phrasing:
      intent: Post an LTI score for a student
      effect: write
      questions:
      - How does an LTI tool send a student's score back to the Canvas gradebook?
      - Can a tool report grading progress and a comment along with the score?
      instructions:
      - text: Post score {scoreGiven} out of {scoreMaximum} for user {userId} on line item {line_item_id} in course {course_id}.
        slots:
          scoreGiven: requestBody.scoreGiven
          scoreMaximum: requestBody.scoreMaximum
          userId: requestBody.userId
          line_item_id: path.line_item_id
          course_id: path.course_id
      - text: Record {activityProgress} and {gradingProgress} for user {userId} at {timestamp} on line item {line_item_id}, course {course_id}.
        slots:
          activityProgress: requestBody.activityProgress
          gradingProgress: requestBody.gradingProgress
          userId: requestBody.userId
          timestamp: requestBody.timestamp
          line_item_id: path.line_item_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'