Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk Slack Settings API

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

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/orgs/{org_id}/slack_app/{bot_id}'].get
$.paths['/orgs/{org_id}/slack_app/{bot_id}'].post
$.paths['/orgs/{org_id}/slack_app/{bot_id}'].delete
$.paths['/orgs/{org_id}/slack_app/{bot_id}/projects'].get
$.paths['/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}'].post
$.paths['/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}'].delete
$.paths['/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}'].patch

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 Snyk Slack Settings API
  version: 1.0.0
extends: openapi/snyk-slacksettings-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: 7
- target: $.paths['/orgs/{org_id}/slack_app/{bot_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default Slack notification settings
      effect: read
      questions:
      - What are the default Slack notification settings for my Slack app bot?
      - Can I check which Slack channel the organization-wide notifications go to?
      instructions:
      - text: Get the default Slack notification settings for bot {bot_id} in org {org_id}.
        slots:
          bot_id: path.bot_id
          org_id: path.org_id
      - text: Show org {org_id}'s Slack defaults for bot {bot_id}.
        slots:
          org_id: path.org_id
          bot_id: path.bot_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/slack_app/{bot_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create default Slack notification settings
      effect: write
      questions:
      - How do I set up default Slack notifications for my organization?
      - Can I choose the default Slack channel for new-issue alerts?
      instructions:
      - text: Create default Slack notification settings for bot {bot_id} in org {org_id}.
        slots:
          bot_id: path.bot_id
          org_id: path.org_id
      - text: Configure org {org_id}'s Slack bot {bot_id} defaults to post to our security channel.
        slots:
          org_id: path.org_id
          bot_id: path.bot_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/slack_app/{bot_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the Slack App integration
      effect: destructive
      questions:
      - Can I remove the Slack App integration from my organization?
      - What disconnects a Slack bot from an org entirely?
      instructions:
      - text: Remove the Slack App integration for bot {bot_id} from org {org_id}.
        slots:
          bot_id: path.bot_id
          org_id: path.org_id
      - text: Uninstall Slack bot {bot_id} from organization {org_id}.
        slots:
          bot_id: path.bot_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/slack_app/{bot_id}/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List per-project Slack notification overrides
      effect: read
      questions:
      - Which projects override the default Slack notification settings?
      - Can I see all project-level Slack overrides for a bot?
      instructions:
      - text: List project Slack overrides for bot {bot_id} in org {org_id}.
        slots:
          bot_id: path.bot_id
          org_id: path.org_id
      - text: Show the first {limit} projects with custom Slack settings for bot {bot_id} in org {org_id}.
        slots:
          limit: query.limit
          bot_id: path.bot_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Slack settings override for a project
      effect: write
      questions:
      - Can one project send Slack notifications to a different channel than the default?
      - How do I add a project-specific Slack override?
      instructions:
      - text: Create a Slack override for project {project_id} on bot {bot_id} in org {org_id}.
        slots:
          project_id: path.project_id
          bot_id: path.bot_id
          org_id: path.org_id
      - text: Send project {project_id} alerts to its own Slack channel via bot {bot_id} in org {org_id}.
        slots:
          project_id: path.project_id
          bot_id: path.bot_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a project's Slack settings override
      effect: destructive
      questions:
      - Can I make a project fall back to the default Slack settings again?
      - What removes a single project's Slack override?
      instructions:
      - text: Remove the Slack override for project {project_id} on bot {bot_id} in org {org_id}.
        slots:
          project_id: path.project_id
          bot_id: path.bot_id
          org_id: path.org_id
      - text: Reset project {project_id} to default Slack notifications for bot {bot_id}, org {org_id}.
        slots:
          project_id: path.project_id
          bot_id: path.bot_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a project's Slack notification override
      effect: write
      questions:
      - Can I change an existing project's Slack override settings?
      - Is it possible to move a project's Slack alerts to another channel after the override exists?
      instructions:
      - text: Update the Slack override for project {project_id} on bot {bot_id} in org {org_id}.
        slots:
          project_id: path.project_id
          bot_id: path.bot_id
          org_id: path.org_id
      - text: Change project {project_id}'s existing Slack settings for bot {bot_id} in org {org_id}.
        slots:
          project_id: path.project_id
          bot_id: path.bot_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'