Knock · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Knock Management API (mAPI) Channels API

3 actions 3 updates phrasing extends openapi/knock-app-channels-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Knock's API. It is a proposal applied on top of the contract, not a document Knock publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v1/channels'].get

$.paths['/v1/channels/{channel_key}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Knock Management API (mAPI) Channels API
  version: 1.0.0
extends: openapi/knock-app-channels-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/v1/channels'].get
  update:
    x-apievangelist-phrasing:
      intent: List channels in my account
      effect: read
      questions:
      - Which delivery channels are configured in my Knock account?
      - Can I filter the channel list down to specific channel IDs?
      instructions:
      - text: List all my channels.
      - text: List channels including {include}, {limit} per page.
        slots:
          include: query.include
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/channels/{channel_key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a channel and its settings
      effect: read
      questions:
      - How do I see a channel's per-environment provider settings?
      - Are secret provider values hidden when I fetch a channel?
      instructions:
      - text: Get channel {channel_key}.
        slots:
          channel_key: path.channel_key
      - text: Show environment settings for the {channel_key} channel.
        slots:
          channel_key: path.channel_key
      method: generated
      generated: '2026-10-01'