Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Destination Authoring Destination testing API

5 actions 5 updates phrasing extends openapi/adobe-suite-destination-testing-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 5

$.info

$.paths['/sample-profiles'].get

$.paths['/testing/template/sample/{DESTINATION_CONFIGURATION_ID}'].get

$.paths['/testing/template/render'].post

$.paths['/testing/destinationInstance/{DESTINATION_INSTANCE_ID}'].post

OpenAPI Overlay

# 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 testing API
  version: 1.0.0
extends: openapi/adobe-suite-destination-testing-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: 4
- target: $.paths['/sample-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: Generate sample profiles for destination testing
      effect: read
      questions:
      - How do I get sample profiles to test my destination's message template?
      - Can I generate a set number of test profiles for a destination instance?
      instructions:
      - text: Generate sample profiles for destination instance {destinationInstanceId}.
        slots:
          destinationInstanceId: query.destinationInstanceId
      - text: Generate {count} sample profiles for destination configuration {destinationId}.
        slots:
          count: query.count
          destinationId: query.destinationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/testing/template/sample/{DESTINATION_CONFIGURATION_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sample message template for a destination
      effect: read
      questions:
      - Where can I get a starting message transformation template for my destination?
      - Can I retrieve a sample template for a destination configuration?
      instructions:
      - text: Get the sample template for destination configuration {DESTINATION_CONFIGURATION_ID}.
        slots:
          DESTINATION_CONFIGURATION_ID: path.DESTINATION_CONFIGURATION_ID
      - text: Show a default message template for destination {DESTINATION_CONFIGURATION_ID}.
        slots:
          DESTINATION_CONFIGURATION_ID: path.DESTINATION_CONFIGURATION_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/testing/template/render'].post
  update:
    x-apievangelist-phrasing:
      intent: Render test profiles through a template
      effect: read
      questions:
      - How do I preview what exported data will look like with my template?
      - Can I render specific profiles against a destination template?
      instructions:
      - text: Render template {template} for destination {destinationId}.
        slots:
          template: requestBody.template
          destinationId: requestBody.destinationId
      - text: Render profiles {profiles} through my template for destination {destinationId}.
        slots:
          profiles: requestBody.profiles
          destinationId: requestBody.destinationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/testing/destinationInstance/{DESTINATION_INSTANCE_ID}'].post
  update:
    x-apievangelist-phrasing:
      intent: Send test messages to a destination's endpoint
      effect: write
      questions:
      - How do I test the connection from my destination to the partner endpoint?
      - What happens if I send a destination test without any profiles?
      instructions:
      - text: Send a test message to destination instance {DESTINATION_INSTANCE_ID}.
        slots:
          DESTINATION_INSTANCE_ID: path.DESTINATION_INSTANCE_ID
      - text: Send profiles {profiles} to destination instance {DESTINATION_INSTANCE_ID} as a test.
        slots:
          profiles: requestBody.profiles
          DESTINATION_INSTANCE_ID: path.DESTINATION_INSTANCE_ID
      method: generated
      generated: '2026-09-26'