Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Notice Handlers API

3 actions 3 updates phrasing extends openapi/canvas-notice-handlers-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['/lti/notice-handlers/{context_external_tool_id}'].get

$.paths['/lti/notice-handlers/{context_external_tool_id}'].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 Notice Handlers API
  version: 1.0.0
extends: openapi/canvas-notice-handlers-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['/lti/notice-handlers/{context_external_tool_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List an LTI tool's notice handlers
      effect: read
      questions:
      - Which platform notices is an LTI tool subscribed to?
      - How do I see the notice handlers registered for a tool?
      instructions:
      - text: Show notice handlers for tool {context_external_tool_id}.
        slots:
          context_external_tool_id: path.context_external_tool_id
      - text: List the notices tool {context_external_tool_id} handles.
        slots:
          context_external_tool_id: path.context_external_tool_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lti/notice-handlers/{context_external_tool_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Subscribe or unsubscribe a tool notice handler
      effect: write
      questions:
      - How does an LTI tool subscribe to a platform notice type?
      - Can I limit how many notices arrive in one batch?
      instructions:
      - text: Set the {notice_type} handler for tool {context_external_tool_id} to {handler}.
        slots:
          notice_type: requestBody.notice_type
          context_external_tool_id: path.context_external_tool_id
          handler: requestBody.handler
      - text: Subscribe tool {context_external_tool_id} to {notice_type} at {handler} with max batch size {max_batch_size}.
        slots:
          context_external_tool_id: path.context_external_tool_id
          notice_type: requestBody.notice_type
          handler: requestBody.handler
          max_batch_size: requestBody.max_batch_size
      method: generated
      generated: '2026-10-01'