Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Sis Import Errors API

3 actions 3 updates phrasing extends openapi/canvas-sis-import-errors-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 3

$.info

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

$.paths['/v1/accounts/{account_id}/sis_import_errors'].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 Sis Import Errors API
  version: 1.0.0
extends: openapi/canvas-sis-import-errors-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: 2
- target: $.paths['/v1/accounts/{account_id}/sis_imports/{id}/errors'].get
  update:
    x-apievangelist-phrasing:
      intent: List errors from one SIS import
      effect: read
      questions:
      - What went wrong in a specific SIS import?
      - Can I list only the failures from one import run?
      instructions:
      - text: List errors for SIS import {id} in account {account_id}.
        slots:
          id: path.id
          account_id: path.account_id
      - text: Show failures only ({failure}) from SIS import {id} in account {account_id}.
        slots:
          failure: query.failure
          id: path.id
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/sis_import_errors'].get
  update:
    x-apievangelist-phrasing:
      intent: List all recent SIS import errors for an account
      effect: read
      questions:
      - How do I see every SIS import error on an account from the last 30 days?
      - Are SIS import errors kept forever, or only for a limited time?
      instructions:
      - text: List all SIS import errors for account {account_id}.
        slots:
          account_id: path.account_id
      - text: 'Show account {account_id}''s SIS import errors across all imports, failures only: {failure}.'
        slots:
          account_id: path.account_id
          failure: query.failure
      method: generated
      generated: '2026-10-01'