Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Simulation Campaign Proof API

3 actions 3 updates phrasing extends openapi/adobe-suite-campaign-proof-api-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['/campaigns/{campaignId}/proofs'].post
$.paths['/campaigns/{campaignId}/proofs/{proofJobId}'].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 Simulation Campaign Proof API
  version: 1.0.0
extends: openapi/adobe-suite-campaign-proof-api-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['/campaigns/{campaignId}/proofs'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a proof of a campaign
      effect: write
      questions:
      - How do I send a test proof of a Journey Optimizer campaign before launch?
      - Can I choose which recipients get the campaign proof?
      instructions:
      - text: Send a proof of campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      - text: Trigger a proof of campaign {campaignId} to {recipients}.
        slots:
          campaignId: path.campaignId
          recipients: requestBody.recipients
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{campaignId}/proofs/{proofJobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a campaign proof job's status
      effect: read
      questions:
      - Has my campaign proof finished sending?
      - How do I check the status of a proof job?
      instructions:
      - text: Check proof job {proofJobId} for campaign {campaignId}.
        slots:
          proofJobId: path.proofJobId
          campaignId: path.campaignId
      - text: Get the status of campaign {campaignId} proof {proofJobId}.
        slots:
          campaignId: path.campaignId
          proofJobId: path.proofJobId
      method: generated
      generated: '2026-09-26'