Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Account Calendars API

7 actions 7 updates phrasing extends openapi/canvas-account-calendars-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 7

$.info
$.paths['/v1/account_calendars'].get
$.paths['/v1/account_calendars/{account_id}'].get
$.paths['/v1/account_calendars/{account_id}'].put
$.paths['/v1/accounts/{account_id}/account_calendars'].get
$.paths['/v1/accounts/{account_id}/account_calendars'].put
$.paths['/v1/accounts/{account_id}/visible_calendars_count'].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 Account Calendars API
  version: 1.0.0
extends: openapi/canvas-account-calendars-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: 6
- target: $.paths['/v1/account_calendars'].get
  update:
    x-apievangelist-phrasing:
      intent: List account calendars I can subscribe to
      effect: read
      questions:
      - Which institution-wide calendars can I add to my Canvas calendar?
      - Can I search the available account calendars by name?
      instructions:
      - text: List the account calendars available to me.
      - text: Find available account calendars matching {search_term}.
        slots:
          search_term: query.search_term
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/account_calendars/{account_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one account calendar
      effect: read
      questions:
      - Is a particular department's calendar visible and auto-subscribed?
      - What details does a single account calendar expose?
      instructions:
      - text: Get the account calendar for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show details of account {account_id}'s calendar.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/account_calendars/{account_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an account calendar's visibility
      effect: write
      questions:
      - Can I hide one account calendar or make users auto-subscribe to it?
      - What permission is needed to change an account calendar's visibility?
      instructions:
      - text: 'Make the calendar for account {account_id} visible: {visible}.'
        slots:
          account_id: path.account_id
          visible: requestBody.visible
      - text: Set auto subscribe to {auto_subscribe} on account {account_id}'s calendar.
        slots:
          auto_subscribe: requestBody.auto_subscribe
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/account_calendars'].get
  update:
    x-apievangelist-phrasing:
      intent: List calendars for an account and sub-accounts
      effect: read
      questions:
      - Can an admin see every account calendar, including hidden ones, under an account?
      - Is filtering sub-account calendars by visibility possible?
      instructions:
      - text: List all account calendars under account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show account {account_id} sub-account calendars filtered to {filter}.
        slots:
          account_id: path.account_id
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/account_calendars'].put
  update:
    x-apievangelist-phrasing:
      intent: Change visibility on many account calendars
      effect: write
      questions:
      - Can I show or hide a batch of sub-account calendars at once?
      - Is there a bulk way to set auto subscribe across calendars?
      instructions:
      - text: Bulk update calendar visibility under account {account_id}.
        slots:
          account_id: path.account_id
      - text: Set visibility and auto subscribe on several calendars in account {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/visible_calendars_count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count visible account calendars
      effect: read
      questions:
      - How many account calendars are currently visible to users?
      - Can I get just a count of visible calendars for an account?
      instructions:
      - text: Count the visible account calendars for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Tell me the number of shown calendars in {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'