Slack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Slack Bookmarks API

5 actions 5 updates phrasing extends openapi/slack-bookmarks-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Slack's API. It is a proposal applied on top of the contract, not a document Slack publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/bookmarks.add'].post
$.paths['/bookmarks.edit'].post
$.paths['/bookmarks.list'].get
$.paths['/bookmarks.remove'].post

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 Slack Bookmarks API
  version: 1.0.0
extends: openapi/slack-bookmarks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/bookmarks.add'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a bookmark to a channel
      effect: write
      questions:
      - How do I pin a useful link to the bookmarks bar of a channel?
      - Can I give a channel bookmark an emoji icon?
      instructions:
      - text: Add a {type} bookmark titled {title} to channel {channel_id} linking to {link}.
        slots:
          type: requestBody.type
          title: requestBody.title
          channel_id: requestBody.channel_id
          link: requestBody.link
      - text: Bookmark {link} in {channel_id} as {title} with emoji {emoji} and type {type}.
        slots:
          link: requestBody.link
          channel_id: requestBody.channel_id
          title: requestBody.title
          emoji: requestBody.emoji
          type: requestBody.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bookmarks.edit'].post
  update:
    x-apievangelist-phrasing:
      intent: Edit an existing channel bookmark
      effect: write
      questions:
      - Can I change the link or title of a bookmark that is already in a channel?
      - What bookmark fields can be edited after it is added?
      instructions:
      - text: Change bookmark {bookmark_id} in {channel_id} to point at {link}.
        slots:
          bookmark_id: requestBody.bookmark_id
          channel_id: requestBody.channel_id
          link: requestBody.link
      - text: Retitle existing bookmark {bookmark_id} in channel {channel_id} to {title}.
        slots:
          bookmark_id: requestBody.bookmark_id
          channel_id: requestBody.channel_id
          title: requestBody.title
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bookmarks.list'].get
  update:
    x-apievangelist-phrasing:
      intent: List a channel's bookmarks
      effect: read
      questions:
      - What bookmarks are saved in a channel?
      - Can I see every link on a channel's bookmarks bar?
      instructions:
      - text: List the bookmarks in channel {channel_id}.
        slots:
          channel_id: query.channel_id
      - text: Show me the saved links on {channel_id}'s bookmark bar.
        slots:
          channel_id: query.channel_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bookmarks.remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a bookmark from a channel
      effect: destructive
      questions:
      - How do I take an outdated bookmark off a channel?
      - Is removing a bookmark permanent?
      instructions:
      - text: Remove bookmark {bookmark_id} from channel {channel_id}.
        slots:
          bookmark_id: requestBody.bookmark_id
          channel_id: requestBody.channel_id
      - text: Delete the outdated bookmark {bookmark_id} in {channel_id}.
        slots:
          bookmark_id: requestBody.bookmark_id
          channel_id: requestBody.channel_id
      method: generated
      generated: '2026-09-26'