Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Announcements API

2 actions 2 updates phrasing extends openapi/canvas-announcements-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/announcements'].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 Announcements API
  version: 1.0.0
extends: openapi/canvas-announcements-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/announcements'].get
  update:
    x-apievangelist-phrasing:
      intent: List announcements across courses
      effect: read
      questions:
      - Is there a way to pull announcements from several courses at once?
      - Can I get only the latest announcement per course in a date range?
      instructions:
      - text: List announcements for {context_codes}.
        slots:
          context_codes: query.context_codes
      - text: Show announcements in {context_codes} between {start_date} and {end_date}.
        slots:
          context_codes: query.context_codes
          start_date: query.start_date
          end_date: query.end_date
      - text: Get only the newest announcement for each of {context_codes}.
        slots:
          context_codes: query.context_codes
      method: generated
      generated: '2026-10-01'