Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Favorites API

9 actions 9 updates phrasing extends openapi/canvas-favorites-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 9

$.info

$.paths['/v1/users/self/favorites/courses'].get

$.paths['/v1/users/self/favorites/courses'].delete

$.paths['/v1/users/self/favorites/groups'].get

$.paths['/v1/users/self/favorites/groups'].delete

$.paths['/v1/users/self/favorites/courses/{id}'].post

$.paths['/v1/users/self/favorites/courses/{id}'].delete

$.paths['/v1/users/self/favorites/groups/{id}'].post

$.paths['/v1/users/self/favorites/groups/{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 Favorites API
  version: 1.0.0
extends: openapi/canvas-favorites-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: 8
- target: $.paths['/v1/users/self/favorites/courses'].get
  update:
    x-apievangelist-phrasing:
      intent: List my favorite courses
      effect: read
      questions:
      - Which courses are starred on my Canvas dashboard?
      - Can I leave blueprint courses out of my favorites list?
      instructions:
      - text: List my favorite courses.
      - text: Show my favorite courses with blueprint exclusion set to {exclude_blueprint_courses}.
        slots:
          exclude_blueprint_courses: query.exclude_blueprint_courses
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/users/self/favorites/courses'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset my favorite courses to the default
      effect: destructive
      questions:
      - Can I wipe my course favorites and go back to the automatic enrolled list?
      - What happens to my dashboard course picks if I reset them?
      instructions:
      - text: Reset my course favorites to the default.
      - text: Clear all my starred courses.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/users/self/favorites/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List my favorite groups
      effect: read
      questions:
      - Which groups have I marked as favorites?
      - If I never chose favorite groups, what shows up instead?
      instructions:
      - text: List my favorite groups.
      - text: Show the groups I have starred.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/users/self/favorites/groups'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset my favorite groups to the default
      effect: destructive
      questions:
      - Can I undo all my group favorites in one go?
      - Does resetting group favorites restore my enrolled groups?
      instructions:
      - text: Reset my group favorites.
      - text: Clear every group I have favorited.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/users/self/favorites/courses/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a course to my favorites
      effect: write
      questions:
      - How do I pin a course to my dashboard?
      - What happens if I favorite a course that's already a favorite?
      instructions:
      - text: Add course {id} to my favorites.
        slots:
          id: path.id
      - text: Star course {id} on my dashboard.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/users/self/favorites/courses/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a course from my favorites
      effect: destructive
      questions:
      - Can I unstar an old course so it leaves my dashboard?
      - Is removing a single course from favorites possible?
      instructions:
      - text: Remove course {id} from my favorites.
        slots:
          id: path.id
      - text: Unstar course {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/users/self/favorites/groups/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a group to my favorites
      effect: write
      questions:
      - Can I favorite a group so it's easy to find?
      - Is starring a group that's already favorited harmless?
      instructions:
      - text: Add group {id} to my favorites.
        slots:
          id: path.id
      - text: Star group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/users/self/favorites/groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a group from my favorites
      effect: destructive
      questions:
      - How do I unfavorite a group I'm no longer active in?
      - Can one group be taken off my favorites?
      instructions:
      - text: Remove group {id} from my favorites.
        slots:
          id: path.id
      - text: Unstar group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'