Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Result API

3 actions 3 updates phrasing extends openapi/canvas-result-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 3

$.info
$.paths['/lti/courses/{course_id}/line_items/{line_item_id}/results'].get
$.paths['/lti/courses/{course_id}/line_items/{line_item_id}/results/{id}'].get

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 Result API
  version: 1.0.0
extends: openapi/canvas-result-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: 2
- target: $.paths['/lti/courses/{course_id}/line_items/{line_item_id}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: List scores recorded for an LTI line item
      effect: read
      questions:
      - How can an LTI tool read back all the scores recorded on a gradebook line item?
      - Can I page through every student's result for one line item?
      instructions:
      - text: List the results for line item {line_item_id} in course {course_id}.
        slots:
          line_item_id: path.line_item_id
          course_id: path.course_id
      - text: Show every student score on course {course_id} line item {line_item_id}.
        slots:
          course_id: path.course_id
          line_item_id: path.line_item_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lti/courses/{course_id}/line_items/{line_item_id}/results/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one result on an LTI line item
      effect: read
      questions:
      - Can I fetch a single result record by its id from a line item?
      - What does one LTI result entry contain?
      instructions:
      - text: Get result {id} on line item {line_item_id} in course {course_id}.
        slots:
          id: path.id
          line_item_id: path.line_item_id
          course_id: path.course_id
      - text: Show course {course_id} line item {line_item_id} result {id}.
        slots:
          course_id: path.course_id
          line_item_id: path.line_item_id
          id: path.id
      method: generated
      generated: '2026-10-01'