Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Submission Comments API

5 actions 5 updates phrasing extends openapi/canvas-submission-comments-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 5

$.info

$.paths['/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/comments/{id}'].put

$.paths['/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/comments/{id}'].delete

$.paths['/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/comments/files'].post

$.paths['/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/annotation_notification'].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 Submission Comments API
  version: 1.0.0
extends: openapi/canvas-submission-comments-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: 4
- target: $.paths['/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/comments/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a comment on a submission
      effect: write
      questions:
      - Can I fix a typo in feedback I left on a student's submission?
      - How do I change the text of an existing submission comment?
      instructions:
      - text: Change comment {id} on user {user_id}'s submission for assignment {assignment_id} in course {course_id} to {comment}.
        slots:
          id: path.id
          user_id: path.user_id
          assignment_id: path.assignment_id
          course_id: path.course_id
          comment: requestBody.comment
      - text: Edit submission comment {id} for student {user_id}, assignment {assignment_id}, course {course_id}.
        slots:
          id: path.id
          user_id: path.user_id
          assignment_id: path.assignment_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/comments/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a submission
      effect: destructive
      questions:
      - How do I remove a comment I posted on a student's submission?
      - Can a submission comment be deleted after it was posted?
      instructions:
      - text: Delete comment {id} on user {user_id}'s submission for assignment {assignment_id} in course {course_id}.
        slots:
          id: path.id
          user_id: path.user_id
          assignment_id: path.assignment_id
          course_id: path.course_id
      - text: Remove feedback comment {id} from student {user_id}'s work on assignment {assignment_id}, course {course_id}.
        slots:
          id: path.id
          user_id: path.user_id
          assignment_id: path.assignment_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/comments/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file to attach to a submission comment
      effect: write
      questions:
      - How do I attach a marked-up file to my feedback on a submission?
      - What upload workflow do I follow to add a file to a submission comment?
      instructions:
      - text: Start a file upload for a comment on user {user_id}'s submission to assignment {assignment_id} in course {course_id}.
        slots:
          user_id: path.user_id
          assignment_id: path.assignment_id
          course_id: path.course_id
      - text: Upload a feedback attachment for student {user_id}, assignment {assignment_id}, course {course_id}.
        slots:
          user_id: path.user_id
          assignment_id: path.assignment_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/annotation_notification'].post
  update:
    x-apievangelist-phrasing:
      intent: Notify users about a new submission annotation
      effect: write
      questions:
      - How do I notify a student and their observers that someone annotated their submission?
      - What permission is needed to send an annotation notification?
      instructions:
      - text: Send an annotation notification from author {author_id} for user {user_id}'s submission to assignment {assignment_id} in course {course_id}.
        slots:
          author_id: requestBody.author_id
          user_id: path.user_id
          assignment_id: path.assignment_id
          course_id: path.course_id
      - text: Alert everyone on student {user_id}'s assignment {assignment_id} submission in course {course_id} that {author_id} annotated it.
        slots:
          user_id: path.user_id
          assignment_id: path.assignment_id
          course_id: path.course_id
          author_id: requestBody.author_id
      method: generated
      generated: '2026-10-01'