Slack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Slack Functions Automation API

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

$.info
$.paths['/functions.completeSuccess'].post
$.paths['/functions.completeError'].post
$.paths['/functions.distributions.permissions.add'].post
$.paths['/functions.distributions.permissions.list'].get
$.paths['/functions.distributions.permissions.remove'].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 Functions Automation API
  version: 1.0.0
extends: openapi/slack-automation-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: 5
- target: $.paths['/functions.completeSuccess'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a custom workflow step as succeeded
      effect: write
      questions:
      - How does my custom function tell the workflow it finished successfully?
      - Can I pass output values back to the workflow when a step succeeds?
      instructions:
      - text: Report function execution {function_execution_id} as successful with outputs {outputs}.
        slots:
          function_execution_id: requestBody.function_execution_id
          outputs: requestBody.outputs
      - text: Complete step {function_execution_id} successfully and return {outputs} to the workflow.
        slots:
          function_execution_id: requestBody.function_execution_id
          outputs: requestBody.outputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions.completeError'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a custom workflow step as failed
      effect: write
      questions:
      - What should my custom function do when it hits an error mid-workflow?
      - Can I show the workflow a reason why my step failed?
      instructions:
      - text: Fail function execution {function_execution_id} with error {error}.
        slots:
          function_execution_id: requestBody.function_execution_id
          error: requestBody.error
      - text: Tell the workflow step {function_execution_id} broke because {error}.
        slots:
          function_execution_id: requestBody.function_execution_id
          error: requestBody.error
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions.distributions.permissions.add'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant users access to a custom function
      effect: write
      questions:
      - How do I let more people use a custom function in their workflows?
      - Can I share a function with specific users instead of everyone?
      instructions:
      - text: Grant users {user_ids} access to function {function_app_id}.
        slots:
          user_ids: requestBody.user_ids
          function_app_id: requestBody.function_app_id
      - text: Set distribution for function {function_app_id} to {permission_type}.
        slots:
          function_app_id: requestBody.function_app_id
          permission_type: requestBody.permission_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions.distributions.permissions.list'].get
  update:
    x-apievangelist-phrasing:
      intent: List who can use a custom function
      effect: read
      questions:
      - Who currently has permission to use my custom function?
      - Is my function shared with everyone or only named users?
      instructions:
      - text: Show the distribution permissions for function {function_app_id}.
        slots:
          function_app_id: query.function_app_id
      - text: List who is allowed to use {function_app_id} in workflows.
        slots:
          function_app_id: query.function_app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/functions.distributions.permissions.remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke users' access to a custom function
      effect: destructive
      questions:
      - Can I take away someone's ability to use my custom function?
      - What happens to workflows when I revoke a function's distribution?
      instructions:
      - text: Revoke access to function {function_app_id} for users {user_ids}.
        slots:
          function_app_id: requestBody.function_app_id
          user_ids: requestBody.user_ids
      - text: Stop sharing function {function_app_id}.
        slots:
          function_app_id: requestBody.function_app_id
      method: generated
      generated: '2026-09-26'