Knock · OpenAPI Overlay 1.0.0

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

2 actions 2 updates phrasing extends openapi/knock-app-templates-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 2

$.info

$.paths['/v1/templates/preview'].post

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) Templates API
  version: 1.0.0
extends: openapi/knock-app-templates-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: 1
- target: $.paths['/v1/templates/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview a template without saving it
      effect: read
      questions:
      - How do I render a notification template for a sample recipient without building a workflow?
      - Can I preview an email template inside a specific layout?
      instructions:
      - text: Preview {channel_type} template {template} for recipient {recipient} in {environment}.
        slots:
          channel_type: requestBody.channel_type
          template: requestBody.template
          recipient: requestBody.recipient
          environment: query.environment
      - text: Render template {template} as {channel_type} for {recipient} with data {data} in {environment}.
        slots:
          template: requestBody.template
          channel_type: requestBody.channel_type
          recipient: requestBody.recipient
          data: requestBody.data
          environment: query.environment
      method: generated
      generated: '2026-10-01'