Knock · OpenAPI Overlay 1.0.0

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

5 actions 5 updates phrasing extends openapi/knock-app-branches-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/branches'].get

$.paths['/v1/branches/{branch_slug}'].get

$.paths['/v1/branches/{branch_slug}'].post

$.paths['/v1/branches/{branch_slug}'].delete

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) Branches API
  version: 1.0.0
extends: openapi/knock-app-branches-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/branches'].get
  update:
    x-apievangelist-phrasing:
      intent: List branches
      effect: read
      questions:
      - Which branches exist, newest commit first?
      - Can I page through all my Knock branches?
      instructions:
      - text: List branches in {environment}.
        slots:
          environment: query.environment
      - text: Show the {limit} most recently committed branches in {environment}.
        slots:
          limit: query.limit
          environment: query.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/branches/{branch_slug}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a branch by slug
      effect: read
      questions:
      - How do I look up the details of one branch?
      - What's the last commit time on a specific branch?
      instructions:
      - text: Get branch {branch_slug} in {environment}.
        slots:
          branch_slug: path.branch_slug
          environment: query.environment
      - text: Show details for the {branch_slug} branch.
        slots:
          branch_slug: path.branch_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/branches/{branch_slug}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a branch off development
      effect: write
      questions:
      - How do I create a new branch off the development environment?
      - Can I name a new branch with my own slug?
      instructions:
      - text: Create branch {branch_slug} in {environment}.
        slots:
          branch_slug: path.branch_slug
          environment: query.environment
      - text: Start a new branch called {branch_slug} off development.
        slots:
          branch_slug: path.branch_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/branches/{branch_slug}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a branch
      effect: destructive
      questions:
      - How do I delete a branch I'm finished with?
      - Can I remove a branch by its slug?
      instructions:
      - text: Delete branch {branch_slug} in {environment}.
        slots:
          branch_slug: path.branch_slug
          environment: query.environment
      - text: Remove the {branch_slug} branch.
        slots:
          branch_slug: path.branch_slug
      method: generated
      generated: '2026-10-01'