# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Pipeline Execution API
  version: 1.0.0
extends: openapi/harness-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: 8
- target: $.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a pipeline with runtime inputs
      effect: write
      questions:
      - How do I trigger a pipeline run from a script?
      - Can I run a pipeline stored in Git from a specific branch?
      - Is it possible to add notes to a pipeline run when I start it?
      instructions:
      - text: Run pipeline {pipeline} in project {project} of org {org}.
        slots:
          pipeline: path.pipeline
          project: path.project
          org: path.org
      - text: Execute pipeline {pipeline} in {org}/{project} from branch {branch}.
        slots:
          pipeline: path.pipeline
          org: path.org
          project: path.project
          branch: query.branch_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/rerun/{execution-id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rerun a previous pipeline execution
      effect: write
      questions:
      - Can I rerun a past pipeline execution from scratch?
      - What's the way to launch a fresh run based on an earlier execution?
      instructions:
      - text: Rerun execution {execution_id} of pipeline {pipeline} in {org}/{project}.
        slots:
          execution_id: path.execution-id
          pipeline: path.pipeline
          org: path.org
          project: path.project
      - text: Start a full rerun of {pipeline} execution {execution_id} in org {org}, project {project} with note {notes}.
        slots:
          pipeline: path.pipeline
          execution_id: path.execution-id
          org: path.org
          project: path.project
          notes: query.notes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/retry/{execution-id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry a failed pipeline execution
      effect: write
      questions:
      - Can I retry only the failed stages of a pipeline run?
      - Is there a way to retry a pipeline and run all stages again?
      instructions:
      - text: Retry failed execution {execution_id} of pipeline {pipeline} in {org}/{project}.
        slots:
          execution_id: path.execution-id
          pipeline: path.pipeline
          org: path.org
          project: path.project
      - text: Retry stages {stages} of {pipeline} execution {execution_id} in org {org}, project {project}.
        slots:
          stages: query.retry_stages
          pipeline: path.pipeline
          execution_id: path.execution-id
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/stages-execution-list'].get
  update:
    x-apievangelist-phrasing:
      intent: List a pipeline's stages and dependencies
      effect: read
      questions:
      - Which stages does a pipeline have, and how do they depend on each other?
      - Can I get the stage identifiers I'd need to run selected stages?
      instructions:
      - text: List the stages of pipeline {pipeline} in {org}/{project}.
        slots:
          pipeline: path.pipeline
          org: path.org
          project: path.project
      - text: Show stage names and dependencies for {pipeline} in org {org}, project {project} on branch {branch}.
        slots:
          pipeline: path.pipeline
          org: path.org
          project: path.project
          branch: query.branch_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/rerun/{execution-id}/stages'].post
  update:
    x-apievangelist-phrasing:
      intent: Rerun selected stages of a past execution
      effect: write
      questions:
      - Can I rerun just a couple of stages from an earlier pipeline execution?
      - How would I re-execute one deploy stage without rerunning the build?
      instructions:
      - text: Rerun stages {stages} from execution {execution_id} of {pipeline} in {org}/{project}.
        slots:
          stages: requestBody.stage_identifiers
          execution_id: path.execution-id
          pipeline: path.pipeline
          org: path.org
          project: path.project
      - text: Re-execute only stage {stages} of past run {execution_id} for pipeline {pipeline}, org {org}, project {project}.
        slots:
          stages: requestBody.stage_identifiers
          execution_id: path.execution-id
          pipeline: path.pipeline
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/dynamic'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a pipeline with a dynamic YAML definition
      effect: write
      questions:
      - Can I execute a pipeline using YAML I generate at runtime?
      - What is dynamic pipeline execution and how do I trigger it?
      instructions:
      - text: Run pipeline {pipeline} in {org}/{project} using dynamic YAML {yaml}.
        slots:
          pipeline: path.pipeline
          org: path.org
          project: path.project
          yaml: requestBody.yaml
      - text: Dynamically execute {pipeline} in org {org}, project {project} and notify only me.
        slots:
          pipeline: path.pipeline
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/execute/stages'].post
  update:
    x-apievangelist-phrasing:
      intent: Run only selected stages of a pipeline
      effect: write
      questions:
      - Can I start a new run that executes only certain stages of a pipeline?
      - Is selective stage execution possible without a previous run?
      instructions:
      - text: Run only stages {stages} of pipeline {pipeline} in {org}/{project}.
        slots:
          stages: requestBody.stage_identifiers
          pipeline: path.pipeline
          org: path.org
          project: path.project
      - text: Start a fresh run of {pipeline} limited to stages {stages} in org {org}, project {project}.
        slots:
          pipeline: path.pipeline
          stages: requestBody.stage_identifiers
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/execute/{pipelineIdentifier}'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a pipeline with input sets (legacy endpoint)
      effect: write
      questions:
      - Can I run a pipeline by referencing saved input sets?
      - Is there an older execute endpoint that takes account, org and project as query parameters?
      instructions:
      - text: Run pipeline {pipeline_id} with input sets {input_sets}.
        slots:
          pipeline_id: path.pipelineIdentifier
          input_sets: requestBody.inputSetReferences
      - text: Use the legacy endpoint to execute {pipeline_id} in account {account}, org {org}, project {project}.
        slots:
          pipeline_id: path.pipelineIdentifier
          account: query.accountIdentifier
          org: query.orgIdentifier
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'