Adobe Suite · OpenAPI Overlay 1.0.0

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

8 actions 8 updates phrasing extends openapi/adobe-suite-campaign-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 8

$.info
$.paths['/service/campaigns/{campaignId}/messages/{messageId}/{channel}/variants/{variantId}'].get
$.paths['/service/campaigns'].get
$.paths['/service/campaigns/{campaignId}/versions'].get
$.paths['/service/campaigns/{campaignId}'].get
$.paths['/service/campaigns/{campaignId}/publish/validation'].get
$.paths['/service/campaigns/{campaignId}/packages/{packageId}'].get
$.paths['/service/campaigns/{campaignId}/messages/{messageId}'].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 Campaign Resource API
  version: 1.0.0
extends: openapi/adobe-suite-campaign-resource-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/service/campaigns/{campaignId}/messages/{messageId}/{channel}/variants/{variantId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a channel variant of a campaign message
      effect: read
      questions:
      - How do I fetch one channel-specific variant of a campaign message?
      - Can I read the variant content a campaign message uses on one channel?
      instructions:
      - text: Get variant {variantId} of message {messageId} on channel {channel} in campaign {campaignId}.
        slots:
          variantId: path.variantId
          messageId: path.messageId
          channel: path.channel
          campaignId: path.campaignId
      - text: Show the {channel} variant {variantId} of campaign {campaignId}'s message {messageId}.
        slots:
          channel: path.channel
          variantId: path.variantId
          campaignId: path.campaignId
          messageId: path.messageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/service/campaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: List campaigns
      effect: read
      questions:
      - Which campaigns exist in my sandbox?
      - Can I filter and sort the campaign list and page through it?
      instructions:
      - text: List my campaigns.
      - text: List campaigns filtered by {property}, ordered by {orderby}, {count} per page.
        slots:
          property: query.property
          orderby: query.orderby
          count: query.count
      - text: Show page {page} of campaigns with full details set to {full}.
        slots:
          page: query.page
          full: query.full
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service/campaigns/{campaignId}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a campaign's versions
      effect: read
      questions:
      - What versions has a campaign gone through?
      - Can I page through a campaign's version history?
      instructions:
      - text: List the versions of campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      - text: Show page {page} of campaign {campaignId}'s versions ordered by {orderby}.
        slots:
          page: query.page
          campaignId: path.campaignId
          orderby: query.orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service/campaigns/{campaignId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a campaign's details
      effect: read
      questions:
      - What are the settings and status of one campaign?
      - Can I look up a campaign by its ID?
      instructions:
      - text: Get campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      - text: Show me the details of campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service/campaigns/{campaignId}/publish/validation'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a campaign's publishing validation
      effect: read
      questions:
      - Why won't my campaign publish, and which validation issues are blocking it?
      - Can I list the publishing validation notifications for a campaign?
      instructions:
      - text: Show the publishing validation results for campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      - text: List {count} publish validation notifications for campaign {campaignId}.
        slots:
          count: query.count
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service/campaigns/{campaignId}/packages/{packageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a campaign package's details
      effect: read
      questions:
      - What's inside a package attached to a campaign?
      - Can I look up one campaign package by its ID?
      instructions:
      - text: Get package {packageId} of campaign {campaignId}.
        slots:
          packageId: path.packageId
          campaignId: path.campaignId
      - text: Show the details of campaign {campaignId}'s package {packageId}.
        slots:
          campaignId: path.campaignId
          packageId: path.packageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service/campaigns/{campaignId}/messages/{messageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a campaign message
      effect: read
      questions:
      - How do I read a campaign message as a whole, not a single channel variant?
      - Can I fetch one message of a campaign by its message ID?
      instructions:
      - text: Get message {messageId} from campaign {campaignId}.
        slots:
          messageId: path.messageId
          campaignId: path.campaignId
      - text: Show the full campaign {campaignId} message {messageId} without picking a variant.
        slots:
          campaignId: path.campaignId
          messageId: path.messageId
      method: generated
      generated: '2026-09-26'