Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST E Pub Exports API

4 actions 4 updates phrasing extends openapi/canvas-e-pub-exports-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 4

$.info

$.paths['/v1/epub_exports'].get

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

$.paths['/v1/courses/{course_id}/epub_exports/{id}'].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 E Pub Exports API
  version: 1.0.0
extends: openapi/canvas-e-pub-exports-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: 3
- target: $.paths['/v1/epub_exports'].get
  update:
    x-apievangelist-phrasing:
      intent: List my courses with their latest ePub export
      effect: read
      questions:
      - Which of my courses already have an ePub export?
      - Can I see the most recent ePub export for each course I'm in?
      instructions:
      - text: List my courses with their latest ePub export.
      - text: Show the newest ePub export for each of my active courses.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/epub_exports'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a course as an ePub
      effect: write
      questions:
      - How do I turn a course into an ePub book for offline reading?
      - Can I track the progress of an ePub export after I start it?
      instructions:
      - text: Start an ePub export of course {course_id}.
        slots:
          course_id: path.course_id
      - text: Export course {course_id} to ePub.
        slots:
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/epub_exports/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an ePub export
      effect: read
      questions:
      - Is my course's ePub export finished and ready to download?
      - How do I check one ePub export's status?
      instructions:
      - text: Show ePub export {id} for course {course_id}.
        slots:
          id: path.id
          course_id: path.course_id
      - text: Check the status of ePub export {id} in course {course_id}.
        slots:
          id: path.id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'