Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Suite Target connections API

9 actions 9 updates phrasing extends openapi/adobe-suite-target-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['/targetConnections'].get
$.paths['/targetConnections'].post
$.paths['/targetConnections/{id}'].get
$.paths['/targetConnections/{id}'].delete
$.paths['/targetConnections/{TARGET_CONNECTION_ID}/action'].post
$.paths['/targetConnections/{TARGET_CONNECTION_ID}'].get
$.paths['/targetConnections/{TARGET_CONNECTION_ID}'].delete
$.paths['/targetConnections/{TARGET_CONNECTION_ID}'].patch

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 Target connections API
  version: 1.0.0
extends: openapi/adobe-suite-target-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['/targetConnections'].get
  update:
    x-apievangelist-phrasing:
      intent: List destination target connections
      effect: read
      questions:
      - Which destination target connections does my Experience Platform org have?
      - Can I sort or limit the list of target connections and get a total count?
      instructions:
      - text: List all target connections in sandbox {x-sandbox-name}.
        slots:
          x-sandbox-name: header.x-sandbox-name
      - text: List target connections sorted by {orderby}, limited to {limit}.
        slots:
          orderby: query.orderby
          limit: query.limit
      - text: Get the next page of target connections using token {continuationToken}.
        slots:
          continuationToken: query.continuationToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/targetConnections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a destination target connection
      effect: write
      questions:
      - How do I set up where exported data will land for a destination?
      - Can I specify the data format when creating a target connection?
      instructions:
      - text: Create a target connection for the destination and data format I describe.
      - text: Set up a new target connection in sandbox {x-sandbox-name} so exports land in my storage location.
        slots:
          x-sandbox-name: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/targetConnections/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Inspect a target connection by ID
      effect: read
      questions:
      - What settings does a specific target connection have?
      - Can I inspect one destination target connection in detail?
      instructions:
      - text: Inspect target connection {id}.
        slots:
          id: path.id
      - text: Show detailed info for destination target connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/targetConnections/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a target connection by ID
      effect: destructive
      questions:
      - Can I remove a destination target connection I no longer export to?
      - What is required to delete a target connection via the id path?
      instructions:
      - text: Delete target connection {id}.
        slots:
          id: path.id
      - text: Remove destination target connection {id} from my org.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/targetConnections/{TARGET_CONNECTION_ID}/action'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a target connection's state
      effect: write
      questions:
      - Can I enable or disable an existing target connection?
      - Which state transition actions can I run on a target connection?
      instructions:
      - text: Perform action {op} on target connection {TARGET_CONNECTION_ID}.
        slots:
          op: query.op
          TARGET_CONNECTION_ID: path.TARGET_CONNECTION_ID
      - text: Transition target connection {TARGET_CONNECTION_ID} using the {op} operation.
        slots:
          TARGET_CONNECTION_ID: path.TARGET_CONNECTION_ID
          op: query.op
      method: generated
      generated: '2026-09-26'
- target: $.paths['/targetConnections/{TARGET_CONNECTION_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a single target connection
      effect: read
      questions:
      - Can I retrieve a single target connection record for a flow service?
      - What does one target connection look like in the flow service?
      instructions:
      - text: Retrieve target connection {TARGET_CONNECTION_ID}.
        slots:
          TARGET_CONNECTION_ID: path.TARGET_CONNECTION_ID
      - text: Get the flow service record for target connection {TARGET_CONNECTION_ID}.
        slots:
          TARGET_CONNECTION_ID: path.TARGET_CONNECTION_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/targetConnections/{TARGET_CONNECTION_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a target connection instance
      effect: destructive
      questions:
      - How do I delete an instance of a target connection from the flow service?
      - Can deleting a target connection instance be undone?
      instructions:
      - text: Delete target connection instance {TARGET_CONNECTION_ID}.
        slots:
          TARGET_CONNECTION_ID: path.TARGET_CONNECTION_ID
      - text: Tear down flow service target connection {TARGET_CONNECTION_ID}.
        slots:
          TARGET_CONNECTION_ID: path.TARGET_CONNECTION_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/targetConnections/{TARGET_CONNECTION_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a target connection
      effect: write
      questions:
      - How do I change settings on an existing target connection?
      - Why does updating a target connection need an if-match version?
      instructions:
      - text: Update target connection {TARGET_CONNECTION_ID} with version {if-match}.
        slots:
          TARGET_CONNECTION_ID: path.TARGET_CONNECTION_ID
          if-match: header.if-match
      - text: Patch target connection {TARGET_CONNECTION_ID} with the changes I list.
        slots:
          TARGET_CONNECTION_ID: path.TARGET_CONNECTION_ID
      method: generated
      generated: '2026-09-26'