Slack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Slack Web Pins API

4 actions 4 updates phrasing extends openapi/slack-pins-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 4

$.info
$.paths['/pins.add'].post
$.paths['/pins.remove'].post
$.paths['/pins.list'].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 Slack Web Pins API
  version: 1.0.0
extends: openapi/slack-pins-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: 3
- target: $.paths['/pins.add'].post
  update:
    x-apievangelist-phrasing:
      intent: Pin a message to a channel
      effect: write
      questions:
      - How do I pin an important message so everyone in the channel can find it?
      - What scope does my app need to pin messages?
      instructions:
      - text: Pin the message at {timestamp} in channel {channel}.
        slots:
          timestamp: requestBody.timestamp
          channel: requestBody.channel
      - text: Pin message {timestamp} to the top of {channel}.
        slots:
          timestamp: requestBody.timestamp
          channel: requestBody.channel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pins.remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Unpin a message from a channel
      effect: destructive
      questions:
      - Can I unpin a message that is no longer relevant?
      - Does unpinning a message delete it from the channel?
      instructions:
      - text: Unpin the message at {timestamp} in {channel}.
        slots:
          timestamp: requestBody.timestamp
          channel: requestBody.channel
      - text: Take message {timestamp} off the pinned items of channel {channel}.
        slots:
          timestamp: requestBody.timestamp
          channel: requestBody.channel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pins.list'].get
  update:
    x-apievangelist-phrasing:
      intent: List pinned items in a channel
      effect: read
      questions:
      - What has been pinned in a channel?
      - Can I see all pinned messages and files for one channel?
      instructions:
      - text: List the pinned items in channel {channel}.
        slots:
          channel: query.channel
      - text: Show me everything pinned in {channel}.
        slots:
          channel: query.channel
      method: generated
      generated: '2026-09-26'