Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Announcement External Feeds API

7 actions 7 updates phrasing extends openapi/canvas-announcement-external-feeds-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/courses/{course_id}/external_feeds'].get

$.paths['/v1/courses/{course_id}/external_feeds'].post

$.paths['/v1/groups/{group_id}/external_feeds'].get

$.paths['/v1/groups/{group_id}/external_feeds'].post

$.paths['/v1/courses/{course_id}/external_feeds/{external_feed_id}'].delete

$.paths['/v1/groups/{group_id}/external_feeds/{external_feed_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 Announcement External Feeds API
  version: 1.0.0
extends: openapi/canvas-announcement-external-feeds-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/courses/{course_id}/external_feeds'].get
  update:
    x-apievangelist-phrasing:
      intent: List a course's external announcement feeds
      effect: read
      questions:
      - Which RSS feeds are posting announcements into my course?
      - Can I see the external feeds attached to a course?
      instructions:
      - text: List external feeds in course {course_id}.
        slots:
          course_id: path.course_id
      - text: Show the RSS sources that feed course {course_id}'s announcements.
        slots:
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/external_feeds'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an external feed to a course
      effect: write
      questions:
      - How do I pipe an RSS feed into a course's announcements?
      - Can I only import feed items whose title matches a phrase?
      instructions:
      - text: Add feed {url} to course {course_id}.
        slots:
          url: requestBody.url
          course_id: path.course_id
      - text: Add feed {url} to course {course_id}, only posting items matching {header_match}.
        slots:
          url: requestBody.url
          course_id: path.course_id
          header_match: requestBody.header_match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/groups/{group_id}/external_feeds'].get
  update:
    x-apievangelist-phrasing:
      intent: List a group's external announcement feeds
      effect: read
      questions:
      - Which external feeds post into a student group's announcements?
      - Can I check whether a group has an RSS feed connected?
      instructions:
      - text: List external feeds in group {group_id}.
        slots:
          group_id: path.group_id
      - text: Show the RSS sources feeding group {group_id}'s announcements.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/groups/{group_id}/external_feeds'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an external feed to a group
      effect: write
      questions:
      - Can a student group pull announcements from an outside RSS feed?
      - How much of each feed item gets posted, the full text or a link?
      instructions:
      - text: Add feed {url} to group {group_id}.
        slots:
          url: requestBody.url
          group_id: path.group_id
      - text: Connect feed {url} to group {group_id} with {verbosity} verbosity.
        slots:
          url: requestBody.url
          group_id: path.group_id
          verbosity: requestBody.verbosity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/external_feeds/{external_feed_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an external feed from a course
      effect: destructive
      questions:
      - Can I disconnect an RSS feed from a course?
      - How do I stop an outside feed posting to my course announcements?
      instructions:
      - text: Delete external feed {external_feed_id} from course {course_id}.
        slots:
          external_feed_id: path.external_feed_id
          course_id: path.course_id
      - text: Disconnect feed {external_feed_id} from course {course_id}'s announcements.
        slots:
          external_feed_id: path.external_feed_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/groups/{group_id}/external_feeds/{external_feed_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an external feed from a group
      effect: destructive
      questions:
      - Can I remove an RSS feed from a student group?
      - How do I stop an outside feed posting into a group?
      instructions:
      - text: Delete external feed {external_feed_id} from group {group_id}.
        slots:
          external_feed_id: path.external_feed_id
          group_id: path.group_id
      - text: Disconnect feed {external_feed_id} from group {group_id}'s announcements.
        slots:
          external_feed_id: path.external_feed_id
          group_id: path.group_id
      method: generated
      generated: '2026-10-01'