Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Admins API

5 actions 5 updates phrasing extends openapi/canvas-admins-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 5

$.info
$.paths['/v1/accounts/{account_id}/admins'].get
$.paths['/v1/accounts/{account_id}/admins'].post
$.paths['/v1/accounts/{account_id}/admins/{user_id}'].delete
$.paths['/v1/accounts/{account_id}/admins/self'].get

OpenAPI Overlay

Raw ↑ 
# 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 Admins API
  version: 1.0.0
extends: openapi/canvas-admins-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: 4
- target: $.paths['/v1/accounts/{account_id}/admins'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's admins
      effect: read
      questions:
      - Who are the admins on my Canvas account?
      - Can I search account admins by name or include removed ones?
      instructions:
      - text: List the admins in account {account_id}.
        slots:
          account_id: path.account_id
      - text: Find admins in account {account_id} matching {search_term}.
        slots:
          account_id: path.account_id
          search_term: query.search_term
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/admins'].post
  update:
    x-apievangelist-phrasing:
      intent: Make a user an account admin
      effect: write
      questions:
      - How do I give an existing user admin rights on an account?
      - Can I assign a specific admin role and skip the confirmation email?
      instructions:
      - text: Make user {user_id} an admin of account {account_id}.
        slots:
          user_id: requestBody.user_id
          account_id: path.account_id
      - text: Grant user {user_id} the {role_id} admin role in account {account_id}.
        slots:
          user_id: requestBody.user_id
          role_id: requestBody.role_id
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/admins/{user_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user's account admin role
      effect: destructive
      questions:
      - How do I revoke someone's admin rights on an account?
      - Do I need the role id to remove an account admin?
      instructions:
      - text: Remove admin role {role_id} from user {user_id} in account {account_id}.
        slots:
          role_id: query.role_id
          user_id: path.user_id
          account_id: path.account_id
      - text: Revoke user {user_id}'s admin rights on account {account_id} for role {role_id}.
        slots:
          user_id: path.user_id
          account_id: path.account_id
          role_id: query.role_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/admins/self'].get
  update:
    x-apievangelist-phrasing:
      intent: List my own admin roles in an account
      effect: read
      questions:
      - What admin roles do I have on an account?
      - Can I check my own admin permissions without listing every admin?
      instructions:
      - text: List my admin roles in account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show which admin roles I hold on account {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'