# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Knock Tenants API
  version: 1.0.0
extends: openapi/knock-app-tenants-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: 6
- target: $.paths['/v1/tenants/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tenant
      effect: read
      questions:
      - How do I look up a tenant's name and settings?
      - Can I see a tenant's fully resolved preference settings?
      instructions:
      - text: Get tenant {id}.
        slots:
          id: path.id
      - text: Show tenant {id} with resolved preference settings {resolve_full_preference_settings}.
        slots:
          id: path.id
          resolve_full_preference_settings: query.resolve_full_preference_settings
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/tenants/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a tenant
      effect: write
      questions:
      - How do I create a tenant for one of my customer organizations?
      - Are existing tenant properties merged or replaced when I set it?
      instructions:
      - text: Set tenant {id} with name {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update tenant {id}'s settings to {settings}.
        slots:
          id: path.id
          settings: requestBody.settings
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/tenants/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tenant and its data
      effect: destructive
      questions:
      - How do I delete a tenant and everything associated with it?
      - Can a deleted tenant be recovered?
      instructions:
      - text: Delete tenant {id}.
        slots:
          id: path.id
      - text: Permanently remove tenant {id} and its data.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/tenants'].get
  update:
    x-apievangelist-phrasing:
      intent: List tenants
      effect: read
      questions:
      - Which tenants exist in this environment?
      - Can I search tenants by name?
      instructions:
      - text: List all tenants.
      - text: Find tenants named {name}.
        slots:
          name: query.name
      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:
      - How do I delete up to 1,000 tenants in a single request?
      - Is a bulk tenant delete permanent?
      instructions:
      - text: Bulk delete tenants {tenant_ids}.
        slots:
          tenant_ids: query.tenant_ids[]
      - text: 'Permanently remove all of these tenants at once: {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 sync a large batch of tenants in one call?
      - Can I upsert many tenants' names and settings together?
      instructions:
      - text: Bulk set tenants {tenants}.
        slots:
          tenants: requestBody.tenants
      - text: 'Create or update this batch of tenants: {tenants}.'
        slots:
          tenants: requestBody.tenants
      method: generated
      generated: '2026-10-01'