# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for NATS HTTP Gateway KV Management API
  version: 1.0.0
extends: openapi/synadia-communications-kv-management-api-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: 7
- target: $.paths['/kvm/buckets'].get
  update:
    x-apievangelist-phrasing:
      intent: List all key-value stores
      effect: read
      questions:
      - What key-value stores exist on the NATS server?
      - Can I list every KV bucket through the HTTP gateway?
      instructions:
      - text: List all key-value stores.
      - text: Show me every KV store available.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/kvm/buckets/{bucket}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metadata for a key-value store
      effect: read
      questions:
      - How do I see a KV store's history depth, TTL and size?
      - What metadata does a key-value store report?
      instructions:
      - text: Show metadata for KV store {bucket}.
        slots:
          bucket: path.bucket
      - text: Get info about key-value store {bucket}.
        slots:
          bucket: path.bucket
      method: generated
      generated: '2026-10-01'
- target: $.paths['/kvm/buckets/{bucket}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a key-value store
      effect: write
      questions:
      - How do I create a KV store over the HTTP gateway?
      - Can I set a TTL and history depth when adding a key-value store?
      - Which storage type and replica count can a new KV store use?
      instructions:
      - text: Add key-value store {bucket}.
        slots:
          bucket: path.bucket
      - text: Add KV store {bucket} with a TTL of {ttl} and history {history}.
        slots:
          bucket: path.bucket
          ttl: requestBody.ttl
          history: requestBody.history
      - text: Add KV store {bucket} using {storage} storage and {replicas} replicas.
        slots:
          bucket: path.bucket
          storage: requestBody.storage
          replicas: requestBody.replicas
      method: generated
      generated: '2026-10-01'
- target: $.paths['/kvm/buckets/{bucket}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a key-value store entirely
      effect: destructive
      questions:
      - How do I delete a KV store along with all its keys?
      - Is there a way to drop a whole key-value store?
      instructions:
      - text: Delete KV store {bucket} and all its keys.
        slots:
          bucket: path.bucket
      - text: Destroy key-value store {bucket}.
        slots:
          bucket: path.bucket
      method: generated
      generated: '2026-10-01'
- target: $.paths['/kvm/buckets/{bucket}/purge'].delete
  update:
    x-apievangelist-phrasing:
      intent: Purge deleted keys from a KV store
      effect: destructive
      questions:
      - How do I clean up the tombstones of deleted keys in a KV store?
      - Can I purge removed keys while keeping live ones?
      instructions:
      - text: Purge deleted keys from KV store {bucket}.
        slots:
          bucket: path.bucket
      - text: Clean out the tombstones in key-value store {bucket}.
        slots:
          bucket: path.bucket
      method: generated
      generated: '2026-10-01'
- target: $.paths['/kvm/buckets/{bucket}/keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List keys in a KV store
      effect: read
      questions:
      - What keys are in a given key-value store?
      - Can I filter a KV store's keys by a subject-style pattern?
      instructions:
      - text: List the keys in KV store {bucket}.
        slots:
          bucket: path.bucket
      - text: List keys in KV store {bucket} matching {filter}.
        slots:
          bucket: path.bucket
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/kvm/buckets/{bucket}/watch'].get
  update:
    x-apievangelist-phrasing:
      intent: Watch a KV store for changes
      effect: read
      questions:
      - How do I get notified as keys change in a key-value store?
      - Can a watch resume from a specific revision and skip deletes?
      instructions:
      - text: Watch KV store {bucket} for changes.
        slots:
          bucket: path.bucket
      - text: Watch keys matching {filter} in KV store {bucket}.
        slots:
          bucket: path.bucket
          filter: query.filter
      - text: Resume watching KV store {bucket} from revision {revision}.
        slots:
          bucket: path.bucket
          revision: query.resumeRevision
      method: generated
      generated: '2026-10-01'