Slack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Slack DND Disturb API

6 actions 6 updates phrasing extends openapi/slack-disturb-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['/dnd.endDnd'].post
$.paths['/dnd.endSnooze'].post
$.paths['/dnd.info'].get
$.paths['/dnd.setSnooze'].post
$.paths['/dnd.teamInfo'].get

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 DND Disturb API
  version: 1.0.0
extends: openapi/slack-disturb-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['/dnd.endDnd'].post
  update:
    x-apievangelist-phrasing:
      intent: End my Do Not Disturb session
      effect: write
      questions:
      - How do I turn off Do Not Disturb right now?
      - Can I end a scheduled DND session early?
      instructions:
      - text: End my Do Not Disturb session now using token {token}.
        slots:
          token: header.token
      - text: Switch off Do Not Disturb immediately.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dnd.endSnooze'].post
  update:
    x-apievangelist-phrasing:
      intent: End my notification snooze
      effect: write
      questions:
      - Can I stop snoozing notifications before the timer runs out?
      - What's the call to end snooze mode?
      instructions:
      - text: End my snooze with token {token}.
        slots:
          token: header.token
      - text: Stop snoozing my notifications now.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dnd.info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's Do Not Disturb status
      effect: read
      questions:
      - Is a particular teammate in Do Not Disturb at the moment?
      - When does my current DND window end?
      instructions:
      - text: Get the Do Not Disturb status for user {user}.
        slots:
          user: query.user
      - text: Show my own DND status.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dnd.setSnooze'].post
  update:
    x-apievangelist-phrasing:
      intent: Snooze notifications for some minutes
      effect: write
      questions:
      - How do I snooze notifications for the next hour?
      - Can I change how long my current snooze lasts?
      instructions:
      - text: Snooze my notifications for {num_minutes} minutes.
        slots:
          num_minutes: requestBody.num_minutes
      - text: Extend my snooze to {num_minutes} minutes.
        slots:
          num_minutes: requestBody.num_minutes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dnd.teamInfo'].get
  update:
    x-apievangelist-phrasing:
      intent: Get DND status for several users
      effect: read
      questions:
      - Which of my teammates are in Do Not Disturb right now?
      - How many users' DND status can I check in one request?
      instructions:
      - text: Get the Do Not Disturb status for users {users}.
        slots:
          users: query.users
      - text: Check DND for the whole list {users} at once.
        slots:
          users: query.users
      method: generated
      generated: '2026-09-26'