# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin Portal Event Streaming API
  version: 1.0.0
extends: openapi/strivacity-event-streaming-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: 6
- target: $.paths['/admin/api/v1/instance/eventStreaming'].get
  update:
    x-apievangelist-phrasing:
      intent: List event streaming configurations
      effect: read
      questions:
      - Where are my tenant's events currently being streamed to?
      - Can I search event streaming configurations by name?
      instructions:
      - text: List all event streaming configurations.
      - text: Find the event streaming configuration named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/eventStreaming'].post
  update:
    x-apievangelist-phrasing:
      intent: Set up a new event streaming destination
      effect: write
      questions:
      - How do I start streaming identity events to my SIEM?
      - Can I add another event streaming configuration to my instance?
      instructions:
      - text: Create a new event streaming configuration.
      - text: Add an event stream that sends tenant events to our log pipeline.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/eventStreaming/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event streaming configuration
      effect: read
      questions:
      - How do I see the settings of one event streaming configuration?
      - Which destination does a specific event stream point to?
      instructions:
      - text: Show event streaming configuration {id}.
        slots:
          id: path.id
      - text: Get the details of event stream {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/eventStreaming/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an event streaming configuration
      effect: write
      questions:
      - How do I change where an existing event stream delivers events?
      - Can I edit an event streaming configuration after it's created?
      instructions:
      - text: Update event streaming configuration {id}.
        slots:
          id: path.id
      - text: Change the destination settings of event stream {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/eventStreaming/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an event streaming configuration
      effect: destructive
      questions:
      - How do I stop streaming events to a destination for good?
      - Can I remove an event streaming configuration?
      instructions:
      - text: Delete event streaming configuration {id}.
        slots:
          id: path.id
      - text: Remove event stream {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/eventStreaming/{id}/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test event through an event stream
      effect: write
      questions:
      - How can I check that my event streaming destination actually receives events?
      - Is there a way to fire a test event at an event stream?
      instructions:
      - text: Send a test event to event streaming configuration {id}.
        slots:
          id: path.id
      - text: Test that event stream {id} is delivering.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'