Slack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Slack Post API

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

$.info
$.paths['/stars.remove'].post
$.paths['/users.deletePhoto'].post
$.paths['/users.profile.set'].post
$.paths['/users.setActive'].post
$.paths['/users.setPhoto'].post
$.paths['/users.setPresence'].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 Post API
  version: 1.0.0
extends: openapi/slack-post-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: 6
- target: $.paths['/stars.remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a star from an item
      effect: write
      questions:
      - How do I unstar a message I saved earlier?
      - Can I remove a star from a file or file comment too?
      instructions:
      - text: Unstar the message at {timestamp} in channel {channel}.
        slots:
          timestamp: requestBody.timestamp
          channel: requestBody.channel
      - text: Remove the star from file {file}.
        slots:
          file: requestBody.file
      - text: Unstar file comment {file_comment}.
        slots:
          file_comment: requestBody.file_comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users.deletePhoto'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete my profile photo
      effect: destructive
      questions:
      - Can I remove my profile picture and go back to the default avatar?
      - What scope is needed to delete a user's profile photo?
      instructions:
      - text: Delete my profile photo using token {token}.
        slots:
          token: requestBody.token
      - text: Remove the current profile picture.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users.profile.set'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a user's profile fields
      effect: write
      questions:
      - How do I change my status or title on my profile?
      - Can an admin update another user's profile on a paid team?
      - How many profile fields can be set in one call?
      instructions:
      - text: Set profile field {name} to {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
      - text: Update my profile with {profile}.
        slots:
          profile: requestBody.profile
      - text: Update the profile of user {user} with {profile}.
        slots:
          user: requestBody.user
          profile: requestBody.profile
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users.setActive'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a user as active (deprecated)
      effect: write
      questions:
      - Does the old set-active call still do anything?
      - Is marking a user active still supported?
      instructions:
      - text: Call the deprecated set-active method with token {token}.
        slots:
          token: header.token
      - text: Mark me as active using the legacy method.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users.setPhoto'].post
  update:
    x-apievangelist-phrasing:
      intent: Set my profile photo
      effect: write
      questions:
      - How do I upload a new profile picture?
      - Can I crop the photo to a square when I upload it?
      instructions:
      - text: Set my profile photo to {image}.
        slots:
          image: requestBody.image
      - text: Upload {image} as my photo cropped to {crop_w} at {crop_x},{crop_y}.
        slots:
          image: requestBody.image
          crop_w: requestBody.crop_w
          crop_x: requestBody.crop_x
          crop_y: requestBody.crop_y
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users.setPresence'].post
  update:
    x-apievangelist-phrasing:
      intent: Set my presence to auto or away
      effect: write
      questions:
      - Can I force my status to away?
      - What presence values can I set manually?
      instructions:
      - text: Set my presence to {presence}.
        slots:
          presence: requestBody.presence
      - text: Mark me away by setting presence {presence}.
        slots:
          presence: requestBody.presence
      method: generated
      generated: '2026-09-26'