Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Suite Source connections API

9 actions 9 updates phrasing extends openapi/adobe-suite-source-connections-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 9

$.info
$.paths['/sourceConnections'].get
$.paths['/sourceConnections'].post
$.paths['/sourceConnections/{id}'].get
$.paths['/sourceConnections/{id}'].delete
$.paths['/sourceConnections/{SOURCE_CONNECTION_ID}'].get
$.paths['/sourceConnections/{SOURCE_CONNECTION_ID}'].delete
$.paths['/sourceConnections/{SOURCE_CONNECTION_ID}'].patch
$.paths['/sourceConnections/{SOURCE_CONNECTION_ID}/action'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Suite Source connections API
  version: 1.0.0
extends: openapi/adobe-suite-source-connections-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['/sourceConnections'].get
  update:
    x-apievangelist-phrasing:
      intent: List source connections for destinations
      effect: read
      questions:
      - What source connections for destinations exist in my Experience Platform org?
      - Can I limit or sort the list of destination source connections?
      - How do I get a count of source connections along with the list?
      instructions:
      - text: List the source connections for destinations in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show the first {limit} destination source connections sorted by {orderby}.
        slots:
          limit: query.limit
          orderby: query.orderby
      - text: Get the next page of source connections with token {token}.
        slots:
          token: query.continuationToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sourceConnections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a source connection for a destination
      effect: write
      questions:
      - How do I connect the Profile Store or Data Lake as a source for a destination dataflow?
      - What source connection ID do I need before creating a destination dataflow?
      instructions:
      - text: Create a destination source connection in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Set up a Profile Store source connection for my destination.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sourceConnections/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a destination source connection by ID
      effect: read
      questions:
      - How do I view details of one source connection used for destinations?
      - Which connection spec is a given destination source connection using?
      instructions:
      - text: Show destination source connection {id}.
        slots:
          id: path.id
      - text: Get details of destination source connection {id} in sandbox {sandbox}.
        slots:
          id: path.id
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sourceConnections/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a destination source connection
      effect: destructive
      questions:
      - How do I delete a source connection that fed a destination?
      - Can I remove an unused destination source connection from my org?
      instructions:
      - text: Delete destination source connection {id}.
        slots:
          id: path.id
      - text: Remove destination source connection {id} from sandbox {sandbox}.
        slots:
          id: path.id
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sourceConnections/{SOURCE_CONNECTION_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an ingestion source connection
      effect: read
      questions:
      - How do I look up a source connection used to ingest data by its ID?
      - What base connection and data format does my ingestion source connection use?
      instructions:
      - text: Show ingestion source connection {connection}.
        slots:
          connection: path.SOURCE_CONNECTION_ID
      - text: Get the configuration of source connection {connection} for ingestion.
        slots:
          connection: path.SOURCE_CONNECTION_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sourceConnections/{SOURCE_CONNECTION_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an ingestion source connection
      effect: destructive
      questions:
      - How do I delete a source connection that ingests data into Platform?
      - Can I remove a source connection instance I no longer ingest from?
      instructions:
      - text: Delete ingestion source connection {connection}.
        slots:
          connection: path.SOURCE_CONNECTION_ID
      - text: Remove the source connection instance {connection}.
        slots:
          connection: path.SOURCE_CONNECTION_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sourceConnections/{SOURCE_CONNECTION_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a source connection
      effect: write
      questions:
      - How do I update a source connection's name or details?
      - Why does updating a source connection need an etag in the if-match header?
      instructions:
      - text: Update source connection {connection} using etag {etag}.
        slots:
          connection: path.SOURCE_CONNECTION_ID
          etag: header.if-match
      - text: Rename source connection {connection}; its current etag is {etag}.
        slots:
          connection: path.SOURCE_CONNECTION_ID
          etag: header.if-match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sourceConnections/{SOURCE_CONNECTION_ID}/action'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a source connection's state
      effect: write
      questions:
      - How do I move an existing source connection to a different state?
      - Can I trigger a state transition on a source connection?
      instructions:
      - text: Run action {op} on source connection {connection}.
        slots:
          connection: path.SOURCE_CONNECTION_ID
          op: query.op
      - text: Apply the {op} state change to source connection {connection}.
        slots:
          connection: path.SOURCE_CONNECTION_ID
          op: query.op
      method: generated
      generated: '2026-09-26'