Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Destination Authoring Destination servers and templates API

6 actions 6 updates phrasing extends openapi/adobe-suite-destination-servers-and-templates-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['/destination-servers'].get
$.paths['/destination-servers'].post
$.paths['/destination-servers/{INSTANCE_ID}'].get
$.paths['/destination-servers/{INSTANCE_ID}'].put
$.paths['/destination-servers/{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 servers and templates API
  version: 1.0.0
extends: openapi/adobe-suite-destination-servers-and-templates-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['/destination-servers'].get
  update:
    x-apievangelist-phrasing:
      intent: List destination server configurations
      effect: read
      questions:
      - Which destination server configurations exist for my organization?
      - Can I see all the server and template configs I've authored for destinations?
      instructions:
      - text: List all my destination server configurations.
      - text: Show every destination server config in sandbox {x-sandbox-name}.
        slots:
          x-sandbox-name: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/destination-servers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a destination server configuration
      effect: write
      questions:
      - How do I set up a new server and template for a custom destination?
      - Can I register a new destination server configuration through the API?
      instructions:
      - text: Create a destination server configuration from the spec I provide.
      - text: Register a new destination server with my endpoint and template in sandbox {x-sandbox-name}.
        slots:
          x-sandbox-name: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/destination-servers/{INSTANCE_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one destination server configuration
      effect: read
      questions:
      - How do I view the details of a specific destination server config?
      - Can I look up a destination server configuration by its instance ID?
      instructions:
      - text: Show destination server configuration {INSTANCE_ID}.
        slots:
          INSTANCE_ID: path.INSTANCE_ID
      - text: Get the template and endpoint settings for destination server {INSTANCE_ID}.
        slots:
          INSTANCE_ID: path.INSTANCE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/destination-servers/{INSTANCE_ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a destination server configuration
      effect: write
      questions:
      - Can I change the endpoint or template of an existing destination server?
      - What's the call to replace a destination server config with a new payload?
      instructions:
      - text: Update destination server {INSTANCE_ID} with the new payload I give.
        slots:
          INSTANCE_ID: path.INSTANCE_ID
      - text: Change the template on destination server config {INSTANCE_ID}.
        slots:
          INSTANCE_ID: path.INSTANCE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/destination-servers/{INSTANCE_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a destination server configuration
      effect: destructive
      questions:
      - How do I remove a destination server configuration I no longer use?
      - Can I delete a destination server config by instance ID?
      instructions:
      - text: Delete destination server configuration {INSTANCE_ID}.
        slots:
          INSTANCE_ID: path.INSTANCE_ID
      - text: Remove destination server {INSTANCE_ID}.
        slots:
          INSTANCE_ID: path.INSTANCE_ID
      method: generated
      generated: '2026-09-26'