Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST What If Grades API

3 actions 3 updates phrasing extends openapi/canvas-what-if-grades-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 3

$.info
$.paths['/v1/submissions/{id}/what_if_grades'].put
$.paths['/v1/courses/{course_id}/what_if_grades/reset'].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 What If Grades API
  version: 1.0.0
extends: openapi/canvas-what-if-grades-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: 2
- target: $.paths['/v1/submissions/{id}/what_if_grades'].put
  update:
    x-apievangelist-phrasing:
      intent: Try a what-if score on a submission
      effect: write
      questions:
      - What would my course grade be if I scored a certain number on this assignment?
      - Can a student enter a hypothetical score and see recalculated grades?
      instructions:
      - text: Set a what-if score of {student_entered_score} on submission {id} and recalculate my grades.
        slots:
          student_entered_score: requestBody.student_entered_score
          id: path.id
      - text: Show my grades if submission {id} scored {student_entered_score}.
        slots:
          id: path.id
          student_entered_score: requestBody.student_entered_score
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/what_if_grades/reset'].put
  update:
    x-apievangelist-phrasing:
      intent: Clear all my what-if scores in a course
      effect: destructive
      questions:
      - How do I clear every hypothetical score I entered in a course?
      - Can I reset my what-if grades back to actual grades?
      instructions:
      - text: Reset all my what-if scores in course {course_id}.
        slots:
          course_id: path.course_id
      - text: Clear my hypothetical scores for course {course_id} and recalculate my real grades.
        slots:
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'