Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Developer Key Account Bindings API

2 actions 2 updates phrasing extends openapi/canvas-developer-key-account-bindings-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/accounts/{account_id}/developer_keys/{developer_key_id}/developer_key_account_bindings'].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 Developer Key Account Bindings API
  version: 1.0.0
extends: openapi/canvas-developer-key-account-bindings-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/accounts/{account_id}/developer_keys/{developer_key_id}/developer_key_account_bindings'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn a developer key on or off for an account
      effect: write
      questions:
      - How do I enable a developer key for a sub-account?
      - Can I switch an existing developer key binding off for my account?
      instructions:
      - text: Bind developer key {developer_key_id} to account {account_id}.
        slots:
          developer_key_id: path.developer_key_id
          account_id: path.account_id
      - text: Set developer key {developer_key_id} to {workflow_state} in account {account_id}.
        slots:
          developer_key_id: path.developer_key_id
          workflow_state: requestBody.workflow_state
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'