Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Streaming Ingestion API

3 actions 3 updates phrasing extends openapi/adobe-suite-streaming-ingestion-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/collection/{CONNECTION_ID}'].post

$.paths['/collection/batch/{CONNECTION_ID}'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Streaming Ingestion API
  version: 1.0.0
extends: openapi/adobe-suite-streaming-ingestion-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: 2
- target: $.paths['/collection/{CONNECTION_ID}'].post
  update:
    x-apievangelist-phrasing:
      intent: Stream one record into Experience Platform
      effect: write
      questions:
      - How do I send a single event or record to Experience Platform in real time?
      - Can I have the streamed message validated synchronously?
      instructions:
      - text: Send one message with header {header} and body {body} to connection {CONNECTION_ID}.
        slots:
          header: requestBody.header
          body: requestBody.body
          CONNECTION_ID: path.CONNECTION_ID
      - text: Stream a single record to connection {CONNECTION_ID} with synchronous validation {syncValidation}.
        slots:
          CONNECTION_ID: path.CONNECTION_ID
          syncValidation: query.syncValidation
      method: generated
      generated: '2026-09-26'
- target: $.paths['/collection/batch/{CONNECTION_ID}'].post
  update:
    x-apievangelist-phrasing:
      intent: Stream many records in one request
      effect: write
      questions:
      - Can I send multiple streaming messages to Experience Platform in one call?
      - Is the message format the same when batching streamed records?
      instructions:
      - text: Send messages {messages} to connection {CONNECTION_ID} as a batch.
        slots:
          messages: requestBody.messages
          CONNECTION_ID: path.CONNECTION_ID
      - text: Stream a batch of records to streaming connection {CONNECTION_ID}.
        slots:
          CONNECTION_ID: path.CONNECTION_ID
      method: generated
      generated: '2026-09-26'