Slack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Slack OAuth Access API

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

$.info

$.paths['/oauth.access'].get

$.paths['/oauth.v2.access'].get

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 Slack OAuth Access API
  version: 1.0.0
extends: openapi/slack-access-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: 2
- target: $.paths['/oauth.access'].get
  update:
    x-apievangelist-phrasing:
      intent: Exchange an OAuth code on the legacy v1 flow
      effect: read
      questions:
      - How do I exchange a code for a token with the older v1 OAuth flow for classic apps?
      - Can the legacy v1 OAuth exchange limit the token to a single channel?
      instructions:
      - text: Exchange code {code} for a token using the legacy v1 OAuth endpoint with client {client_id}.
        slots:
          code: query.code
          client_id: query.client_id
      - text: Complete the classic v1 OAuth flow for code {code} and redirect URI {redirect_uri}, single channel only.
        slots:
          code: query.code
          redirect_uri: query.redirect_uri
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oauth.v2.access'].get
  update:
    x-apievangelist-phrasing:
      intent: Exchange an OAuth code on the v2 flow
      effect: read
      questions:
      - What is the call to swap a v2 OAuth code for an access token when installing my app?
      - Which parameters does the OAuth v2 access exchange need?
      instructions:
      - text: Exchange code {code} for an access token using OAuth v2 with client {client_id} and secret {client_secret}.
        slots:
          code: query.code
          client_id: query.client_id
          client_secret: query.client_secret
      - text: Finish the v2 app install by trading code {code} at redirect URI {redirect_uri}.
        slots:
          code: query.code
          redirect_uri: query.redirect_uri
      method: generated
      generated: '2026-09-26'