Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloud Manager Content Sets API

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

$.info
$.paths['/api/program/{programId}/contentSets'].get
$.paths['/api/program/{programId}/contentSets'].post
$.paths['/api/program/{programId}/contentSet/{contentSetId}'].get
$.paths['/api/program/{programId}/contentSet/{contentSetId}'].put
$.paths['/api/program/{programId}/contentSet/{contentSetId}'].delete
$.paths['/api/program/{programId}/contentFlows'].get
$.paths['/api/program/{programId}/environment/{environmentId}/contentFlow'].post
$.paths['/api/program/{programId}/contentFlow/checkCompatibility'].post
$.paths['/api/program/{programId}/contentFlow/{contentFlowId}'].get
$.paths['/api/program/{programId}/contentFlow/{contentFlowId}'].delete
$.paths['/api/program/{programId}/contentFlow/{contentFlowId}/logs'].get
$.paths['/api/program/{programId}/contentFlow/{contentFlowId}/logs/download'].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 Cloud Manager Content Sets API
  version: 1.0.0
extends: openapi/adobe-suite-contentsets-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: 12
- target: $.paths['/api/program/{programId}/contentSets'].get
  update:
    x-apievangelist-phrasing:
      intent: List a program's content sets
      effect: read
      questions:
      - Which content sets are defined for my Cloud Manager program?
      - How do I see every content set I could copy between environments?
      instructions:
      - text: List the content sets for program {programId}.
        slots:
          programId: path.programId
      - text: Show all content sets defined in Cloud Manager program {programId}.
        slots:
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/contentSets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a content set
      effect: write
      questions:
      - How do I define a new content set of asset paths to move between environments?
      - Can I give a content set a name, description and list of included paths?
      instructions:
      - text: Create a content set named {name} in program {programId} including paths {paths}.
        slots:
          name: requestBody.name
          programId: path.programId
          paths: requestBody.paths
      - text: Add content set {name} to program {programId} described as {description}.
        slots:
          name: requestBody.name
          programId: path.programId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/contentSet/{contentSetId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one content set
      effect: read
      questions:
      - Can I see which paths a specific content set includes?
      - What does a single content set look like when fetched by its ID?
      instructions:
      - text: Show me content set {contentSetId} in program {programId}.
        slots:
          contentSetId: path.contentSetId
          programId: path.programId
      - text: Get the included paths of content set {contentSetId} for program {programId}.
        slots:
          contentSetId: path.contentSetId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/contentSet/{contentSetId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a content set
      effect: write
      questions:
      - Can I change the paths included in an existing content set?
      - How do I rename a content set I already created?
      instructions:
      - text: Update content set {contentSetId} in program {programId} to include paths {paths}.
        slots:
          contentSetId: path.contentSetId
          programId: path.programId
          paths: requestBody.paths
      - text: Rename content set {contentSetId} of program {programId} to {name}.
        slots:
          contentSetId: path.contentSetId
          programId: path.programId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/contentSet/{contentSetId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a content set
      effect: destructive
      questions:
      - How do I remove a content set I no longer need?
      - Does deleting a content set need both the program and the set ID?
      instructions:
      - text: Delete content set {contentSetId} from program {programId}.
        slots:
          contentSetId: path.contentSetId
          programId: path.programId
      - text: Remove the content set {contentSetId} in Cloud Manager program {programId}.
        slots:
          contentSetId: path.contentSetId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/contentFlows'].get
  update:
    x-apievangelist-phrasing:
      intent: List a program's content flows
      effect: read
      questions:
      - What content copy runs have happened in my program?
      - Can I page through the history of content flows?
      instructions:
      - text: List the content flows for program {programId}.
        slots:
          programId: path.programId
      - text: Show {limit} content flows for program {programId} starting at {start}.
        slots:
          limit: query.limit
          programId: path.programId
          start: query.start
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/environment/{environmentId}/contentFlow'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy content between environments with a content set
      effect: write
      questions:
      - How do I copy content from production down to a stage or dev environment?
      - Can a content copy include access control lists and page versions?
      - Is it possible to copy content into an environment in a different program?
      instructions:
      - text: Run content set {contentSetId} from environment {environmentId} to {destEnvironmentId} in program {programId}.
        slots:
          contentSetId: requestBody.contentSetId
          environmentId: path.environmentId
          destEnvironmentId: requestBody.destEnvironmentId
          programId: path.programId
      - text: Copy content set {contentSetId} from {environmentId} in program {programId} to the {tier} tier, including ACLs {includeACL}.
        slots:
          contentSetId: requestBody.contentSetId
          environmentId: path.environmentId
          programId: path.programId
          tier: requestBody.tier
          includeACL: requestBody.includeACL
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/contentFlow/checkCompatibility'].post
  update:
    x-apievangelist-phrasing:
      intent: Check two environments are compatible for content copy
      effect: read
      questions:
      - Can I check whether content can flow back from one environment to another before running it?
      - What does the compatibility check between source and target environments return?
      instructions:
      - text: Check content copy compatibility from {sourceEnvironmentId} to {destinationEnvironmentId} in program {programId}.
        slots:
          sourceEnvironmentId: requestBody.sourceEnvironmentId
          destinationEnvironmentId: requestBody.destinationEnvironmentId
          programId: path.programId
      - text: Verify environment {sourceEnvironmentId} can back-flow to {destinationEnvironmentId} on tier {tier} for program {programId}.
        slots:
          sourceEnvironmentId: requestBody.sourceEnvironmentId
          destinationEnvironmentId: requestBody.destinationEnvironmentId
          tier: requestBody.tier
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/contentFlow/{contentFlowId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the status of a content flow
      effect: read
      questions:
      - Has my content copy finished yet?
      - How do I check the details of one specific content flow?
      instructions:
      - text: Show content flow {contentFlowId} in program {programId}.
        slots:
          contentFlowId: path.contentFlowId
          programId: path.programId
      - text: Check the progress of content copy {contentFlowId} for program {programId}.
        slots:
          contentFlowId: path.contentFlowId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/contentFlow/{contentFlowId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running content flow
      effect: destructive
      questions:
      - Can I stop a content copy that is still running?
      - Is cancelling a content flow available only on Cloud Service?
      instructions:
      - text: Cancel content flow {contentFlowId} in program {programId}.
        slots:
          contentFlowId: path.contentFlowId
          programId: path.programId
      - text: Abort the running content copy {contentFlowId} for program {programId}.
        slots:
          contentFlowId: path.contentFlowId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/contentFlow/{contentFlowId}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a content flow's import or export logs
      effect: read
      questions:
      - Where can I read the logs of a content copy to see what failed?
      - Can I view the import logs separately from the export logs?
      instructions:
      - text: Show the {jobType} logs for content flow {contentFlowId} in program {programId}.
        slots:
          jobType: query.jobType
          contentFlowId: path.contentFlowId
          programId: path.programId
      - text: Get log details of the {jobType} step of content copy {contentFlowId}, program {programId}.
        slots:
          jobType: query.jobType
          contentFlowId: path.contentFlowId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/contentFlow/{contentFlowId}/logs/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download content flow log files
      effect: read
      questions:
      - How do I download the log file of a content copy?
      - Can I save the export-side log of a content flow as a file?
      instructions:
      - text: Download the {jobType} log file for content flow {contentFlowId} in program {programId}.
        slots:
          jobType: query.jobType
          contentFlowId: path.contentFlowId
          programId: path.programId
      - text: Save the {jobType} log of content copy {contentFlowId} from program {programId} to disk.
        slots:
          jobType: query.jobType
          contentFlowId: path.contentFlowId
          programId: path.programId
      method: generated
      generated: '2026-09-26'