Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloud Manager Pipelines API

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

$.info

$.paths['/api/program/{programId}/pipelines'].get

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

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

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

$.paths['/api/program/{programId}/pipeline/{pipelineId}/cache'].delete

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 Pipelines API
  version: 1.0.0
extends: openapi/adobe-suite-pipelines-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: 5
- target: $.paths['/api/program/{programId}/pipelines'].get
  update:
    x-apievangelist-phrasing:
      intent: List a program's pipelines
      effect: read
      questions:
      - Which Cloud Manager pipelines can I access in a program?
      - Can I list only pipelines of a certain type?
      instructions:
      - text: List the pipelines in program {programId}.
        slots:
          programId: path.programId
      - text: Show {type} pipelines in program {programId}.
        slots:
          type: query.type
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/pipeline/{pipelineId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one pipeline
      effect: read
      questions:
      - How do I look up the configuration of a single pipeline?
      - What phases does a specific pipeline have?
      instructions:
      - text: Show pipeline {pipelineId} in program {programId}.
        slots:
          pipelineId: path.pipelineId
          programId: path.programId
      - text: Get the details of pipeline {pipelineId} for program {programId}.
        slots:
          pipelineId: path.pipelineId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/pipeline/{pipelineId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pipeline and its data
      effect: destructive
      questions:
      - How do I delete a pipeline I no longer use?
      - Does deleting a pipeline wipe all of its data?
      instructions:
      - text: Delete pipeline {pipelineId} in program {programId}.
        slots:
          pipelineId: path.pipelineId
          programId: path.programId
      - text: Permanently remove pipeline {pipelineId} from program {programId}.
        slots:
          pipelineId: path.pipelineId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/pipeline/{pipelineId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a pipeline's phases
      effect: write
      questions:
      - How do I change the phases of an existing pipeline?
      - Can I patch a pipeline's settings instead of recreating it?
      instructions:
      - text: Update pipeline {pipelineId} in program {programId} with phases {phases}.
        slots:
          pipelineId: path.pipelineId
          programId: path.programId
          phases: requestBody.phases
      - text: Patch pipeline {pipelineId} for program {programId}.
        slots:
          pipelineId: path.pipelineId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/pipeline/{pipelineId}/cache'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear a pipeline's build cache
      effect: destructive
      questions:
      - How do I reset a pipeline's cached artifacts?
      - Can I empty the build cache when a pipeline keeps using stale output?
      instructions:
      - text: Invalidate the cache of pipeline {pipelineId} in program {programId}.
        slots:
          pipelineId: path.pipelineId
          programId: path.programId
      - text: Clear all cached artifacts for pipeline {pipelineId} in {programId}.
        slots:
          pipelineId: path.pipelineId
          programId: path.programId
      method: generated
      generated: '2026-09-26'