# 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 Object Bucket API
  version: 1.0.0
extends: openapi/synadia-communications-object-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/object-bucket/{streamId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an object bucket's info
      effect: read
      questions:
      - How do I see the configuration and state of one object store bucket?
      - What info does JetStream report for an object bucket?
      instructions:
      - text: Show object bucket {bucket}.
        slots:
          bucket: path.streamId
      - text: Get JetStream info for object bucket {bucket}.
        slots:
          bucket: path.streamId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/jetstream/object-bucket/{streamId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an object bucket
      effect: destructive
      questions:
      - Can I delete an object store bucket I no longer need?
      - How do I remove an object bucket from JetStream?
      instructions:
      - text: Delete object bucket {bucket}.
        slots:
          bucket: path.streamId
      - text: Remove object store bucket {bucket}.
        slots:
          bucket: path.streamId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/jetstream/object-bucket/{streamId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update or seal an object bucket
      effect: write
      questions:
      - How do I change an existing object bucket's configuration?
      - Can I seal an object bucket so it becomes read-only?
      instructions:
      - text: Update object bucket {bucket} with config {config}.
        slots:
          bucket: path.streamId
          config: requestBody.config
      - text: Seal object bucket {bucket} with config {config} and sealed={sealed}.
        slots:
          bucket: path.streamId
          config: requestBody.config
          sealed: requestBody.sealed
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/jetstream/object-bucket/{streamId}/consumers'].get
  update:
    x-apievangelist-phrasing:
      intent: List consumers on an object bucket
      effect: read
      questions:
      - Which consumers are reading from an object store bucket?
      - Where can I list the consumers attached to an object bucket?
      instructions:
      - text: List consumers on object bucket {bucket}.
        slots:
          bucket: path.streamId
      - text: Show the consumers of object store bucket {bucket}.
        slots:
          bucket: path.streamId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/jetstream/object-bucket/{streamId}/consumers/pull'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a pull consumer on an object bucket
      effect: write
      questions:
      - How do I add a pull consumer to an object store bucket?
      - Can a pull consumer on an object bucket limit its batch size?
      instructions:
      - text: Create a pull consumer on object bucket {bucket} with ack policy {ack}, deliver policy {deliver}, replay {replay}, {replicas} replicas.
        slots:
          bucket: path.streamId
          ack: requestBody.ack_policy
          deliver: requestBody.deliver_policy
          replay: requestBody.replay_policy
          replicas: requestBody.num_replicas
      - text: Add durable pull consumer {durable} to object bucket {bucket}.
        slots:
          bucket: path.streamId
          durable: requestBody.durable_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/jetstream/object-bucket/{streamId}/consumers/push'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a push consumer on an object bucket
      effect: write
      questions:
      - How do I push an object bucket's messages to a deliver subject?
      - Can an object bucket push consumer use flow control and heartbeats?
      instructions:
      - text: Create a push consumer on object bucket {bucket} delivering to {subject}.
        slots:
          bucket: path.streamId
          subject: requestBody.deliver_subject
      - text: Add a push consumer to object bucket {bucket} with ack policy {ack}, deliver policy {deliver}, replay {replay}, {replicas} replicas.
        slots:
          bucket: path.streamId
          ack: requestBody.ack_policy
          deliver: requestBody.deliver_policy
          replay: requestBody.replay_policy
          replicas: requestBody.num_replicas
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/jetstream/object-bucket/{streamId}/purge'].delete
  update:
    x-apievangelist-phrasing:
      intent: Purge all objects from an object bucket
      effect: destructive
      questions:
      - How do I empty an object bucket while keeping the bucket itself?
      - Can I wipe the contents of an object store bucket?
      instructions:
      - text: Purge object bucket {bucket}.
        slots:
          bucket: path.streamId
      - text: Empty all content from object store bucket {bucket}.
        slots:
          bucket: path.streamId
      method: generated
      generated: '2026-10-01'