Knock · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Knock Management API (mAPI) Message types API

5 actions 5 updates phrasing extends openapi/knock-app-message-types-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/message_types/{message_type_key}/validate'].put
$.paths['/v1/message_types/{message_type_key}'].get
$.paths['/v1/message_types/{message_type_key}'].put
$.paths['/v1/message_types'].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) Message types API
  version: 1.0.0
extends: openapi/knock-app-message-types-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/message_types/{message_type_key}/validate'].put
  update:
    x-apievangelist-phrasing:
      intent: Validate a message type without saving
      effect: read
      questions:
      - Can I check a message type payload for errors before saving it?
      - Is there a dry run for message type definitions?
      instructions:
      - text: Validate message type payload {message_type} for {message_type_key} in {environment}.
        slots:
          message_type: requestBody.message_type
          message_type_key: path.message_type_key
          environment: query.environment
      - text: Check message type {message_type_key} definition {message_type} without persisting it in {environment}.
        slots:
          message_type_key: path.message_type_key
          message_type: requestBody.message_type
          environment: query.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/message_types/{message_type_key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a message type by key
      effect: read
      questions:
      - How do I see one message type's schema and variants?
      - Can I fetch a message type as it is on a branch?
      instructions:
      - text: Get message type {message_type_key} in {environment}.
        slots:
          message_type_key: path.message_type_key
          environment: query.environment
      - text: Show the {message_type_key} message type.
        slots:
          message_type_key: path.message_type_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/message_types/{message_type_key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a message type
      effect: write
      questions:
      - How do I create a custom in-app message type?
      - Can I commit a message type change when I save it?
      instructions:
      - text: Upsert message type {message_type_key} in {environment} with {message_type}.
        slots:
          message_type_key: path.message_type_key
          environment: query.environment
          message_type: requestBody.message_type
      - text: Save message type {message_type_key} and commit with message {commit_message} in {environment}.
        slots:
          message_type_key: path.message_type_key
          commit_message: query.commit_message
          environment: query.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/message_types'].get
  update:
    x-apievangelist-phrasing:
      intent: List message types
      effect: read
      questions:
      - Which message types are defined in this environment?
      - Can I page through message types on a branch?
      instructions:
      - text: List message types in {environment}.
        slots:
          environment: query.environment
      - text: Show {limit} message types on branch {branch} in {environment}.
        slots:
          limit: query.limit
          branch: query.branch
          environment: query.environment
      method: generated
      generated: '2026-10-01'