# 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 Stream API
  version: 1.0.0
extends: openapi/synadia-communications-stream-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/stream/{streamId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a JetStream stream's info
      effect: read
      questions:
      - How do I check a stream's configuration and message count?
      - What state does JetStream report for a single stream?
      instructions:
      - text: Show stream {stream}.
        slots:
          stream: path.streamId
      - text: Get the info for JetStream stream {stream}.
        slots:
          stream: path.streamId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/jetstream/stream/{streamId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a JetStream stream
      effect: destructive
      questions:
      - Can I delete a stream and its stored messages?
      - How do I remove a JetStream stream I don't need?
      instructions:
      - text: Delete stream {stream}.
        slots:
          stream: path.streamId
      - text: Remove JetStream stream {stream}.
        slots:
          stream: path.streamId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/jetstream/stream/{streamId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a JetStream stream's config
      effect: write
      questions:
      - How do I change the subjects an existing stream captures?
      - Can I raise a stream's max age or max bytes after it's created?
      instructions:
      - text: Update stream {stream} to capture subjects {subjects}.
        slots:
          stream: path.streamId
          subjects: requestBody.subjects
      - text: Change stream {stream}'s max age to {max_age} and max bytes to {max_bytes}.
        slots:
          stream: path.streamId
          max_age: requestBody.max_age
          max_bytes: requestBody.max_bytes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/jetstream/stream/{streamId}/consumers'].get
  update:
    x-apievangelist-phrasing:
      intent: List consumers on a stream
      effect: read
      questions:
      - Which consumers are attached to a JetStream stream?
      - Where do I see every consumer reading from a stream?
      instructions:
      - text: List consumers on stream {stream}.
        slots:
          stream: path.streamId
      - text: Show all consumers of JetStream stream {stream}.
        slots:
          stream: path.streamId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/jetstream/stream/{streamId}/consumers/pull'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a pull consumer on a stream
      effect: write
      questions:
      - How do I create a pull consumer so workers fetch messages from a stream?
      - Can a stream pull consumer filter by subjects and cap pending acks?
      instructions:
      - text: Create a pull consumer on stream {stream} with ack policy {ack}, deliver policy {deliver}, replay {replay}, {replicas} replicas.
        slots:
          stream: 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 stream {stream} filtered to {filters}.
        slots:
          stream: path.streamId
          durable: requestBody.durable_name
          filters: requestBody.filter_subjects
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/jetstream/stream/{streamId}/consumers/push'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a push consumer on a stream
      effect: write
      questions:
      - How do I have a stream push messages to a deliver subject?
      - Can a stream push consumer use a queue group for load balancing?
      instructions:
      - text: Create a push consumer on stream {stream} delivering to {subject}.
        slots:
          stream: path.streamId
          subject: requestBody.deliver_subject
      - text: Create a push consumer on stream {stream} for queue group {group}.
        slots:
          stream: path.streamId
          group: requestBody.deliver_group
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/jetstream/stream/{streamId}/purge'].delete
  update:
    x-apievangelist-phrasing:
      intent: Purge all messages from a stream
      effect: destructive
      questions:
      - How do I clear every message out of a stream but keep the stream?
      - Can I wipe a JetStream stream's contents?
      instructions:
      - text: Purge stream {stream}.
        slots:
          stream: path.streamId
      - text: Clear all messages from JetStream stream {stream}.
        slots:
          stream: path.streamId
      method: generated
      generated: '2026-10-01'