Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk Slack API

3 actions 3 updates phrasing extends openapi/snyk-slack-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 3

$.info
$.paths['/orgs/{org_id}/slack_app/{tenant_id}/channels'].get
$.paths['/orgs/{org_id}/slack_app/{tenant_id}/channels/{channel_id}'].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 Snyk Slack API
  version: 1.0.0
extends: openapi/snyk-slack-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: 2
- target: $.paths['/orgs/{org_id}/slack_app/{tenant_id}/channels'].get
  update:
    x-apievangelist-phrasing:
      intent: List Slack channels the Snyk Slack App can access
      effect: read
      questions:
      - Which Slack channels can the Snyk Slack App post to for my org?
      - Can I page backwards through the Slack channel list?
      instructions:
      - text: List Slack channels for org {org_id} in Slack workspace {tenant_id}.
        slots:
          org_id: path.org_id
          tenant_id: path.tenant_id
      - text: Show {limit} channels the Slack App can reach for org {org_id}, workspace {tenant_id}.
        slots:
          limit: query.limit
          org_id: path.org_id
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/slack_app/{tenant_id}/channels/{channel_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a Slack channel's name by ID
      effect: read
      questions:
      - What is the name of the Slack channel with a given channel ID?
      - Can I resolve a Slack channel ID to a readable name?
      instructions:
      - text: Get the name of Slack channel {channel_id} for org {org_id} in workspace {tenant_id}.
        slots:
          channel_id: path.channel_id
          org_id: path.org_id
          tenant_id: path.tenant_id
      - text: Resolve channel ID {channel_id} to its name (org {org_id}, workspace {tenant_id}).
        slots:
          channel_id: path.channel_id
          org_id: path.org_id
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'