# 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 Peer Reviews API version: 1.0.0 extends: openapi/canvas-peer-reviews-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: 9 - target: $.paths['/v1/courses/{course_id}/assignments/{assignment_id}/peer_reviews'].get update: x-apievangelist-phrasing: intent: List peer reviews for a course assignment effect: read questions: - Who is reviewing whom on an assignment in my Canvas course? - Can I include the reviewer's comments when listing an assignment's peer reviews? instructions: - text: List all peer reviews for assignment {assignment_id} in course {course_id}. slots: assignment_id: path.assignment_id course_id: path.course_id - text: Show course {course_id} assignment {assignment_id} peer reviews including {include}. slots: course_id: path.course_id assignment_id: path.assignment_id include: query.include method: generated generated: '2026-10-01' - target: $.paths['/v1/sections/{section_id}/assignments/{assignment_id}/peer_reviews'].get update: x-apievangelist-phrasing: intent: List peer reviews for an assignment in a section effect: read questions: - Can I see peer review pairings for just one section of my class? - Which section students have been assigned to review each other's work? instructions: - text: List peer reviews for assignment {assignment_id} in section {section_id}. slots: assignment_id: path.assignment_id section_id: path.section_id - text: Show the section {section_id} reviewer pairings on assignment {assignment_id}. slots: section_id: path.section_id assignment_id: path.assignment_id method: generated generated: '2026-10-01' - target: $.paths['/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews'].get update: x-apievangelist-phrasing: intent: List peer reviews of one submission in a course effect: read questions: - Who has been assigned to review a particular student's submission? - Can I see the peer reviews attached to one course submission? instructions: - text: List peer reviews of submission {submission_id} for assignment {assignment_id} in course {course_id}. slots: submission_id: path.submission_id assignment_id: path.assignment_id course_id: path.course_id - text: Show reviewers on course {course_id} submission {submission_id} of {assignment_id}. slots: course_id: path.course_id submission_id: path.submission_id assignment_id: path.assignment_id method: generated generated: '2026-10-01' - target: $.paths['/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews'].post update: x-apievangelist-phrasing: intent: Assign a peer reviewer to a course submission effect: write questions: - Can I manually assign a classmate to peer review a specific submission? - What do I need to add a reviewer to a course submission? instructions: - text: Assign user {user_id} to review submission {submission_id} on assignment {assignment_id} in course {course_id}. slots: user_id: requestBody.user_id submission_id: path.submission_id assignment_id: path.assignment_id course_id: path.course_id - text: Add reviewer {user_id} to course {course_id} submission {submission_id} for {assignment_id}. slots: user_id: requestBody.user_id course_id: path.course_id submission_id: path.submission_id assignment_id: path.assignment_id method: generated generated: '2026-10-01' - target: $.paths['/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews'].delete update: x-apievangelist-phrasing: intent: Remove a peer reviewer from a course submission effect: destructive questions: - Can I take a reviewer off a student's submission in my course? - How do I undo a peer review assignment made by mistake? instructions: - text: Remove reviewer {user_id} from submission {submission_id} on assignment {assignment_id} in course {course_id}. slots: user_id: query.user_id submission_id: path.submission_id assignment_id: path.assignment_id course_id: path.course_id - text: Delete the course {course_id} peer review by {user_id} of submission {submission_id} for {assignment_id}. slots: course_id: path.course_id user_id: query.user_id submission_id: path.submission_id assignment_id: path.assignment_id method: generated generated: '2026-10-01' - target: $.paths['/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews'].get update: x-apievangelist-phrasing: intent: List peer reviews of one submission in a section effect: read questions: - Within a section, who is reviewing a given student's submission? - Can I list section-scoped peer reviews for one submission? instructions: - text: List section {section_id} peer reviews of submission {submission_id} on assignment {assignment_id}. slots: section_id: path.section_id submission_id: path.submission_id assignment_id: path.assignment_id - text: Show reviewers for submission {submission_id} of {assignment_id} within section {section_id}. slots: submission_id: path.submission_id assignment_id: path.assignment_id section_id: path.section_id method: generated generated: '2026-10-01' - target: $.paths['/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews'].post update: x-apievangelist-phrasing: intent: Assign a peer reviewer to a submission in a section effect: write questions: - Can I pair reviewers through a section rather than the whole course? - Is adding a peer reviewer by section supported? instructions: - text: In section {section_id}, assign {user_id} to review submission {submission_id} for assignment {assignment_id}. slots: section_id: path.section_id user_id: requestBody.user_id submission_id: path.submission_id assignment_id: path.assignment_id - text: Add section {section_id} reviewer {user_id} on submission {submission_id} of {assignment_id}. slots: section_id: path.section_id user_id: requestBody.user_id submission_id: path.submission_id assignment_id: path.assignment_id method: generated generated: '2026-10-01' - target: $.paths['/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews'].delete update: x-apievangelist-phrasing: intent: Remove a peer reviewer from a submission in a section effect: destructive questions: - Can I unassign a reviewer through the section endpoint? - How is a section peer review deleted? instructions: - text: In section {section_id}, remove {user_id} as reviewer of submission {submission_id} for assignment {assignment_id}. slots: section_id: path.section_id user_id: query.user_id submission_id: path.submission_id assignment_id: path.assignment_id - text: Delete section {section_id} peer review by {user_id} on submission {submission_id} of {assignment_id}. slots: section_id: path.section_id user_id: query.user_id submission_id: path.submission_id assignment_id: path.assignment_id method: generated generated: '2026-10-01' - target: $.paths['/v1/courses/{course_id}/assignments/{assignment_id}/allocate'].post update: x-apievangelist-phrasing: intent: Get a submission allocated to me to peer review effect: write questions: - Can I ask Canvas to give me the next submission to peer review? - As a student, how do I get assigned something to review on an assignment? instructions: - text: Allocate me a submission to review for assignment {assignment_id} in course {course_id}. slots: assignment_id: path.assignment_id course_id: path.course_id - text: Give me my next peer review on course {course_id} assignment {assignment_id}. slots: course_id: path.course_id assignment_id: path.assignment_id method: generated generated: '2026-10-01'