# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Synadia Control Plane / Synadia Cloud Kv Bucket API
  version: 1.0.0
extends: openapi/synadia-communications-kv-bucket-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['/core/beta/jetstream/kv-bucket/{streamId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a KV bucket's info
      effect: read
      questions:
      - What's the configuration and size of my key-value bucket?
      - Can I view JetStream info for a KV bucket?
      instructions:
      - text: Show KV bucket {streamId}.
        slots:
          streamId: path.streamId
      - text: Get info for key-value bucket {streamId}.
        slots:
          streamId: path.streamId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/jetstream/kv-bucket/{streamId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a KV bucket
      effect: destructive
      questions:
      - Can I delete a key-value bucket entirely?
      - What's the way to remove a KV bucket I no longer need?
      instructions:
      - text: Delete KV bucket {streamId}.
        slots:
          streamId: path.streamId
      - text: Remove key-value bucket {streamId} completely.
        slots:
          streamId: path.streamId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/jetstream/kv-bucket/{streamId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a KV bucket's configuration
      effect: write
      questions:
      - Can I change a KV bucket's history, TTL or size limits after creating it?
      - Is it possible to reconfigure an existing key-value bucket?
      instructions:
      - text: Update KV bucket {streamId} with config {config}.
        slots:
          streamId: path.streamId
          config: requestBody.config
      - text: Apply new configuration {config} to key-value bucket {streamId}.
        slots:
          config: requestBody.config
          streamId: path.streamId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/jetstream/kv-bucket/{streamId}/consumers'].get
  update:
    x-apievangelist-phrasing:
      intent: List consumers on a KV bucket
      effect: read
      questions:
      - Which consumers are reading from my KV bucket?
      - Can I list the consumers attached to a key-value bucket?
      instructions:
      - text: List consumers on KV bucket {streamId}.
        slots:
          streamId: path.streamId
      - text: Show who's consuming KV bucket {streamId}.
        slots:
          streamId: path.streamId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/jetstream/kv-bucket/{streamId}/consumers/pull'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a pull consumer on a KV bucket
      effect: write
      questions:
      - Can I create a pull consumer that fetches changes from a KV bucket in batches?
      - What ack and deliver policies does a KV pull consumer need?
      instructions:
      - text: 'Create pull consumer {durable_name} on KV bucket {streamId}: ack {ack_policy}, deliver {deliver_policy}, replay {replay_policy}, {num_replicas} replicas.'
        slots:
          durable_name: requestBody.durable_name
          streamId: path.streamId
          ack_policy: requestBody.ack_policy
          deliver_policy: requestBody.deliver_policy
          replay_policy: requestBody.replay_policy
          num_replicas: requestBody.num_replicas
      - text: Add a durable pull consumer named {durable_name} to KV bucket {streamId}.
        slots:
          durable_name: requestBody.durable_name
          streamId: path.streamId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/jetstream/kv-bucket/{streamId}/consumers/push'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a push consumer on a KV bucket
      effect: write
      questions:
      - Can KV bucket updates be pushed to a delivery subject automatically?
      - Is it possible to load-balance a KV push consumer across a deliver group?
      instructions:
      - text: 'Add push consumer on KV bucket {streamId} to {deliver_subject}: ack {ack_policy}, deliver {deliver_policy}, replay {replay_policy}, {num_replicas} replicas.'
        slots:
          streamId: path.streamId
          deliver_subject: requestBody.deliver_subject
          ack_policy: requestBody.ack_policy
          deliver_policy: requestBody.deliver_policy
          replay_policy: requestBody.replay_policy
          num_replicas: requestBody.num_replicas
      - text: Push KV bucket {streamId} changes to subject {deliver_subject} for group {deliver_group}.
        slots:
          streamId: path.streamId
          deliver_subject: requestBody.deliver_subject
          deliver_group: requestBody.deliver_group
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/jetstream/kv-bucket/{streamId}/purge'].delete
  update:
    x-apievangelist-phrasing:
      intent: Purge all entries from a KV bucket
      effect: destructive
      questions:
      - Can I wipe every key from a KV bucket but keep the bucket?
      - What's the way to empty a key-value bucket?
      instructions:
      - text: Purge KV bucket {streamId}.
        slots:
          streamId: path.streamId
      - text: Clear all keys out of KV bucket {streamId} without deleting it.
        slots:
          streamId: path.streamId
      method: generated
      generated: '2026-10-01'