Adobe Experience Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Experience Cloud Adobe Campaign Workflows API

4 actions 4 updates phrasing extends openapi/adobe-experience-cloud-workflows-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Experience Cloud's API. It is a proposal applied on top of the contract, not a document Adobe Experience Cloud publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/campaign/workflow'].get
$.paths['/campaign/workflow/{workflowPKey}'].get
$.paths['/campaign/workflow/{workflowPKey}/commands'].post

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 Adobe Experience Cloud Adobe Campaign Workflows API
  version: 1.0.0
extends: openapi/adobe-experience-cloud-workflows-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: 3
- target: $.paths['/campaign/workflow'].get
  update:
    x-apievangelist-phrasing:
      intent: List Campaign workflows
      effect: read
      questions:
      - Which workflows are configured in Adobe Campaign and what is their status?
      - Can I cap how many workflows are returned?
      instructions:
      - text: List my Campaign workflows.
      - text: Show the first {lineCount} workflows.
        slots:
          lineCount: query._lineCount
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign/workflow/{workflowPKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Campaign workflow
      effect: read
      questions:
      - What activities and execution history does a specific workflow have?
      - Where can I look up one workflow by primary key?
      instructions:
      - text: Show workflow {workflowPKey}.
        slots:
          workflowPKey: path.workflowPKey
      - text: Get the execution history of workflow {workflowPKey}.
        slots:
          workflowPKey: path.workflowPKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign/workflow/{workflowPKey}/commands'].post
  update:
    x-apievangelist-phrasing:
      intent: Start, pause, resume or stop a workflow
      effect: write
      questions:
      - Can I start or pause a Campaign workflow through the API?
      - Which commands can be sent to a running workflow?
      instructions:
      - text: Start workflow {workflowPKey}.
        slots:
          workflowPKey: path.workflowPKey
      - text: Send command {method} to workflow {workflowPKey}.
        slots:
          method: requestBody.method
          workflowPKey: path.workflowPKey
      method: generated
      generated: '2026-10-01'