TextQL · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TextQL v2 API Keys API

5 actions 5 updates phrasing extends openapi/textql-api-keys-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for TextQL's API. It is a proposal applied on top of the contract, not a document TextQL publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/v2/api-keys'].get

$.paths['/v2/api-keys'].post

$.paths['/v2/api-keys/{id}/rotate'].post

$.paths['/v2/api-keys/{id}'].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 TextQL v2 API Keys API
  version: 1.0.0
extends: openapi/textql-api-keys-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['/v2/api-keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List platform API keys
      effect: read
      questions:
      - Which TextQL API keys exist in my organization?
      - Can I include revoked keys when listing API keys?
      - Does listing keys ever reveal the secret value?
      instructions:
      - text: List API keys in scope {scope}.
        slots:
          scope: query.scope
      - text: Show my API keys including revoked ones.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/api-keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a role-scoped API key
      effect: write
      questions:
      - How do I mint a new API key limited to certain roles?
      - Can an API key expire automatically after a set time?
      instructions:
      - text: Create an API key named {name} limited to roles {assumedRoles}.
        slots:
          name: requestBody.name
          assumedRoles: requestBody.assumedRoles
      - text: Mint key {name} that inherits all my roles and expires in {expirySeconds} seconds.
        slots:
          name: requestBody.name
          expirySeconds: requestBody.expirySeconds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/api-keys/{id}/rotate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate an API key
      effect: destructive
      questions:
      - How do I replace a leaked API key with a fresh secret but the same scope?
      - Does rotating a key revoke the old secret immediately?
      instructions:
      - text: Rotate API key {id}.
        slots:
          id: path.id
      - text: Swap key {id} for a new secret with the same roles.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/api-keys/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an API key
      effect: destructive
      questions:
      - How do I permanently disable an API key?
      - What happens if I revoke a key that's already revoked?
      instructions:
      - text: Revoke API key {id}.
        slots:
          id: path.id
      - text: Disable key {id} for good.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'