Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Account Reports API

7 actions 7 updates phrasing extends openapi/canvas-account-reports-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 7

$.info

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

$.paths['/v1/accounts/{account_id}/reports/{report}'].get

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

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

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

$.paths['/v1/accounts/{account_id}/reports/{report}/{id}/abort'].put

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 Account Reports API
  version: 1.0.0
extends: openapi/canvas-account-reports-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: 6
- target: $.paths['/v1/accounts/{account_id}/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List report types an account can run
      effect: read
      questions:
      - Which reports can I run on my Canvas account?
      - What parameters does each available account report accept?
      instructions:
      - text: List the available reports for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show which report types account {account_id} can generate.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/reports/{report}'].get
  update:
    x-apievangelist-phrasing:
      intent: List past runs of one report type
      effect: read
      questions:
      - How many times has a specific report been run on my account?
      - Can I see the history of a provisioning report's runs?
      instructions:
      - text: List all runs of the {report} report for account {account_id}.
        slots:
          report: path.report
          account_id: path.account_id
      - text: Show previous {report} reports generated in account {account_id}.
        slots:
          report: path.report
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/reports/{report}'].post
  update:
    x-apievangelist-phrasing:
      intent: Run an account report
      effect: write
      questions:
      - How do I generate a provisioning or SIS export report for my account?
      - Can I limit an account report to a single course?
      instructions:
      - text: Start the {report} report for account {account_id}.
        slots:
          report: path.report
          account_id: path.account_id
      - text: Run the {report} report on account {account_id} for course {course_id} only.
        slots:
          report: path.report
          account_id: path.account_id
          course_id: requestBody.parameters[course_id]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/reports/{report}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an account report's status
      effect: read
      questions:
      - Is my account report finished, and where can I download it?
      - What's the progress of a report I started?
      instructions:
      - text: Get the status of {report} report {id} in account {account_id}.
        slots:
          report: path.report
          id: path.id
          account_id: path.account_id
      - text: Check whether account {account_id} report {id} of type {report} is done.
        slots:
          account_id: path.account_id
          id: path.id
          report: path.report
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/reports/{report}/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a generated account report
      effect: destructive
      questions:
      - How do I delete an old report file from my account?
      - Can I remove a generated report instance once I've downloaded it?
      instructions:
      - text: Delete {report} report {id} from account {account_id}.
        slots:
          report: path.report
          id: path.id
          account_id: path.account_id
      - text: Remove the generated {report} report {id} in account {account_id}.
        slots:
          report: path.report
          id: path.id
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/reports/{report}/{id}/abort'].put
  update:
    x-apievangelist-phrasing:
      intent: Abort a running account report
      effect: destructive
      questions:
      - How do I stop a report that's still running?
      - Can I cancel an account report in progress?
      instructions:
      - text: Abort {report} report {id} in account {account_id}.
        slots:
          report: path.report
          id: path.id
          account_id: path.account_id
      - text: Cancel the in-progress {report} report {id} on account {account_id}.
        slots:
          report: path.report
          id: path.id
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'