Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Grading Standards API

11 actions 11 updates phrasing extends openapi/canvas-grading-standards-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 11

$.info

$.paths['/v1/accounts/{account_id}/grading_standards'].get

$.paths['/v1/accounts/{account_id}/grading_standards'].post

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

$.paths['/v1/courses/{course_id}/grading_standards'].post

$.paths['/v1/courses/{course_id}/grading_standards/{grading_standard_id}'].get

$.paths['/v1/courses/{course_id}/grading_standards/{grading_standard_id}'].put

$.paths['/v1/courses/{course_id}/grading_standards/{grading_standard_id}'].delete

$.paths['/v1/accounts/{account_id}/grading_standards/{grading_standard_id}'].get

$.paths['/v1/accounts/{account_id}/grading_standards/{grading_standard_id}'].put

$.paths['/v1/accounts/{account_id}/grading_standards/{grading_standard_id}'].delete

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 Grading Standards API
  version: 1.0.0
extends: openapi/canvas-grading-standards-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: 10
- target: $.paths['/v1/accounts/{account_id}/grading_standards'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's grading standards
      effect: read
      questions:
      - Which grading schemes are available across an account?
      - Can admins see every grading standard defined at the account level?
      instructions:
      - text: List grading standards in account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show the account-level grading schemes for account {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/grading_standards'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account-wide grading standard
      effect: write
      questions:
      - How do I create a letter-grade scheme every course in an account can use?
      - Can an account grading standard be points-based instead of percentage-based?
      instructions:
      - text: Create account grading standard {title} in account {account_id} with grades {name} at values {value}.
        slots:
          title: requestBody.title
          account_id: path.account_id
          name: requestBody.grading_scheme_entry[name]
          value: requestBody.grading_scheme_entry[value]
      - text: Add a points-based scheme {title} to account {account_id} scaled by {scaling_factor}, grades {name} at {value}.
        slots:
          title: requestBody.title
          account_id: path.account_id
          scaling_factor: requestBody.scaling_factor
          name: requestBody.grading_scheme_entry[name]
          value: requestBody.grading_scheme_entry[value]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/grading_standards'].get
  update:
    x-apievangelist-phrasing:
      intent: List a course's grading standards
      effect: read
      questions:
      - What grading schemes can I pick from in my course?
      - Does my course see grading standards inherited from its account?
      instructions:
      - text: List grading standards available in course {course_id}.
        slots:
          course_id: path.course_id
      - text: Show the grading schemes I can use in course {course_id}.
        slots:
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/grading_standards'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a course grading standard
      effect: write
      questions:
      - How do I make a custom grading scheme just for my course?
      - What do I need to supply to define grade cutoffs in a course?
      instructions:
      - text: Create course grading standard {title} in course {course_id} with grades {name} at values {value}.
        slots:
          title: requestBody.title
          course_id: path.course_id
          name: requestBody.grading_scheme_entry[name]
          value: requestBody.grading_scheme_entry[value]
      - text: Add scheme {title} to course {course_id} with points based {points_based}, grades {name} at {value}.
        slots:
          title: requestBody.title
          course_id: path.course_id
          points_based: requestBody.points_based
          name: requestBody.grading_scheme_entry[name]
          value: requestBody.grading_scheme_entry[value]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/grading_standards/{grading_standard_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a grading standard in a course
      effect: read
      questions:
      - What are the grade cutoffs in one of my course's grading schemes?
      - Can I view a single course grading standard by its ID?
      instructions:
      - text: Get grading standard {grading_standard_id} in course {course_id}.
        slots:
          grading_standard_id: path.grading_standard_id
          course_id: path.course_id
      - text: Show the cutoffs of course {course_id}'s scheme {grading_standard_id}.
        slots:
          course_id: path.course_id
          grading_standard_id: path.grading_standard_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/grading_standards/{grading_standard_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a course grading standard
      effect: write
      questions:
      - Can I change the cutoffs of a course grading scheme after it's been used?
      - Why can I only edit the title of a course scheme that's already graded work?
      instructions:
      - text: Rename course {course_id}'s grading standard {grading_standard_id} to {title}.
        slots:
          course_id: path.course_id
          grading_standard_id: path.grading_standard_id
          title: requestBody.title
      - text: Set the grade values of scheme {grading_standard_id} in course {course_id} to {value}.
        slots:
          grading_standard_id: path.grading_standard_id
          course_id: path.course_id
          value: requestBody.grading_scheme_entry[value]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/grading_standards/{grading_standard_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a course grading standard
      effect: destructive
      questions:
      - How do I remove a grading scheme I created in my course?
      - Can a course-level grading standard be deleted?
      instructions:
      - text: Delete grading standard {grading_standard_id} from course {course_id}.
        slots:
          grading_standard_id: path.grading_standard_id
          course_id: path.course_id
      - text: Remove course {course_id}'s grading scheme {grading_standard_id}.
        slots:
          course_id: path.course_id
          grading_standard_id: path.grading_standard_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/grading_standards/{grading_standard_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a grading standard in an account
      effect: read
      questions:
      - What does an account-level grading scheme look like?
      - Can I fetch one account grading standard by ID?
      instructions:
      - text: Get grading standard {grading_standard_id} in account {account_id}.
        slots:
          grading_standard_id: path.grading_standard_id
          account_id: path.account_id
      - text: Show the cutoffs of account {account_id}'s scheme {grading_standard_id}.
        slots:
          account_id: path.account_id
          grading_standard_id: path.grading_standard_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/grading_standards/{grading_standard_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account grading standard
      effect: write
      questions:
      - Can an admin edit an account-wide grading scheme?
      - Which fields of an account grading standard lock once it's been used for grading?
      instructions:
      - text: Rename account {account_id}'s grading standard {grading_standard_id} to {title}.
        slots:
          account_id: path.account_id
          grading_standard_id: path.grading_standard_id
          title: requestBody.title
      - text: Set the grade values of account scheme {grading_standard_id} in account {account_id} to {value}.
        slots:
          grading_standard_id: path.grading_standard_id
          account_id: path.account_id
          value: requestBody.grading_scheme_entry[value]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/grading_standards/{grading_standard_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account grading standard
      effect: destructive
      questions:
      - How do I retire an account-level grading scheme?
      - Can an admin delete a grading standard from the account?
      instructions:
      - text: Delete grading standard {grading_standard_id} from account {account_id}.
        slots:
          grading_standard_id: path.grading_standard_id
          account_id: path.account_id
      - text: Remove account {account_id}'s grading scheme {grading_standard_id}.
        slots:
          account_id: path.account_id
          grading_standard_id: path.grading_standard_id
      method: generated
      generated: '2026-10-01'