Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Retrieve & filter Action Campaigns Metadata Resource API

3 actions 3 updates phrasing extends openapi/adobe-suite-metadata-resource-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 3

$.info
$.paths['/service/metadata/surfaces'].get
$.paths['/service/metadata/surfaces/{channel}/{surfaceId}'].get

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 Retrieve & filter Action Campaigns Metadata Resource API
  version: 1.0.0
extends: openapi/adobe-suite-metadata-resource-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: 2
- target: $.paths['/service/metadata/surfaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List channel surfaces
      effect: read
      questions:
      - What surfaces are configured for my messaging channels?
      - Can I filter surfaces by channel, like email or push?
      instructions:
      - text: List the surfaces for channel {channel}.
        slots:
          channel: query.channel
      - text: Show surfaces of type {type} in sandbox {sandbox}.
        slots:
          type: query.type
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service/metadata/surfaces/{channel}/{surfaceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a surface's details
      effect: read
      questions:
      - How do I look up the configuration of one channel surface?
      - What settings does a specific email surface have?
      instructions:
      - text: Show surface {surface} on channel {channel}.
        slots:
          surface: path.surfaceId
          channel: path.channel
      - text: Get details for surface {surface} in channel {channel} of type {type}.
        slots:
          surface: path.surfaceId
          channel: path.channel
          type: query.type
      method: generated
      generated: '2026-09-26'