# 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 Connections API
  version: 1.0.0
extends: openapi/adobe-suite-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: 11
- target: $.paths['/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List base connections in the organization
      effect: read
      questions:
      - How do I list all the source base connections in my Experience Platform org?
      - Can I get just a count of connections instead of the full list?
      instructions:
      - text: List my base connections.
      - text: List {limit} base connections sorted by {orderby}.
        slots:
          limit: query.limit
          orderby: query.orderby
      - text: Get the next page of connections using token {continuationToken}.
        slots:
          continuationToken: query.continuationToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a base connection to a source
      effect: write
      questions:
      - How do I create a new base connection for a data source?
      - What connection spec and auth details does a new source connection need?
      instructions:
      - text: Create a base connection named {name} using connection spec {connectionSpec}.
        slots:
          name: requestBody.name
          connectionSpec: requestBody.connectionSpec
      - text: Connect a new source with spec {connectionSpec} and credentials {auth}.
        slots:
          connectionSpec: requestBody.connectionSpec
          auth: requestBody.auth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connections/{BASE_CONNECTION_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single base connection
      effect: read
      questions:
      - How do I look up the details of one base connection?
      - Can I see the connection spec and state of a specific connection?
      instructions:
      - text: Show base connection {BASE_CONNECTION_ID}.
        slots:
          BASE_CONNECTION_ID: path.BASE_CONNECTION_ID
      - text: Get the details for connection {BASE_CONNECTION_ID}.
        slots:
          BASE_CONNECTION_ID: path.BASE_CONNECTION_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connections/{BASE_CONNECTION_ID}/test'].get
  update:
    x-apievangelist-phrasing:
      intent: Test a base connection's connectivity
      effect: read
      questions:
      - How do I check whether an existing source connection can still reach its source?
      - Can I verify a connection's credentials still work?
      instructions:
      - text: Test connectivity for connection {BASE_CONNECTION_ID}.
        slots:
          BASE_CONNECTION_ID: path.BASE_CONNECTION_ID
      - text: Check that base connection {BASE_CONNECTION_ID} is reachable.
        slots:
          BASE_CONNECTION_ID: path.BASE_CONNECTION_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connections/{BASE_CONNECTION_ID}/explore'].get
  update:
    x-apievangelist-phrasing:
      intent: Explore the contents of a source connection
      effect: read
      questions:
      - How do I browse the tables or files available through a source connection?
      - Can I preview a specific file or table path inside a connection?
      instructions:
      - text: Explore the root of connection {BASE_CONNECTION_ID}.
        slots:
          BASE_CONNECTION_ID: path.BASE_CONNECTION_ID
      - text: Explore {objectType} {object} in connection {BASE_CONNECTION_ID}.
        slots:
          objectType: query.objectType
          object: query.object
          BASE_CONNECTION_ID: path.BASE_CONNECTION_ID
      - text: Preview {FileType} file {object} via connection {BASE_CONNECTION_ID}.
        slots:
          FileType: query.FileType
          object: query.object
          BASE_CONNECTION_ID: path.BASE_CONNECTION_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connections/{BASE_CONNECTION_ID}/action'].post
  update:
    x-apievangelist-phrasing:
      intent: Change the state of a base connection
      effect: write
      questions:
      - How do I trigger a state transition action on an existing connection?
      - Can I report progress percentage when performing a connection action?
      instructions:
      - text: Perform action {op} with sub-operation {subOp} on connection {BASE_CONNECTION_ID}.
        slots:
          op: query.op
          subOp: query.subOp
          BASE_CONNECTION_ID: path.BASE_CONNECTION_ID
      - text: Run {op}/{subOp} on connection {BASE_CONNECTION_ID} with status {status}.
        slots:
          op: query.op
          subOp: query.subOp
          BASE_CONNECTION_ID: path.BASE_CONNECTION_ID
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connections/{BASE_CONNECTION_ID}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a base connection
      effect: destructive
      questions:
      - How do I remove a source connection I no longer use?
      - What happens when I delete a base connection?
      instructions:
      - text: Delete base connection {BASE_CONNECTION_ID}.
        slots:
          BASE_CONNECTION_ID: path.BASE_CONNECTION_ID
      - text: Remove the source connection {BASE_CONNECTION_ID}.
        slots:
          BASE_CONNECTION_ID: path.BASE_CONNECTION_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connections/{BASE_CONNECTION_ID}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a base connection's details
      effect: write
      questions:
      - How do I rename a connection or rotate its credentials?
      - Why does updating a connection need an etag in the if-match header?
      instructions:
      - text: Patch connection {BASE_CONNECTION_ID} with {op} at {path} set to {value} using etag {if-match}.
        slots:
          BASE_CONNECTION_ID: path.BASE_CONNECTION_ID
          op: requestBody.op
          path: requestBody.path
          value: requestBody.value
          if-match: header.if-match
      - text: Replace the {path} of connection {BASE_CONNECTION_ID} with {value}.
        slots:
          path: requestBody.path
          BASE_CONNECTION_ID: path.BASE_CONNECTION_ID
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connections/{BASE_CONNECTION_ID}/configs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get property configs for a connection
      effect: read
      questions:
      - How do I see the configuration settings for a connection's properties?
      - Which configs are defined on a particular base connection?
      instructions:
      - text: Get the property configs for connection {BASE_CONNECTION_ID}.
        slots:
          BASE_CONNECTION_ID: path.BASE_CONNECTION_ID
      - text: Show configuration options of connection {BASE_CONNECTION_ID}.
        slots:
          BASE_CONNECTION_ID: path.BASE_CONNECTION_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connections/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search connections by filter criteria
      effect: read
      questions:
      - Can I find connections matching a query string instead of listing them all?
      - How do I search base connections with a filter and sort order?
      instructions:
      - text: Search connections matching {queryString}.
        slots:
          queryString: requestBody.queryString
      - text: Find up to {limit} connections matching {queryString} ordered by {orderby}.
        slots:
          limit: requestBody.limit
          queryString: requestBody.queryString
          orderby: requestBody.orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connection_parameters'].get
  update:
    x-apievangelist-phrasing:
      intent: List connection parameters for the interactive UI
      effect: read
      questions:
      - What connection parameters does the interactive interface use?
      - Where can I get the list of parameters used to set up connections in the UI?
      instructions:
      - text: List the connection parameters for the interactive interface.
      - text: Show connection parameters in sandbox {x-sandbox-name}.
        slots:
          x-sandbox-name: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'