Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Gradebook History API

5 actions 5 updates phrasing extends openapi/canvas-gradebook-history-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}/gradebook_history/days'].get

$.paths['/v1/courses/{course_id}/gradebook_history/{date}'].get

$.paths['/v1/courses/{course_id}/gradebook_history/{date}/graders/{grader_id}/assignments/{assignment_id}/submissions'].get

$.paths['/v1/courses/{course_id}/gradebook_history/feed'].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 Gradebook History API
  version: 1.0.0
extends: openapi/canvas-gradebook-history-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}/gradebook_history/days'].get
  update:
    x-apievangelist-phrasing:
      intent: List the days grading happened in a course
      effect: read
      questions:
      - On which days did anyone change grades in a course?
      - Which graders and assignments were active on each grading day?
      instructions:
      - text: List the gradebook history days for course {course_id}.
        slots:
          course_id: path.course_id
      - text: Show which days grades were changed in course {course_id}.
        slots:
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/gradebook_history/{date}'].get
  update:
    x-apievangelist-phrasing:
      intent: See who graded what on a given date
      effect: read
      questions:
      - Who graded which assignments on a particular day?
      - Can I see the grading activity in a course for one date?
      instructions:
      - text: Show gradebook history for course {course_id} on {date}.
        slots:
          course_id: path.course_id
          date: path.date
      - text: List the graders and assignments worked on in course {course_id} on {date}.
        slots:
          course_id: path.course_id
          date: path.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/gradebook_history/{date}/graders/{grader_id}/assignments/{assignment_id}/submissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List grade changes by a grader on an assignment
      effect: read
      questions:
      - What submission versions did one grader change for an assignment on a specific day?
      - How do I drill into one grader's grading of one assignment on a date?
      instructions:
      - text: List submission versions graded by {grader_id} for assignment {assignment_id} in course {course_id} on {date}.
        slots:
          grader_id: path.grader_id
          assignment_id: path.assignment_id
          course_id: path.course_id
          date: path.date
      - text: Show grader {grader_id}'s changes to assignment {assignment_id} on {date} in course {course_id}.
        slots:
          grader_id: path.grader_id
          assignment_id: path.assignment_id
          date: path.date
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/gradebook_history/feed'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a feed of all submission grade versions
      effect: read
      questions:
      - How do I get a flat feed of every graded submission version in a course?
      - Can I filter the grade history feed to one student or one assignment?
      instructions:
      - text: Get the gradebook history feed for course {course_id}.
        slots:
          course_id: path.course_id
      - text: Show the grade history feed for student {user_id} in course {course_id}.
        slots:
          user_id: query.user_id
          course_id: path.course_id
      - text: Show grade history for assignment {assignment_id} in course {course_id}, oldest first.
        slots:
          assignment_id: query.assignment_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'