API Evangelist conversational phrasing for Virto Commerce Event Bus Event Bus module API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Virto Commerce Event Bus Event Bus module API
  version: 1.0.0
extends: openapi/virto-commerce-event-bus-module-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: 12
- target: $.paths['/api/eventbus/connections/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search event bus provider connections
      effect: read
      questions:
      - Which event bus connections are set up in my Virto Commerce platform?
      - Can I find event bus connections that use a particular provider?
      instructions:
      - text: Search event bus connections that use the {provider} provider.
        slots:
          provider: requestBody.providerName
      - text: Find event bus connections named {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/eventbus/connections/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event bus connection by name
      effect: read
      questions:
      - What options is a specific event bus connection configured with?
      - How do I look up a single event bus connection when I know its name?
      instructions:
      - text: Show me the event bus connection called {name}.
        slots:
          name: path.name
      - text: Get the provider and options for connection {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/eventbus/connections/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an event bus connection
      effect: destructive
      questions:
      - Can I remove an event bus connection that was registered in the database?
      - Is it possible to delete a connection that came from configuration rather than the database?
      instructions:
      - text: Delete the event bus connection {name}.
        slots:
          name: path.name
      - text: Remove the database-registered connection named {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/eventbus/connections'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an event bus connection
      effect: write
      questions:
      - How do I change the provider options on an existing event bus connection?
      - Can I switch the provider used by a connection I already registered?
      instructions:
      - text: Update connection {name} to use the {provider} provider.
        slots:
          name: requestBody.name
          provider: requestBody.providerName
      - text: Replace the serialized options on existing connection {name} with {options}.
        slots:
          name: requestBody.name
          options: requestBody.connectionOptionsSerialized
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/eventbus/connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an event bus provider connection
      effect: write
      questions:
      - How can I connect the event bus to a new message provider?
      - What do I need to register a new provider connection in the database?
      instructions:
      - text: Create a new event bus connection {name} using provider {provider}.
        slots:
          name: requestBody.name
          provider: requestBody.providerName
      - text: Register connection {name} with provider {provider} and options {options}.
        slots:
          name: requestBody.name
          provider: requestBody.providerName
          options: requestBody.connectionOptionsSerialized
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/eventbus/logs/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search provider connection failure logs
      effect: read
      questions:
      - Why are events failing to reach my event bus provider?
      - Can I see connection errors logged between two dates?
      instructions:
      - text: Show the failure logs for connection {connection}.
        slots:
          connection: requestBody.providerConnectionName
      - text: Search event bus logs created between {start} and {end}.
        slots:
          start: requestBody.startCreatedDate
          end: requestBody.endCreatedDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/eventbus/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List available domain events
      effect: read
      questions:
      - What domain events can the event bus subscribe to?
      - Which platform events are available to publish to an external provider?
      instructions:
      - text: List all domain events available to the event bus.
      - text: Show the next {take} domain events after skipping {skip}.
        slots:
          take: query.take
          skip: query.skip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/eventbus/subscriptions/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search event bus subscriptions
      effect: read
      questions:
      - Which event subscriptions are sending events through a given connection?
      - Does the subscription search include ones defined in configuration as well as the database?
      instructions:
      - text: Find event subscriptions that use connection {connection}.
        slots:
          connection: requestBody.connectionName
      - text: Search subscriptions that listen for event {eventIds}.
        slots:
          eventIds: requestBody.eventIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/eventbus/subscriptions/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event subscription by name
      effect: read
      questions:
      - What events and filter does a particular subscription use?
      - How do I view one event bus subscription's full settings?
      instructions:
      - text: Show me the event subscription called {name}.
        slots:
          name: path.name
      - text: Get the JSONPath filter and events for subscription {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/eventbus/subscriptions/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an event subscription
      effect: destructive
      questions:
      - How can I stop forwarding events by removing a subscription?
      - Can subscriptions defined in configuration be deleted through the API?
      instructions:
      - text: Delete the event subscription {name}.
        slots:
          name: path.name
      - text: Remove database-registered subscription {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/eventbus/subscriptions'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an event subscription
      effect: write
      questions:
      - Can I change the payload transformation template on an existing subscription?
      - What happens if I add more events to a subscription I already registered?
      instructions:
      - text: Update subscription {name} to use JSONPath filter {filter}.
        slots:
          name: requestBody.name
          filter: requestBody.jsonPathFilter
      - text: Point existing subscription {name} at connection {connection}.
        slots:
          name: requestBody.name
          connection: requestBody.connectionName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/eventbus/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an event bus subscription
      effect: write
      questions:
      - How do I start sending order or product events to my message provider?
      - Can a new subscription transform the event payload before it is sent?
      instructions:
      - text: Create subscription {name} on connection {connection} for events {events}.
        slots:
          name: requestBody.name
          connection: requestBody.connectionName
          events: requestBody.events
      - text: Register a new subscription {name} with payload template {template}.
        slots:
          name: requestBody.name
          template: requestBody.payloadTransformationTemplate
      method: generated
      generated: '2026-09-26'