Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Destination Authoring Destination configurations API

6 actions 6 updates phrasing extends openapi/adobe-suite-destination-configurations-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['/destinations'].get
$.paths['/destinations'].post
$.paths['/destinations/{INSTANCE_ID}'].get
$.paths['/destinations/{INSTANCE_ID}'].put
$.paths['/destinations/{INSTANCE_ID}'].delete

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 Destination Authoring Destination configurations API
  version: 1.0.0
extends: openapi/adobe-suite-destination-configurations-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['/destinations'].get
  update:
    x-apievangelist-phrasing:
      intent: List destination configurations
      effect: read
      questions:
      - How do I see every destination configuration in my IMS organization?
      - Which destinations have I configured in a given sandbox?
      instructions:
      - text: List the destination configurations in sandbox {x-sandbox-name}.
        slots:
          x-sandbox-name: header.x-sandbox-name
      - text: Show all destination configs for org {x-gw-ims-org-id} in sandbox {x-sandbox-name}.
        slots:
          x-gw-ims-org-id: header.x-gw-ims-org-id
          x-sandbox-name: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/destinations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a destination configuration
      effect: write
      questions:
      - How do I set up a new destination with Adobe Destination SDK?
      - Can I configure batch delivery and identity namespaces when creating a destination?
      instructions:
      - text: Create a destination configuration named {name} in sandbox {x-sandbox-name}.
        slots:
          name: requestBody.name
          x-sandbox-name: header.x-sandbox-name
      - text: Create destination {name} described as {description} with batch configuration {batchConfiguration}.
        slots:
          name: requestBody.name
          description: requestBody.description
          batchConfiguration: requestBody.batchConfiguration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/destinations/{INSTANCE_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a destination configuration
      effect: read
      questions:
      - How do I view the full settings of one destination configuration?
      - Can I read a destination config by its instance ID?
      instructions:
      - text: Show destination configuration {INSTANCE_ID}.
        slots:
          INSTANCE_ID: path.INSTANCE_ID
      - text: Get destination {INSTANCE_ID} from sandbox {x-sandbox-name}.
        slots:
          INSTANCE_ID: path.INSTANCE_ID
          x-sandbox-name: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/destinations/{INSTANCE_ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a destination configuration
      effect: write
      questions:
      - How do I change an existing destination's configuration?
      - Can I rename or change the status of a destination I already created?
      instructions:
      - text: Update destination {INSTANCE_ID} with my revised payload.
        slots:
          INSTANCE_ID: path.INSTANCE_ID
      - text: Set destination {INSTANCE_ID}'s name to {name} and status to {status}.
        slots:
          INSTANCE_ID: path.INSTANCE_ID
          name: requestBody.name
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/destinations/{INSTANCE_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a destination configuration
      effect: destructive
      questions:
      - How do I remove a destination configuration I no longer use?
      - What ID do I need to delete a destination config?
      instructions:
      - text: Delete destination configuration {INSTANCE_ID}.
        slots:
          INSTANCE_ID: path.INSTANCE_ID
      - text: Remove destination {INSTANCE_ID} from sandbox {x-sandbox-name}.
        slots:
          INSTANCE_ID: path.INSTANCE_ID
          x-sandbox-name: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'