Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Bookmarks API

6 actions 6 updates phrasing extends openapi/canvas-bookmarks-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/users/self/bookmarks'].get

$.paths['/v1/users/self/bookmarks'].post

$.paths['/v1/users/self/bookmarks/{id}'].get

$.paths['/v1/users/self/bookmarks/{id}'].put

$.paths['/v1/users/self/bookmarks/{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 Bookmarks API
  version: 1.0.0
extends: openapi/canvas-bookmarks-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/users/self/bookmarks'].get
  update:
    x-apievangelist-phrasing:
      intent: List my bookmarks
      effect: read
      questions:
      - What bookmarks have I saved in Canvas?
      - Can I see all my saved bookmarks in order?
      instructions:
      - text: List my bookmarks.
      - text: Show every bookmark I've saved.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/users/self/bookmarks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a bookmark
      effect: write
      questions:
      - How do I save a bookmark to a page or course?
      - Can I choose where a new bookmark appears in my list?
      instructions:
      - text: Bookmark {url} as {name}.
        slots:
          url: requestBody.url
          name: requestBody.name
      - text: Create a bookmark named {name} for {url} at position {position}.
        slots:
          name: requestBody.name
          url: requestBody.url
          position: requestBody.position
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/users/self/bookmarks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a bookmark
      effect: read
      questions:
      - What URL does one of my bookmarks point to?
      - Can I view the details of a single saved bookmark?
      instructions:
      - text: Get bookmark {id}.
        slots:
          id: path.id
      - text: Show the details of my bookmark {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/users/self/bookmarks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a bookmark
      effect: write
      questions:
      - How do I rename one of my bookmarks?
      - Can I reorder a bookmark by changing its position?
      instructions:
      - text: Rename bookmark {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Move bookmark {id} to position {position}.
        slots:
          id: path.id
          position: requestBody.position
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/users/self/bookmarks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a bookmark
      effect: destructive
      questions:
      - How do I remove a bookmark I no longer need?
      - Can I delete one saved bookmark by id?
      instructions:
      - text: Delete bookmark {id}.
        slots:
          id: path.id
      - text: Remove my saved bookmark {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'