Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Course Pace API

5 actions 5 updates phrasing extends openapi/canvas-course-pace-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/courses/{course_id}/course_pacing/{id}'].get

$.paths['/v1/courses/{course_id}/course_pacing/{id}'].put

$.paths['/v1/courses/{course_id}/course_pacing/{id}'].delete

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

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 Course Pace API
  version: 1.0.0
extends: openapi/canvas-course-pace-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/courses/{course_id}/course_pacing/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a course pace
      effect: read
      questions:
      - Can I see the pacing schedule set for a Canvas course?
      - Does a course pace skip weekends or have a hard end date?
      instructions:
      - text: Show course pace {id} in course {course_id}.
        slots:
          id: path.id
          course_id: path.course_id
      - text: Get the pacing plan {course_pace_id} for course {course_id} at {id}.
        slots:
          course_pace_id: query.course_pace_id
          course_id: path.course_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/course_pacing/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a course pace
      effect: write
      questions:
      - Can I move the end date of an existing course pace?
      - Is it possible to add skipped days to a course's pacing plan?
      instructions:
      - text: Set course pace {id} in course {course_id} to end on {end_date}.
        slots:
          id: path.id
          course_id: path.course_id
          end_date: requestBody.end_date
      - text: 'Update pace {course_pace_id} ({id}) in {course_id} to exclude weekends: {exclude_weekends}.'
        slots:
          course_pace_id: requestBody.course_pace_id
          id: path.id
          course_id: path.course_id
          exclude_weekends: requestBody.exclude_weekends
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/course_pacing/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a course pace
      effect: destructive
      questions:
      - Can I remove a pacing plan from my course?
      - What happens when a course pace is deleted?
      instructions:
      - text: Delete course pace {id} from course {course_id}.
        slots:
          id: path.id
          course_id: path.course_id
      - text: Remove pacing plan {course_pace_id} at {id} in {course_id}.
        slots:
          course_pace_id: query.course_pace_id
          id: path.id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/course_pacing'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a course pace
      effect: write
      questions:
      - How do I set up a pacing schedule for a self-paced course?
      - Can a new course pace start on a specific date and skip weekends?
      instructions:
      - text: Create a course pace for course {course_id} from {start_date} to {end_date}.
        slots:
          course_id: path.course_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Add a pacing plan in {course_id} that excludes weekends.
        slots:
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'