Knock · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/v1/members/{id}'].get
$.paths['/v1/members/{id}'].delete
$.paths['/v1/members'].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) Members API
  version: 1.0.0
extends: openapi/knock-app-members-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: 3
- target: $.paths['/v1/members/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account member
      effect: read
      questions:
      - How do I look up one teammate on my Knock account?
      - What role does a given member have?
      instructions:
      - text: Get member {id}.
        slots:
          id: path.id
      - text: Show account member {id}'s details.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/members/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from the account
      effect: destructive
      questions:
      - How do I remove someone's access to our account?
      - Can I offboard a teammate by member ID?
      instructions:
      - text: Remove member {id} from the account.
        slots:
          id: path.id
      - text: Revoke account access for member {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List account members
      effect: read
      questions:
      - Who has access to our account?
      - Can I filter account members by role or email?
      instructions:
      - text: List all account members.
      - text: List members with role {role}.
        slots:
          role: query.role
      - text: Find the member with email {email}.
        slots:
          email: query.email
      method: generated
      generated: '2026-10-01'