Knock · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Knock Management API (mAPI) Channel Groups API

5 actions 5 updates phrasing extends openapi/knock-app-channel-groups-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 5

$.info
$.paths['/v1/channel_groups'].get
$.paths['/v1/channel_groups/{channel_group_key}'].get
$.paths['/v1/channel_groups/{channel_group_key}'].put
$.paths['/v1/channel_groups/{channel_group_key}'].delete

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 Knock Management API (mAPI) Channel Groups API
  version: 1.0.0
extends: openapi/knock-app-channel-groups-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: 4
- target: $.paths['/v1/channel_groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List channel groups
      effect: read
      questions:
      - Which channel groups exist across my account?
      - Are channel groups scoped per environment or account-wide?
      instructions:
      - text: List all channel groups.
      - text: Show the first {limit} channel groups.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/channel_groups/{channel_group_key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a channel group by key
      effect: read
      questions:
      - How do I see which channels belong to a channel group?
      - Can I look up one channel group's rules by key?
      instructions:
      - text: Get channel group {channel_group_key}.
        slots:
          channel_group_key: path.channel_group_key
      - text: Show the {channel_group_key} channel group details.
        slots:
          channel_group_key: path.channel_group_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/channel_groups/{channel_group_key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a channel group
      effect: write
      questions:
      - How do I create a channel group that bundles several channels?
      - Can I change an existing channel group's configuration?
      instructions:
      - text: Upsert channel group {channel_group_key} with {channel_group}.
        slots:
          channel_group_key: path.channel_group_key
          channel_group: requestBody.channel_group
      - text: Create channel group {channel_group_key} defined as {channel_group}.
        slots:
          channel_group_key: path.channel_group_key
          channel_group: requestBody.channel_group
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/channel_groups/{channel_group_key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive a channel group
      effect: destructive
      questions:
      - How do I delete a channel group I no longer need?
      - Is deleting a channel group a hard delete or a soft archive?
      instructions:
      - text: Delete channel group {channel_group_key}.
        slots:
          channel_group_key: path.channel_group_key
      - text: Archive the {channel_group_key} channel group.
        slots:
          channel_group_key: path.channel_group_key
      method: generated
      generated: '2026-10-01'