TextQL · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TextQL Slack Service API

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

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/textql.rpc.public.slack.SlackService/CreateSlackUuid'].post
$.paths['/textql.rpc.public.slack.SlackService/DeleteInstallation'].post
$.paths['/textql.rpc.public.slack.SlackService/GetCurrentUser'].post
$.paths['/textql.rpc.public.slack.SlackService/HandleSlackOAuthCallback'].post
$.paths['/textql.rpc.public.slack.SlackService/ListChannels'].post
$.paths['/textql.rpc.public.slack.SlackService/ListInstallations'].post
$.paths['/textql.rpc.public.slack.SlackService/ListUsers'].post
$.paths['/textql.rpc.public.slack.SlackService/SyncWorkspace'].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 TextQL Slack Service API
  version: 1.0.0
extends: openapi/textql-slackservice-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: 8
- target: $.paths['/textql.rpc.public.slack.SlackService/CreateSlackUuid'].post
  update:
    x-apievangelist-phrasing:
      intent: Start linking a Slack workspace
      effect: write
      questions:
      - How do I begin installing the TextQL app into Slack?
      - Where does the state value for a Slack install come from?
      instructions:
      - text: Create a Slack install UUID, sending Connect protocol version {protocol_version}.
        slots:
          protocol_version: header.Connect-Protocol-Version
      - text: Generate a new Slack linking identifier with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.slack.SlackService/DeleteInstallation'].post
  update:
    x-apievangelist-phrasing:
      intent: Uninstall from a Slack workspace
      effect: destructive
      questions:
      - How do I disconnect a Slack workspace?
      - Can I remove the Slack installation for one team?
      instructions:
      - text: Delete the Slack installation for team {team}.
        slots:
          team: requestBody.teamId
      - text: Disconnect Slack workspace {team}.
        slots:
          team: requestBody.teamId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.slack.SlackService/GetCurrentUser'].post
  update:
    x-apievangelist-phrasing:
      intent: Get my linked Slack user
      effect: read
      questions:
      - Which Slack user is linked to my account?
      - Is my profile connected to Slack yet?
      instructions:
      - text: Show my linked Slack user, sending Connect protocol version {protocol_version}.
        slots:
          protocol_version: header.Connect-Protocol-Version
      - text: Check which Slack identity I'm connected as, with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.slack.SlackService/HandleSlackOAuthCallback'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete the Slack OAuth install
      effect: write
      questions:
      - How do I finish a Slack install after the OAuth redirect?
      - What do I do with the code and state Slack sends back?
      instructions:
      - text: Complete the Slack OAuth callback with code {code} and state {state}.
        slots:
          code: requestBody.code
          state: requestBody.state
      - text: Exchange Slack authorization code {code} to finish the install.
        slots:
          code: requestBody.code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.slack.SlackService/ListChannels'].post
  update:
    x-apievangelist-phrasing:
      intent: List Slack channels
      effect: read
      questions:
      - Which Slack channels can TextQL post reports to?
      - How do I find a channel ID for playbook delivery?
      instructions:
      - text: List Slack channels, sending Connect protocol version {protocol_version}.
        slots:
          protocol_version: header.Connect-Protocol-Version
      - text: Show the channels in my connected Slack workspace with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.slack.SlackService/ListInstallations'].post
  update:
    x-apievangelist-phrasing:
      intent: List Slack installations
      effect: read
      questions:
      - Which Slack workspaces are connected to my organization?
      - Is the app installed in more than one Slack team?
      instructions:
      - text: List Slack installations, sending Connect protocol version {protocol_version}.
        slots:
          protocol_version: header.Connect-Protocol-Version
      - text: Show every connected Slack workspace with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.slack.SlackService/ListUsers'].post
  update:
    x-apievangelist-phrasing:
      intent: List Slack users
      effect: read
      questions:
      - Which Slack users can I tag on a report?
      - How do I look up Slack user IDs in the connected workspace?
      instructions:
      - text: List Slack users, sending Connect protocol version {protocol_version}.
        slots:
          protocol_version: header.Connect-Protocol-Version
      - text: Show the people in my connected Slack workspace with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.slack.SlackService/SyncWorkspace'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync a Slack workspace
      effect: write
      questions:
      - How do I refresh the channels and users from my Slack workspace?
      - Can I resync a Slack team after adding new channels?
      instructions:
      - text: Sync Slack workspace {team}.
        slots:
          team: requestBody.teamId
      - text: Refresh channels and users for Slack team {team}.
        slots:
          team: requestBody.teamId
      method: generated
      generated: '2026-10-01'