Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Grade Change Log API

6 actions 6 updates phrasing extends openapi/canvas-grade-change-log-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['/v1/audit/grade_change/assignments/{assignment_id}'].get

$.paths['/v1/audit/grade_change/courses/{course_id}'].get

$.paths['/v1/audit/grade_change/students/{student_id}'].get

$.paths['/v1/audit/grade_change/graders/{grader_id}'].get

$.paths['/v1/audit/grade_change'].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 Grade Change Log API
  version: 1.0.0
extends: openapi/canvas-grade-change-log-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['/v1/audit/grade_change/assignments/{assignment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List grade changes on an assignment
      effect: read
      questions:
      - Who changed grades on this assignment, and when?
      - Can I audit grade changes for one assignment over a date range?
      instructions:
      - text: List grade change events for assignment {assignment_id}.
        slots:
          assignment_id: path.assignment_id
      - text: Show grade changes on assignment {assignment_id} between {start_time} and {end_time}.
        slots:
          assignment_id: path.assignment_id
          start_time: query.start_time
          end_time: query.end_time
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/audit/grade_change/courses/{course_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List grade changes in a course
      effect: read
      questions:
      - What grade changes were made across my whole course?
      - Can I see the course grade audit log for last week only?
      instructions:
      - text: List grade change events for course {course_id}.
        slots:
          course_id: path.course_id
      - text: Show grade changes in course {course_id} since {start_time}.
        slots:
          course_id: path.course_id
          start_time: query.start_time
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/audit/grade_change/students/{student_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List grade changes for a student
      effect: read
      questions:
      - Have any of this student's grades been changed?
      - Can I see a student's grade change history across courses?
      instructions:
      - text: List grade change events for student {student_id}.
        slots:
          student_id: path.student_id
      - text: Show grade changes for student {student_id} up to {end_time}.
        slots:
          student_id: path.student_id
          end_time: query.end_time
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/audit/grade_change/graders/{grader_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List grade changes made by a grader
      effect: read
      questions:
      - Which grades has a particular teacher or TA changed?
      - Can I audit everything one grader modified this term?
      instructions:
      - text: List grade change events made by grader {grader_id}.
        slots:
          grader_id: path.grader_id
      - text: Show grades changed by grader {grader_id} from {start_time} to {end_time}.
        slots:
          grader_id: path.grader_id
          start_time: query.start_time
          end_time: query.end_time
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/audit/grade_change'].get
  update:
    x-apievangelist-phrasing:
      intent: Search grade changes by combined filters
      effect: read
      questions:
      - Can I find grade changes one grader made for one student in a specific course?
      - Why does a grade change search without a course or assignment need admin rights?
      instructions:
      - text: Find grade changes in course {course_id} for student {student_id} by grader {grader_id}.
        slots:
          course_id: query.course_id
          student_id: query.student_id
          grader_id: query.grader_id
      - text: Search grade changes on assignment {assignment_id} for student {student_id}.
        slots:
          assignment_id: query.assignment_id
          student_id: query.student_id
      method: generated
      generated: '2026-10-01'