Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Plagiarism Detection Submissions API

3 actions 3 updates phrasing extends openapi/canvas-plagiarism-detection-submissions-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/assignments/{assignment_id}/submissions/{submission_id}'].get

$.paths['/lti/assignments/{assignment_id}/submissions/{submission_id}/history'].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 Plagiarism Detection Submissions API
  version: 1.0.0
extends: openapi/canvas-plagiarism-detection-submissions-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/assignments/{assignment_id}/submissions/{submission_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a submission for plagiarism review
      effect: read
      questions:
      - How does a plagiarism tool fetch a student's submission for checking?
      - Can an LTI tool read one submission by its ID?
      instructions:
      - text: Get submission {submission_id} on assignment {assignment_id}.
        slots:
          submission_id: path.submission_id
          assignment_id: path.assignment_id
      - text: Fetch the latest version of submission {submission_id} for assignment {assignment_id} to check for originality.
        slots:
          submission_id: path.submission_id
          assignment_id: path.assignment_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lti/assignments/{assignment_id}/submissions/{submission_id}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get every attempt of a submission
      effect: read
      questions:
      - Can a plagiarism tool see every attempt a student made on a submission?
      - What earlier versions of a submission are available to review?
      instructions:
      - text: Get the attempt history of submission {submission_id} on assignment {assignment_id}.
        slots:
          submission_id: path.submission_id
          assignment_id: path.assignment_id
      - text: List all attempts for submission {submission_id} in assignment {assignment_id}.
        slots:
          submission_id: path.submission_id
          assignment_id: path.assignment_id
      method: generated
      generated: '2026-10-01'