Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Destination Authoring Audience metadata templates API

6 actions 6 updates phrasing extends openapi/adobe-suite-audience-metadata-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['/audience-templates'].get

$.paths['/audience-templates'].post

$.paths['/audience-templates/{INSTANCE_ID}'].get

$.paths['/audience-templates/{INSTANCE_ID}'].put

$.paths['/audience-templates/{INSTANCE_ID}'].delete

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 Audience metadata templates API
  version: 1.0.0
extends: openapi/adobe-suite-audience-metadata-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['/audience-templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List audience metadata templates
      effect: read
      questions:
      - What audience metadata templates exist for my Destination SDK destinations?
      - How do I see all audience templates in my org?
      instructions:
      - text: List all audience templates.
      - text: Show the audience metadata templates in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audience-templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an audience metadata template
      effect: write
      questions:
      - How do I create audience metadata config for a destination built with Destination SDK?
      - Can I add validations that run before calling the partner API?
      instructions:
      - text: Create an audience template with metadata template {metadata}.
        slots:
          metadata: requestBody.metadataTemplate
      - text: Create an audience template using {metadata} and validations {validations}.
        slots:
          metadata: requestBody.metadataTemplate
          validations: requestBody.validations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audience-templates/{INSTANCE_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an audience metadata template
      effect: read
      questions:
      - How do I read one audience template's configuration?
      - What validations are set on a given audience template?
      instructions:
      - text: Show audience template {template}.
        slots:
          template: path.INSTANCE_ID
      - text: Get the configuration of audience template {template}.
        slots:
          template: path.INSTANCE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audience-templates/{INSTANCE_ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an audience metadata template
      effect: write
      questions:
      - How do I replace the config of an existing audience template?
      - Can I change the validations on an audience template?
      instructions:
      - text: Update audience template {template} with metadata template {metadata}.
        slots:
          template: path.INSTANCE_ID
          metadata: requestBody.metadataTemplate
      - text: Replace the validations on audience template {template} with {validations}.
        slots:
          template: path.INSTANCE_ID
          validations: requestBody.validations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audience-templates/{INSTANCE_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an audience metadata template
      effect: destructive
      questions:
      - How do I delete an audience template I no longer need?
      - Can I remove an audience metadata configuration from a destination?
      instructions:
      - text: Delete audience template {template}.
        slots:
          template: path.INSTANCE_ID
      - text: Remove the audience metadata template {template}.
        slots:
          template: path.INSTANCE_ID
      method: generated
      generated: '2026-09-26'