Knock · OpenAPI Overlay 1.0.0

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

2 actions 2 updates phrasing extends openapi/knock-app-accounts-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/whoami'].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) Accounts API
  version: 1.0.0
extends: openapi/knock-app-accounts-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/whoami'].get
  update:
    x-apievangelist-phrasing:
      intent: Check which scope my token belongs to
      effect: read
      questions:
      - Which account and scope is my Knock service token tied to?
      - Can I tell whether I'm calling with a service token or an OAuth context?
      instructions:
      - text: Show me who I'm authenticated as right now.
      - text: Verify the calling scope of my current token.
      method: generated
      generated: '2026-10-01'