Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Error Reports API

2 actions 2 updates phrasing extends openapi/canvas-error-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 2

$.info

$.paths['/v1/error_reports'].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 Error Reports API
  version: 1.0.0
extends: openapi/canvas-error-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: 1
- target: $.paths['/v1/error_reports'].post
  update:
    x-apievangelist-phrasing:
      intent: Report a problem
      effect: write
      questions:
      - How can a user report a problem the same way as the help menu does?
      - Can I attach the page URL and a contact email to an error report?
      instructions:
      - text: File an error report titled {subject}.
        slots:
          subject: requestBody.error[subject]
      - text: Report problem {subject} on page {url} and reply to {email}.
        slots:
          subject: requestBody.error[subject]
          url: requestBody.error[url]
          email: requestBody.error[email]
      method: generated
      generated: '2026-10-01'