Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Originality Reports API

6 actions 6 updates phrasing extends openapi/canvas-originality-reports-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 6

$.info
$.paths['/lti/assignments/{assignment_id}/submissions/{submission_id}/originality_report'].post
$.paths['/lti/assignments/{assignment_id}/submissions/{submission_id}/originality_report/{id}'].get
$.paths['/lti/assignments/{assignment_id}/submissions/{submission_id}/originality_report/{id}'].put
$.paths['/lti/assignments/{assignment_id}/files/{file_id}/originality_report'].get
$.paths['/lti/assignments/{assignment_id}/files/{file_id}/originality_report'].put

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 Originality Reports API
  version: 1.0.0
extends: openapi/canvas-originality-reports-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: 5
- target: $.paths['/lti/assignments/{assignment_id}/submissions/{submission_id}/originality_report'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an originality report for a submission
      effect: write
      questions:
      - How does a plagiarism tool post an originality score back on a student's submission?
      - Can an originality report link out to the full report on the tool's site?
      - Can I record an error state on an originality report when scanning fails?
      instructions:
      - text: Create an originality report with score {originality_score} for submission {submission_id} on assignment {assignment_id}.
        slots:
          originality_score: requestBody.originality_report[originality_score]
          submission_id: path.submission_id
          assignment_id: path.assignment_id
      - text: Post a {originality_score} originality score for file {file_id} in submission {submission_id} of assignment {assignment_id}, linking {originality_report_url}.
        slots:
          originality_score: requestBody.originality_report[originality_score]
          file_id: requestBody.originality_report[file_id]
          submission_id: path.submission_id
          assignment_id: path.assignment_id
          originality_report_url: requestBody.originality_report[originality_report_url]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lti/assignments/{assignment_id}/submissions/{submission_id}/originality_report/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an originality report for a submission
      effect: read
      questions:
      - What originality score did a submission get?
      - Can I fetch an originality report by its id under a submission?
      instructions:
      - text: Show originality report {id} for submission {submission_id} on assignment {assignment_id}.
        slots:
          id: path.id
          submission_id: path.submission_id
          assignment_id: path.assignment_id
      - text: Get the similarity score in report {id} attached to assignment {assignment_id} submission {submission_id}.
        slots:
          id: path.id
          assignment_id: path.assignment_id
          submission_id: path.submission_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lti/assignments/{assignment_id}/submissions/{submission_id}/originality_report/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a submission's originality report
      effect: write
      questions:
      - How do I change the score on an originality report once scanning finishes?
      - Can I move an originality report from pending to scored on a submission?
      instructions:
      - text: Update originality report {id} on submission {submission_id} of assignment {assignment_id} to score {originality_score}.
        slots:
          id: path.id
          submission_id: path.submission_id
          assignment_id: path.assignment_id
          originality_score: requestBody.originality_report[originality_score]
      - text: Set the state of report {id} for assignment {assignment_id} submission {submission_id} to {workflow_state}.
        slots:
          id: path.id
          assignment_id: path.assignment_id
          submission_id: path.submission_id
          workflow_state: requestBody.originality_report[workflow_state]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lti/assignments/{assignment_id}/files/{file_id}/originality_report'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the originality report for an attached file
      effect: read
      questions:
      - What's the originality report for one specific uploaded file?
      - Can I look up an originality report by file instead of by submission?
      instructions:
      - text: Show the originality report for file {file_id} on assignment {assignment_id}.
        slots:
          file_id: path.file_id
          assignment_id: path.assignment_id
      - text: Get the similarity result attached to file {file_id} for assignment {assignment_id}.
        slots:
          file_id: path.file_id
          assignment_id: path.assignment_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lti/assignments/{assignment_id}/files/{file_id}/originality_report'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the originality report for a file
      effect: write
      questions:
      - Can I update an originality report addressed by its file id?
      - How do I attach an error message to a file's originality report?
      instructions:
      - text: Update the originality report for file {file_id} on assignment {assignment_id} to score {originality_score}.
        slots:
          file_id: path.file_id
          assignment_id: path.assignment_id
          originality_score: requestBody.originality_report[originality_score]
      - text: Record error {error_message} on file {file_id}'s report for assignment {assignment_id}.
        slots:
          error_message: requestBody.originality_report[error_message]
          file_id: path.file_id
          assignment_id: path.assignment_id
      method: generated
      generated: '2026-10-01'