# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Prisma Pulse Streams API
  version: 1.0.0
extends: openapi/prisma-streams-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: 4
- target: $.paths['/streams'].get
  update:
    x-apievangelist-phrasing:
      intent: List active named event streams
      effect: read
      questions:
      - Which named event streams are active in my environment?
      - Where can I see each stream's cursor position?
      instructions:
      - text: List my active event streams.
      - text: Show the status and cursor of every named stream.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/streams'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a resumable event stream for a model
      effect: write
      questions:
      - How do I create a resumable stream of change events for a model?
      - Can a stream only emit events that match a filter?
      instructions:
      - text: Create stream {name} for model {model}.
        slots:
          name: requestBody.name
          model: requestBody.model
      - text: Stream {model} changes matching {filter} under the name {name}.
        slots:
          model: requestBody.model
          filter: requestBody.filter
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/streams/{streamName}/events'].get
  update:
    x-apievangelist-phrasing:
      intent: Consume events from a named stream
      effect: read
      questions:
      - How do I read events from a named stream in order?
      - Does a named stream deliver events at least once?
      instructions:
      - text: Consume events from stream {streamName}.
        slots:
          streamName: path.streamName
      - text: Open a live connection to {streamName} and receive its events.
        slots:
          streamName: path.streamName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/streams/{streamName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a named event stream
      effect: destructive
      questions:
      - What happens to connected consumers when I delete a stream?
      - Can I reuse a stream name after deleting it?
      instructions:
      - text: Delete stream {streamName}.
        slots:
          streamName: path.streamName
      - text: Remove named stream {streamName} and its cursor.
        slots:
          streamName: path.streamName
      method: generated
      generated: '2026-09-26'