# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Svix Stream API
  version: 1.0.0
extends: openapi/svix-stream-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/api/v1/stream/transformations/simulate'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a stream transformation on sample events
      effect: read
      questions:
      - How do I try out stream transformation code against sample events before deploying it?
      - Can I simulate what a transformation outputs for a given sink type?
      instructions:
      - text: Simulate transformation {code} for sink type {type} on events {events}.
        slots:
          code: requestBody.code
          type: requestBody.type
          events: requestBody.events
      - text: Dry-run this stream transformation code {code} against {events} for a {type} sink.
        slots:
          code: requestBody.code
          events: requestBody.events
          type: requestBody.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/stream'].get
  update:
    x-apievangelist-phrasing:
      intent: List streams
      effect: read
      questions:
      - What streams does my organization have in Svix Stream?
      - Can I page through all of my event streams?
      instructions:
      - text: List all my streams.
      - text: Show the first {limit} streams in my organization.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/stream'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a stream
      effect: write
      questions:
      - How do I set up a new event stream?
      - Can I give a new stream my own uid so I can reference it later?
      instructions:
      - text: Create a stream named {name}.
        slots:
          name: requestBody.name
      - text: Create stream {name} with uid {uid}.
        slots:
          name: requestBody.name
          uid: requestBody.uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/stream/{stream_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stream
      effect: read
      questions:
      - What are the details of a particular stream?
      - Can I look up a stream by its uid?
      instructions:
      - text: Get stream {stream_id}.
        slots:
          stream_id: path.stream_id
      - text: Show the name and metadata of stream {stream_id}.
        slots:
          stream_id: path.stream_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/stream/{stream_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a stream
      effect: write
      questions:
      - How do I upsert a stream so it's created if the id doesn't exist?
      - Can I rename a stream by replacing its record?
      instructions:
      - text: Upsert stream {stream_id} with name {name}.
        slots:
          stream_id: path.stream_id
          name: requestBody.name
      - text: Replace stream {stream_id} with name {name} and metadata {metadata}.
        slots:
          stream_id: path.stream_id
          name: requestBody.name
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/stream/{stream_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a stream
      effect: destructive
      questions:
      - How do I delete a stream I no longer need?
      - Can a deleted stream be recovered?
      instructions:
      - text: Delete stream {stream_id}.
        slots:
          stream_id: path.stream_id
      - text: Permanently remove the stream {stream_id}.
        slots:
          stream_id: path.stream_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/stream/{stream_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a stream
      effect: write
      questions:
      - How do I change just a stream's description?
      - Can I update a stream's metadata without touching its name?
      instructions:
      - text: Set stream {stream_id}'s description to {description}.
        slots:
          stream_id: path.stream_id
          description: requestBody.description
      - text: Patch the metadata on stream {stream_id} to {metadata}.
        slots:
          stream_id: path.stream_id
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/stream/{stream_id}/alert-email'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set a stream's alert email
      effect: write
      questions:
      - Where do alerts about a stream get emailed, and how do I change it?
      - Can I set a different alert email for each stream?
      instructions:
      - text: Send alerts for stream {stream_id} to {email}.
        slots:
          stream_id: path.stream_id
          email: requestBody.email
      - text: Change stream {stream_id}'s alert email to {email}.
        slots:
          stream_id: path.stream_id
          email: requestBody.email
      method: generated
      generated: '2026-09-26'