Knock · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Knock App Bulk operations API

5 actions 5 updates phrasing extends openapi/knock-app-bulk-operations-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/bulk_operations/{id}'].get
$.paths['/v1/schedules/bulk/create'].post
$.paths['/v1/tenants/bulk/delete'].post
$.paths['/v1/tenants/bulk/set'].post

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 App Bulk operations API
  version: 1.0.0
extends: openapi/knock-app-bulk-operations-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/bulk_operations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk operation's progress
      effect: read
      questions:
      - How do I check whether a bulk job has finished?
      - What state is my bulk operation in right now?
      instructions:
      - text: Get bulk operation {id}.
        slots:
          id: path.id
      - text: Check the progress of bulk job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/schedules/bulk/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create many schedules at once
      effect: write
      questions:
      - How do I create hundreds of workflow schedules in one request?
      - What's the maximum number of schedules per bulk create?
      instructions:
      - text: 'Bulk create these schedules: {schedules}.'
        slots:
          schedules: requestBody.schedules
      - text: Create up to 1,000 schedules in one batch from {schedules}.
        slots:
          schedules: requestBody.schedules
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/tenants/bulk/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete many tenants at once
      effect: destructive
      questions:
      - Can I delete a large list of tenants in one go?
      - Is bulk tenant deletion reversible?
      instructions:
      - text: Bulk delete tenants {tenant_ids}.
        slots:
          tenant_ids: query.tenant_ids[]
      - text: 'Permanently remove these tenants in one operation: {tenant_ids}.'
        slots:
          tenant_ids: query.tenant_ids[]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/tenants/bulk/set'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update many tenants at once
      effect: write
      questions:
      - How do I upsert up to 1,000 tenants in a single request?
      - Can I update many tenants' properties in bulk?
      instructions:
      - text: 'Bulk set these tenants: {tenants}.'
        slots:
          tenants: requestBody.tenants
      - text: Create or update tenants {tenants} in one batch.
        slots:
          tenants: requestBody.tenants
      method: generated
      generated: '2026-10-01'