Knock · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/knock-app-variables-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/variables/{key}'].get
$.paths['/v1/variables'].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 Knock Management API (mAPI) Variables API
  version: 1.0.0
extends: openapi/knock-app-variables-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/variables/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a variable
      effect: read
      questions:
      - How do I see a variable's value in each environment?
      - Can I look up one variable by its key?
      instructions:
      - text: Get variable {key}.
        slots:
          key: path.key
      - text: Show per-environment values of variable {key}.
        slots:
          key: path.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/variables'].get
  update:
    x-apievangelist-phrasing:
      intent: List variables
      effect: read
      questions:
      - Which variables are defined for my environment?
      - Can I filter variables by type?
      instructions:
      - text: List variables in {environment}.
        slots:
          environment: query.environment
      - text: Show only variables of type {type} for {environment}.
        slots:
          type: query.type
          environment: query.environment
      method: generated
      generated: '2026-10-01'