Slack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Slack Web Views API

4 actions 4 updates phrasing extends openapi/slack-views-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['/views.open'].post
$.paths['/views.update'].post
$.paths['/views.publish'].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 Web Views API
  version: 1.0.0
extends: openapi/slack-views-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['/views.open'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a modal for a user
      effect: write
      questions:
      - How do I pop up a modal after someone runs my slash command?
      - What does my app need from an interaction to open a modal?
      instructions:
      - text: Open modal {view} using trigger {trigger_id}.
        slots:
          view: requestBody.view
          trigger_id: requestBody.trigger_id
      - text: Show the user a new modal {view} from interaction {trigger_id}.
        slots:
          view: requestBody.view
          trigger_id: requestBody.trigger_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/views.update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an open modal view
      effect: write
      questions:
      - Can I change the contents of a modal that's already open?
      - How do I avoid overwriting a view someone else just updated?
      instructions:
      - text: Replace the contents of view {view_id} with {view}.
        slots:
          view_id: requestBody.view_id
          view: requestBody.view
      - text: Update the view with external ID {external_id} to {view}.
        slots:
          external_id: requestBody.external_id
          view: requestBody.view
      - text: Update view {view_id} to {view} only if its hash is still {hash}.
        slots:
          view_id: requestBody.view_id
          view: requestBody.view
          hash: requestBody.hash
      method: generated
      generated: '2026-09-26'
- target: $.paths['/views.publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a user's App Home tab
      effect: write
      questions:
      - Can my app show a custom Home tab to each user?
      - Is the App Home view per user or shared by everyone?
      instructions:
      - text: Publish view {view} to the App Home of user {user_id}.
        slots:
          view: requestBody.view
          user_id: requestBody.user_id
      - text: Refresh user {user_id}'s Home tab with {view}.
        slots:
          user_id: requestBody.user_id
          view: requestBody.view
      method: generated
      generated: '2026-09-26'