Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Grading Period Sets API

5 actions 5 updates phrasing extends openapi/canvas-grading-period-sets-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/accounts/{account_id}/grading_period_sets'].get

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

$.paths['/v1/accounts/{account_id}/grading_period_sets/{id}'].delete

$.paths['/v1/accounts/{account_id}/grading_period_sets/{id}'].patch

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 Period Sets API
  version: 1.0.0
extends: openapi/canvas-grading-period-sets-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/accounts/{account_id}/grading_period_sets'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's grading period sets
      effect: read
      questions:
      - What grading period sets are defined for my account?
      - Which term-based grading schemes does an account have?
      instructions:
      - text: List grading period sets in account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show all grading period sets configured for account {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/grading_period_sets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a grading period set
      effect: write
      questions:
      - How do I set up a new grading period set for some enrollment terms?
      - Can a grading period set be weighted?
      instructions:
      - text: Create a grading period set titled {title} in account {account_id}.
        slots:
          title: requestBody.grading_period_set[title]
          account_id: path.account_id
      - text: Create grading period set {title} in account {account_id} for terms {enrollment_term_ids}.
        slots:
          title: requestBody.grading_period_set[title]
          account_id: path.account_id
          enrollment_term_ids: requestBody.enrollment_term_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/grading_period_sets/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a grading period set
      effect: destructive
      questions:
      - How do I remove a grading period set from an account?
      - Can I delete a grading period set I no longer use?
      instructions:
      - text: Delete grading period set {id} from account {account_id}.
        slots:
          id: path.id
          account_id: path.account_id
      - text: Remove account {account_id}'s grading period set {id}.
        slots:
          account_id: path.account_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/grading_period_sets/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a grading period set
      effect: write
      questions:
      - Can I change which enrollment terms an existing grading period set applies to?
      - How do I show totals for all grading periods on an existing set?
      instructions:
      - text: Rename grading period set {id} in account {account_id} to {title}.
        slots:
          id: path.id
          account_id: path.account_id
          title: requestBody.grading_period_set[title]
      - text: Set weighted to {weighted} on grading period set {id} in account {account_id}, titled {title}.
        slots:
          weighted: requestBody.grading_period_set[weighted]
          id: path.id
          account_id: path.account_id
          title: requestBody.grading_period_set[title]
      method: generated
      generated: '2026-10-01'