Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Webhooks Subscriptions For Plagiarism…

6 actions 6 updates phrasing extends openapi/canvas-webhooks-subscriptions-for-plagiarism-platform-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 6

$.info

$.paths['/lti/subscriptions'].get

$.paths['/lti/subscriptions'].post

$.paths['/lti/subscriptions/{id}'].get

$.paths['/lti/subscriptions/{id}'].put

$.paths['/lti/subscriptions/{id}'].delete

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 Webhooks Subscriptions For Plagiarism…
  version: 1.0.0
extends: openapi/canvas-webhooks-subscriptions-for-plagiarism-platform-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: 5
- target: $.paths['/lti/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List my tool's webhook subscriptions
      effect: read
      questions:
      - What webhook subscriptions does my plagiarism-detection tool have?
      - How do I page past the first 100 webhook subscriptions?
      instructions:
      - text: List all webhook subscriptions for my tool proxy.
      - text: Show every event subscription my plagiarism tool has registered.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lti/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a tool to Canvas events
      effect: write
      questions:
      - How does a plagiarism platform subscribe to submission events in Canvas?
      - Which transport and format settings does a webhook subscription need?
      instructions:
      - text: Subscribe to {EventTypes} in {ContextType} {ContextId} via {TransportType}.
        slots:
          EventTypes: requestBody.subscription[EventTypes]
          ContextType: requestBody.subscription[ContextType]
          ContextId: requestBody.subscription[ContextId]
          TransportType: requestBody.subscription[TransportType]
      - text: Create a {Format} webhook subscription for {EventTypes} on {ContextType} {ContextId} with {TransportType} transport {TransportMetadata}.
        slots:
          Format: requestBody.subscription[Format]
          EventTypes: requestBody.subscription[EventTypes]
          ContextType: requestBody.subscription[ContextType]
          ContextId: requestBody.subscription[ContextId]
          TransportType: requestBody.subscription[TransportType]
          TransportMetadata: requestBody.subscription[TransportMetadata]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lti/subscriptions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook subscription
      effect: read
      questions:
      - How do I check the details of one webhook subscription?
      - Which events is a given subscription listening for?
      instructions:
      - text: Show webhook subscription {id}.
        slots:
          id: path.id
      - text: Get the configuration of subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lti/subscriptions/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook subscription
      effect: write
      questions:
      - Can I change the events or transport on an existing webhook subscription?
      - How do I edit a plagiarism tool's subscription?
      instructions:
      - text: Update webhook subscription {id}.
        slots:
          id: path.id
      - text: Change the settings of subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lti/subscriptions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook subscription
      effect: destructive
      questions:
      - How do I stop receiving events from a webhook subscription?
      - Can I unsubscribe my tool from Canvas events?
      instructions:
      - text: Delete webhook subscription {id}.
        slots:
          id: path.id
      - text: Unsubscribe and remove subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'