Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Enrollment Terms API

6 actions 6 updates phrasing extends openapi/canvas-enrollment-terms-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/accounts/{account_id}/terms'].get

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

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

$.paths['/v1/accounts/{account_id}/terms/{id}'].put

$.paths['/v1/accounts/{account_id}/terms/{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 Enrollment Terms API
  version: 1.0.0
extends: openapi/canvas-enrollment-terms-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/accounts/{account_id}/terms'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's enrollment terms
      effect: read
      questions:
      - What terms are set up for my institution in Canvas?
      - Can I find a term by name or show only deleted terms?
      instructions:
      - text: List the enrollment terms in account {account_id}.
        slots:
          account_id: path.account_id
      - text: Find terms named {term_name} in account {account_id}.
        slots:
          term_name: query.term_name
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/terms'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an enrollment term
      effect: write
      questions:
      - How do I add a new semester as an enrollment term?
      - Can I set separate start and end dates per enrollment type for a term?
      instructions:
      - text: Create term {name} in account {account_id} from {start_at} to {end_at}.
        slots:
          name: requestBody.enrollment_term[name]
          account_id: path.account_id
          start_at: requestBody.enrollment_term[start_at]
          end_at: requestBody.enrollment_term[end_at]
      - text: Add term {name} with SIS ID {sis_term_id} to account {account_id}.
        slots:
          name: requestBody.enrollment_term[name]
          sis_term_id: requestBody.enrollment_term[sis_term_id]
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/terms/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one enrollment term
      effect: read
      questions:
      - How do I see the dates and overrides for one term?
      - What details come back for a single enrollment term?
      instructions:
      - text: Get enrollment term {id} in account {account_id}.
        slots:
          id: path.id
          account_id: path.account_id
      - text: Show the dates and overrides of term {id} in account {account_id}.
        slots:
          id: path.id
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/terms/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an enrollment term
      effect: write
      questions:
      - How do I change the end date of an existing term?
      - Can I edit a term's dates without SIS imports overwriting them later?
      instructions:
      - text: Change term {id} in account {account_id} to end on {end_at}.
        slots:
          id: path.id
          account_id: path.account_id
          end_at: requestBody.enrollment_term[end_at]
      - text: Rename term {id} in account {account_id} to {name}.
        slots:
          id: path.id
          account_id: path.account_id
          name: requestBody.enrollment_term[name]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/terms/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an enrollment term
      effect: destructive
      questions:
      - How do I delete a term I no longer need?
      - Can I remove an enrollment term from an account?
      instructions:
      - text: Delete enrollment term {id} from account {account_id}.
        slots:
          id: path.id
          account_id: path.account_id
      - text: Remove term {id} in account {account_id}.
        slots:
          id: path.id
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'