Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Sis Integration API

4 actions 4 updates phrasing extends openapi/canvas-sis-integration-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['/sis/accounts/{account_id}/assignments'].get

$.paths['/sis/courses/{course_id}/assignments'].get

$.paths['/sis/courses/{course_id}/disable_post_to_sis'].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 Sis Integration API
  version: 1.0.0
extends: openapi/canvas-sis-integration-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['/sis/accounts/{account_id}/assignments'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's SIS-export assignments
      effect: read
      questions:
      - Which published assignments across an account are flagged to send grades to the SIS?
      - Can I limit SIS export assignments to a date range?
      instructions:
      - text: List assignments enabled for SIS grade export in account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show account {account_id} SIS-export assignments starting before {starts_before}.
        slots:
          account_id: path.account_id
          starts_before: query.starts_before
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sis/courses/{course_id}/assignments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a course's SIS-export assignments
      effect: read
      questions:
      - Which assignments in a single course will post grades to the SIS?
      - Can I see a course's SIS export assignments that end after a certain date?
      instructions:
      - text: List assignments enabled for SIS grade export in course {course_id}.
        slots:
          course_id: path.course_id
      - text: Show course {course_id} SIS-export assignments ending after {ends_after}.
        slots:
          course_id: path.course_id
          ends_after: query.ends_after
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sis/courses/{course_id}/disable_post_to_sis'].put
  update:
    x-apievangelist-phrasing:
      intent: Turn off SIS grade export for a course
      effect: write
      questions:
      - How do I stop every assignment in a course from posting grades to the SIS?
      - Can I disable SIS export for just one grading period?
      instructions:
      - text: Disable SIS grade export for all assignments in course {course_id}.
        slots:
          course_id: path.course_id
      - text: Turn off post to SIS in course {course_id} for grading period {grading_period_id}.
        slots:
          course_id: path.course_id
          grading_period_id: requestBody.grading_period_id
      method: generated
      generated: '2026-10-01'