Knock · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/knock-app-environments-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/environments/{environment_slug}'].get

$.paths['/v1/environments'].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) Environments API
  version: 1.0.0
extends: openapi/knock-app-environments-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/environments/{environment_slug}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an environment by slug
      effect: read
      questions:
      - How do I look up the details of one environment?
      - What settings does my production environment have?
      instructions:
      - text: Get environment {environment_slug}.
        slots:
          environment_slug: path.environment_slug
      - text: Show details for the {environment_slug} environment.
        slots:
          environment_slug: path.environment_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List environments
      effect: read
      questions:
      - Which environments does my Knock account have?
      - In what order are environments returned?
      instructions:
      - text: List all my environments.
      - text: Show the first {limit} environments.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'