Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Plagiarism Detection Platform Assignments…

2 actions 2 updates phrasing extends openapi/canvas-plagiarism-detection-platform-assignments-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/assignments/{assignment_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 Plagiarism Detection Platform Assignments…
  version: 1.0.0
extends: openapi/canvas-plagiarism-detection-platform-assignments-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/assignments/{assignment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an assignment as a plagiarism tool
      effect: read
      questions:
      - How does a plagiarism detection tool fetch an assignment it's attached to?
      - Can I look up an assignment by its LTI ID instead of its Canvas ID?
      instructions:
      - text: Get assignment {assignment_id} for my LTI tool.
        slots:
          assignment_id: path.assignment_id
      - text: Get assignment {assignment_id} as seen by user {user_id}.
        slots:
          assignment_id: path.assignment_id
          user_id: query.user_id
      method: generated
      generated: '2026-10-01'