Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloud Manager Pipeline Execution API

10 actions 10 updates phrasing extends openapi/adobe-suite-pipeline-execution-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 10

$.info

$.paths['/api/program/{programId}/pipeline/{pipelineId}/execution'].get

$.paths['/api/program/{programId}/pipeline/{pipelineId}/execution'].put

$.paths['/api/program/{programId}/pipeline/{pipelineId}/execution/{executionId}'].get

$.paths['/api/program/{programId}/pipeline/{pipelineId}/execution/{executionId}/phase/{phaseId}/step/{stepId}'].get

$.paths['/api/program/{programId}/pipeline/{pipelineId}/execution/{executionId}/phase/{phaseId}/step/{stepId}/advance'].put

$.paths['/api/program/{programId}/pipeline/{pipelineId}/execution/{executionId}/phase/{phaseId}/step/{stepId}/cancel'].put

$.paths['/api/program/{programId}/pipeline/{pipelineId}/execution/{executionId}/phase/{phaseId}/step/{stepId}/logs'].get

$.paths['/api/program/{programId}/pipeline/{pipelineId}/execution/{executionId}/phase/{phaseId}/step/{stepId}/metrics'].get

$.paths['/api/program/{programId}/pipeline/{pipelineId}/executions'].get

OpenAPI Overlay

# 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 Pipeline Execution API
  version: 1.0.0
extends: openapi/adobe-suite-pipeline-execution-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: 9
- target: $.paths['/api/program/{programId}/pipeline/{pipelineId}/execution'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pipeline's current execution
      effect: read
      questions:
      - Is my Cloud Manager pipeline running right now?
      - What is the in-progress execution for a pipeline, if any?
      instructions:
      - text: Show the current execution of pipeline {pipelineId} in program {programId}.
        slots:
          pipelineId: path.pipelineId
          programId: path.programId
      - text: Check whether pipeline {pipelineId} of program {programId} is running now.
        slots:
          pipelineId: path.pipelineId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/pipeline/{pipelineId}/execution'].put
  update:
    x-apievangelist-phrasing:
      intent: Start a pipeline execution
      effect: write
      questions:
      - How do I kick off a Cloud Manager pipeline run?
      - Can I re-run a pipeline starting from a particular step of an earlier execution?
      - What happens if I try to start a pipeline that is already running?
      instructions:
      - text: Start pipeline {pipelineId} in program {programId}.
        slots:
          pipelineId: path.pipelineId
          programId: path.programId
      - text: Run pipeline {pipelineId} of program {programId} in {pipelineExecutionMode} mode.
        slots:
          pipelineId: path.pipelineId
          programId: path.programId
          pipelineExecutionMode: query.pipelineExecutionMode
      - text: Re-run pipeline {pipelineId} of program {programId} from step {stepId} of execution {sourceExecutionId}.
        slots:
          pipelineId: path.pipelineId
          programId: path.programId
          stepId: query.stepId
          sourceExecutionId: query.sourceExecutionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/pipeline/{pipelineId}/execution/{executionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a specific pipeline execution
      effect: read
      questions:
      - What was the outcome of a past pipeline run?
      - Can I look up a pipeline execution by its execution ID?
      instructions:
      - text: Get execution {executionId} of pipeline {pipelineId} in program {programId}.
        slots:
          executionId: path.executionId
          pipelineId: path.pipelineId
          programId: path.programId
      - text: Show the status of pipeline run {executionId} for pipeline {pipelineId}, program {programId}.
        slots:
          executionId: path.executionId
          pipelineId: path.pipelineId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/pipeline/{pipelineId}/execution/{executionId}/phase/{phaseId}/step/{stepId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the state of a pipeline step
      effect: read
      questions:
      - What state is a particular step of a pipeline run in?
      - Has the build step in my execution finished yet?
      instructions:
      - text: Get the state of step {stepId} in phase {phaseId} of execution {executionId}, pipeline {pipelineId}, program {programId}.
        slots:
          stepId: path.stepId
          phaseId: path.phaseId
          executionId: path.executionId
          pipelineId: path.pipelineId
          programId: path.programId
      - text: Check step {stepId} status for execution {executionId} (program {programId}, pipeline {pipelineId}, phase {phaseId}).
        slots:
          stepId: path.stepId
          executionId: path.executionId
          programId: path.programId
          pipelineId: path.pipelineId
          phaseId: path.phaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/pipeline/{pipelineId}/execution/{executionId}/phase/{phaseId}/step/{stepId}/advance'].put
  update:
    x-apievangelist-phrasing:
      intent: Advance a paused pipeline step
      effect: write
      questions:
      - My pipeline is paused waiting for approval, how do I let it continue?
      - Can I push a pipeline past a step that is waiting for user interaction?
      instructions:
      - text: Advance step {stepId} in phase {phaseId} of execution {executionId}, pipeline {pipelineId}, program {programId}.
        slots:
          stepId: path.stepId
          phaseId: path.phaseId
          executionId: path.executionId
          pipelineId: path.pipelineId
          programId: path.programId
      - text: Approve and continue paused execution {executionId} at step {stepId} (program {programId}, pipeline {pipelineId}, phase {phaseId}).
        slots:
          executionId: path.executionId
          stepId: path.stepId
          programId: path.programId
          pipelineId: path.pipelineId
          phaseId: path.phaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/pipeline/{pipelineId}/execution/{executionId}/phase/{phaseId}/step/{stepId}/cancel'].put
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running pipeline execution
      effect: destructive
      questions:
      - How do I stop a Cloud Manager pipeline run that is in progress?
      - Can I cancel an execution at its current step?
      instructions:
      - text: Cancel execution {executionId} at step {stepId} in phase {phaseId}, pipeline {pipelineId}, program {programId}.
        slots:
          executionId: path.executionId
          stepId: path.stepId
          phaseId: path.phaseId
          pipelineId: path.pipelineId
          programId: path.programId
      - text: Abort pipeline run {executionId} for pipeline {pipelineId} of program {programId} at phase {phaseId} step {stepId}.
        slots:
          executionId: path.executionId
          pipelineId: path.pipelineId
          programId: path.programId
          phaseId: path.phaseId
          stepId: path.stepId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/pipeline/{pipelineId}/execution/{executionId}/phase/{phaseId}/step/{stepId}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get logs for a pipeline step
      effect: read
      questions:
      - Where can I read the build logs for a failed pipeline step?
      - Can I download a specific log file from a step?
      instructions:
      - text: Get the logs for step {stepId} in phase {phaseId} of execution {executionId}, pipeline {pipelineId}, program {programId}.
        slots:
          stepId: path.stepId
          phaseId: path.phaseId
          executionId: path.executionId
          pipelineId: path.pipelineId
          programId: path.programId
      - text: Fetch log file {file} for step {stepId} of execution {executionId} (program {programId}, pipeline {pipelineId}, phase {phaseId}).
        slots:
          file: query.file
          stepId: path.stepId
          executionId: path.executionId
          programId: path.programId
          pipelineId: path.pipelineId
          phaseId: path.phaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/pipeline/{pipelineId}/execution/{executionId}/phase/{phaseId}/step/{stepId}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get quality metrics for a pipeline step
      effect: read
      questions:
      - What code quality or test metrics did a pipeline step report?
      - Can I see the metrics a step produced during a run?
      instructions:
      - text: Show metrics for step {stepId} in phase {phaseId} of execution {executionId}, pipeline {pipelineId}, program {programId}.
        slots:
          stepId: path.stepId
          phaseId: path.phaseId
          executionId: path.executionId
          pipelineId: path.pipelineId
          programId: path.programId
      - text: Get the quality results from step {stepId} of run {executionId} (program {programId}, pipeline {pipelineId}, phase {phaseId}).
        slots:
          stepId: path.stepId
          executionId: path.executionId
          programId: path.programId
          pipelineId: path.pipelineId
          phaseId: path.phaseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/pipeline/{pipelineId}/executions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a pipeline's execution history
      effect: read
      questions:
      - Which runs has this pipeline had, newest first?
      - Can I page through the execution history of a pipeline?
      instructions:
      - text: List executions of pipeline {pipelineId} in program {programId}.
        slots:
          pipelineId: path.pipelineId
          programId: path.programId
      - text: Show the last {limit} runs of pipeline {pipelineId}, program {programId}.
        slots:
          limit: query.limit
          pipelineId: path.pipelineId
          programId: path.programId
      method: generated
      generated: '2026-09-26'