Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Flow Service API - Destinations Base connections API

6 actions 6 updates phrasing extends openapi/adobe-suite-base-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 6

$.info
$.paths['/connections'].get
$.paths['/connections'].post
$.paths['/connections/{id}'].get
$.paths['/connections/{id}'].delete
$.paths['/connections/{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 Flow Service API - Destinations Base connections API
  version: 1.0.0
extends: openapi/adobe-suite-base-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: 5
- target: $.paths['/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List destination base connections
      effect: read
      questions:
      - How do I see all the destination base connections in my organization?
      - Can I get only base connections for one destination type?
      - How many base connections do we have, and how do I page through them?
      instructions:
      - text: List destination base connections in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: List base connections where {property}, up to {limit}.
        slots:
          property: query.property
          limit: query.limit
      - text: Get the next page of base 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 target base connection
      effect: write
      questions:
      - How do I authorize a new connection to a destination?
      - What credentials do I need to create a target base connection?
      instructions:
      - text: Create a target base connection in sandbox {sandbox} with the auth parameters I give you.
        slots:
          sandbox: header.x-sandbox-name
      - text: Authorize a new destination base connection with my credentials.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connections/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a base connection's details
      effect: read
      questions:
      - What configuration does one base connection have?
      - Can I look up a destination connection by its ID?
      instructions:
      - text: Get base connection {id}.
        slots:
          id: path.id
      - text: Show the details of destination connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connections/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a base connection
      effect: destructive
      questions:
      - What's the way to delete a destination base connection?
      - Can I remove a base connection I no longer use?
      instructions:
      - text: Delete base connection {id}.
        slots:
          id: path.id
      - text: Remove destination connection {id} from sandbox {sandbox}.
        slots:
          id: path.id
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connections/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a base connection
      effect: write
      questions:
      - How do I update the credentials on an existing base connection?
      - Can I rename a base connection with a patch?
      instructions:
      - text: 'Patch base connection {id} at etag {if-match}: {op} {path} with {value}.'
        slots:
          id: path.id
          if-match: header.if-match
          op: requestBody.op
          path: requestBody.path
          value: requestBody.value
      - text: Replace the auth params at {path} on connection {id} with {value} using op {op}, etag {if-match}.
        slots:
          path: requestBody.path
          id: path.id
          value: requestBody.value
          op: requestBody.op
          if-match: header.if-match
      method: generated
      generated: '2026-09-26'