Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Account Notifications API

6 actions 6 updates phrasing extends openapi/canvas-account-notifications-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['/v1/accounts/{account_id}/account_notifications'].get

$.paths['/v1/accounts/{account_id}/account_notifications'].post

$.paths['/v1/accounts/{account_id}/account_notifications/{id}'].get

$.paths['/v1/accounts/{account_id}/account_notifications/{id}'].put

$.paths['/v1/accounts/{account_id}/account_notifications/{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 Account Notifications API
  version: 1.0.0
extends: openapi/canvas-account-notifications-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['/v1/accounts/{account_id}/account_notifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List my active account announcements
      effect: read
      questions:
      - What global announcements are showing for me in this account?
      - Can I also see announcements I already closed?
      instructions:
      - text: List active global notifications for me in account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show account {account_id} notifications including past ones with include past {include_past}.
        slots:
          account_id: path.account_id
          include_past: query.include_past
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/account_notifications'].post
  update:
    x-apievangelist-phrasing:
      intent: Post a global account announcement
      effect: write
      questions:
      - How do I put a banner announcement in front of everyone in an account?
      - Can I show a global notification only to certain roles?
      instructions:
      - text: Create a global notification in account {account_id} titled {subject} saying {message} from {start_at} to {end_at}.
        slots:
          account_id: path.account_id
          subject: requestBody.account_notification[subject]
          message: requestBody.account_notification[message]
          start_at: requestBody.account_notification[start_at]
          end_at: requestBody.account_notification[end_at]
      - text: 'Announce {subject}: {message} in account {account_id} between {start_at} and {end_at} for roles {roles}.'
        slots:
          subject: requestBody.account_notification[subject]
          message: requestBody.account_notification[message]
          account_id: path.account_id
          start_at: requestBody.account_notification[start_at]
          end_at: requestBody.account_notification[end_at]
          roles: requestBody.account_notification_roles
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/account_notifications/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a global account announcement
      effect: read
      questions:
      - What does a particular account announcement say?
      - Why can't I see an account notification I already closed?
      instructions:
      - text: Show global notification {id} in account {account_id}.
        slots:
          id: path.id
          account_id: path.account_id
      - text: Get the text of account {account_id} announcement {id}.
        slots:
          account_id: path.account_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/account_notifications/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a global account announcement
      effect: write
      questions:
      - Can I change the message or end date of an account announcement?
      - How do I extend how long a global notification is shown?
      instructions:
      - text: Change the message of notification {id} in account {account_id} to {message}.
        slots:
          id: path.id
          account_id: path.account_id
          message: requestBody.account_notification[message]
      - text: Extend account {account_id} announcement {id} to end at {end_at}.
        slots:
          account_id: path.account_id
          id: path.id
          end_at: requestBody.account_notification[end_at]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/account_notifications/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Close or delete an account announcement
      effect: destructive
      questions:
      - How do I dismiss an account announcement so I stop seeing it?
      - Can an admin delete a global notification for everyone?
      instructions:
      - text: Close notification {id} in account {account_id} for me.
        slots:
          id: path.id
          account_id: path.account_id
      - text: Destroy notification {id} in account {account_id} for all users with remove {remove}.
        slots:
          id: path.id
          account_id: path.account_id
          remove: query.remove
      method: generated
      generated: '2026-10-01'