Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Temporary Enrollment Pairings API

6 actions 6 updates phrasing extends openapi/canvas-temporary-enrollment-pairings-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}/temporary_enrollment_pairings'].get

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

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

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

$.paths['/v1/accounts/{account_id}/temporary_enrollment_pairings/new'].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 Temporary Enrollment Pairings API
  version: 1.0.0
extends: openapi/canvas-temporary-enrollment-pairings-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}/temporary_enrollment_pairings'].get
  update:
    x-apievangelist-phrasing:
      intent: List temporary enrollment pairings
      effect: read
      questions:
      - Which temporary enrollment pairings exist in our root account?
      - Can I include pairings that have been deleted?
      instructions:
      - text: List temporary enrollment pairings in account {account_id}.
        slots:
          account_id: path.account_id
      - text: 'Show account {account_id} pairings including deleted ones: {include_deleted}.'
        slots:
          account_id: path.account_id
          include_deleted: query.include_deleted
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/temporary_enrollment_pairings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a temporary enrollment pairing
      effect: write
      questions:
      - How do I set up a temporary enrollment pairing, for example for a substitute teacher?
      - Can I choose what state the enrollments end in when a pairing expires?
      instructions:
      - text: Create a temporary enrollment pairing in account {account_id}.
        slots:
          account_id: path.account_id
      - text: Create a pairing in account {account_id} whose enrollments end as {ending_enrollment_state}.
        slots:
          account_id: path.account_id
          ending_enrollment_state: requestBody.ending_enrollment_state
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/temporary_enrollment_pairings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one temporary enrollment pairing
      effect: read
      questions:
      - How do I look up a specific temporary enrollment pairing?
      - What state is a given temporary pairing in?
      instructions:
      - text: Show temporary enrollment pairing {id} in account {account_id}.
        slots:
          id: path.id
          account_id: path.account_id
      - text: Get the details of pairing {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}/temporary_enrollment_pairings/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a temporary enrollment pairing
      effect: destructive
      questions:
      - Can I remove a temporary enrollment pairing once it's no longer needed?
      - Will a deleted pairing still show up if I ask for deleted ones?
      instructions:
      - text: Delete temporary enrollment pairing {id} in account {account_id}.
        slots:
          id: path.id
          account_id: path.account_id
      - text: Remove pairing {id} from account {account_id}.
        slots:
          id: path.id
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/temporary_enrollment_pairings/new'].get
  update:
    x-apievangelist-phrasing:
      intent: Start a blank temporary enrollment pairing
      effect: read
      questions:
      - Can I get an unsaved template of a temporary enrollment pairing before creating one?
      - What defaults does a new temporary pairing start with?
      instructions:
      - text: Initialize an unsaved temporary enrollment pairing for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Give me a blank pairing template for account {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'