Slack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Slack Workflows API

4 actions 4 updates phrasing extends openapi/slack-workflows-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['/workflows.stepCompleted'].get

$.paths['/workflows.stepFailed'].get

$.paths['/workflows.updateStep'].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 Workflows API
  version: 1.0.0
extends: openapi/slack-workflows-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['/workflows.stepCompleted'].get
  update:
    x-apievangelist-phrasing:
      intent: Report a workflow step as completed
      effect: write
      questions:
      - How does my app tell Workflow Builder that its step finished?
      - Can I hand output values to later steps when my step completes?
      instructions:
      - text: Mark workflow step execution {workflow_step_execute_id} as completed.
        slots:
          workflow_step_execute_id: query.workflow_step_execute_id
      - text: Complete step {workflow_step_execute_id} and pass outputs {outputs}.
        slots:
          workflow_step_execute_id: query.workflow_step_execute_id
          outputs: query.outputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflows.stepFailed'].get
  update:
    x-apievangelist-phrasing:
      intent: Report a workflow step as failed
      effect: write
      questions:
      - What should my app call when its workflow step cannot finish?
      - Can I include an error message when a step fails?
      instructions:
      - text: Mark step execution {workflow_step_execute_id} as failed with error {error}.
        slots:
          workflow_step_execute_id: query.workflow_step_execute_id
          error: query.error
      - text: Report that workflow step {workflow_step_execute_id} failed because {error}.
        slots:
          workflow_step_execute_id: query.workflow_step_execute_id
          error: query.error
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflows.updateStep'].get
  update:
    x-apievangelist-phrasing:
      intent: Save the configuration of a workflow step
      effect: write
      questions:
      - How do I save the inputs a user configured for my workflow step?
      - Can I change the name or image shown for my step in Workflow Builder?
      instructions:
      - text: Save inputs {inputs} for step edit {workflow_step_edit_id}.
        slots:
          inputs: query.inputs
          workflow_step_edit_id: query.workflow_step_edit_id
      - text: Rename the step being edited in {workflow_step_edit_id} to {step_name}.
        slots:
          workflow_step_edit_id: query.workflow_step_edit_id
          step_name: query.step_name
      method: generated
      generated: '2026-09-26'