# 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 Details API
  version: 1.0.0
extends: openapi/harness-pipeline-execution-details-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: 17
- target: $.paths['/pipeline/api/pipelines/execution/canRetry/{planExecutionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a pipeline execution can be retried
      effect: read
      questions:
      - Can this failed pipeline run be retried, or do I have to start a fresh execution?
      - Is there a way to validate retry eligibility before I hit retry on a Harness execution?
      instructions:
      - text: Check if execution {execution} in project {project} can be retried.
        slots:
          execution: path.planExecutionId
          project: query.projectIdentifier
      - text: Validate retry eligibility for run {execution} in org {org}, project {project}, account {account}.
        slots:
          execution: path.planExecutionId
          org: query.orgIdentifier
          project: query.projectIdentifier
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/execution/{planExecutionId}/annotations/{contextId}/content'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch the full content of an execution annotation
      effect: read
      questions:
      - How do I read the complete text of an annotation that was truncated in the execution view?
      - Can I pull one annotation's full content by its context ID?
      instructions:
      - text: Get the full annotation content for context {context} on execution {execution} of pipeline {pipeline}.
        slots:
          context: path.contextId
          execution: path.planExecutionId
          pipeline: query.pipelineIdentifier
      - text: Read the complete annotation {context} from run {execution}.
        slots:
          context: path.contextId
          execution: path.planExecutionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/execution/{planExecutionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a pipeline execution
      effect: read
      questions:
      - What happened in a given pipeline run — status, stages and timings?
      - Can I narrow execution details down to a single stage node?
      instructions:
      - text: Show the execution details for pipeline run {execution}.
        slots:
          execution: path.planExecutionId
      - text: Get details for run {execution} focused on stage node {stage}.
        slots:
          execution: path.planExecutionId
          stage: query.stageNodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/execution/v2/{planExecutionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get execution details with child stage graph (v2)
      effect: read
      questions:
      - How do I get execution details that include child stages of a chained pipeline?
      - Can the v2 execution details endpoint render the full bottom graph?
      instructions:
      - text: Get v2 execution details for run {execution} with the full bottom graph rendered.
        slots:
          execution: path.planExecutionId
      - text: Show v2 details of run {execution} for child stage node {child_stage}.
        slots:
          execution: path.planExecutionId
          child_stage: query.childStageNodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/execution/getExecutionGraph/{planExecutionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the node graph of a pipeline execution
      effect: read
      questions:
      - Where can I get the full node-by-node execution graph for a pipeline run?
      - Can I retrieve the execution graph on its own without the rest of the summary?
      instructions:
      - text: Fetch the execution graph for plan execution {execution}.
        slots:
          execution: path.planExecutionId
      - text: Return the graph of nodes for run {execution} in project {project}.
        slots:
          execution: path.planExecutionId
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/execution/subGraph/{planExecutionId}/{nodeExecutionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the subgraph of a retried step group
      effect: read
      questions:
      - How do I see what ran inside a step group that was retried?
      - Can I fetch the subgraph for one retried step group node execution?
      instructions:
      - text: Get the subgraph for retried step group node {node} in execution {execution}.
        slots:
          node: path.nodeExecutionId
          execution: path.planExecutionId
      - text: Show the retried step group {node} breakdown for run {execution}.
        slots:
          node: path.nodeExecutionId
          execution: path.planExecutionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/execution/url'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the UI link to a pipeline execution
      effect: read
      questions:
      - How can I get a shareable link to a pipeline execution in the Harness UI?
      - What URL should I post in chat so teammates can open a specific run?
      instructions:
      - text: Get the execution URL for run {execution} of pipeline {pipeline}.
        slots:
          execution: query.planExecutionId
          pipeline: query.pipelineIdentifier
      - text: Give me a link to open execution {execution} of {pipeline} in project {project}.
        slots:
          execution: query.planExecutionId
          pipeline: query.pipelineIdentifier
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/execution/{planExecutionId}/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metadata of a pipeline execution
      effect: read
      questions:
      - What metadata is stored for a pipeline execution, like who triggered it?
      - Can I get just the execution metadata with only my account ID and the run ID?
      instructions:
      - text: Get the metadata for execution {execution} in account {account}.
        slots:
          execution: path.planExecutionId
          account: query.accountIdentifier
      - text: Show the execution metadata record for run {execution}.
        slots:
          execution: path.planExecutionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/execution/{planExecutionId}/inputsetV2'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the input set YAML used by an execution
      effect: read
      questions:
      - Which runtime inputs were used when this pipeline ran?
      - Can I see the input set YAML for a run with expressions resolved?
      instructions:
      - text: Show the input set YAML used for execution {execution}.
        slots:
          execution: path.planExecutionId
      - text: Get run {execution}'s inputs with expressions resolved in project {project}.
        slots:
          execution: path.planExecutionId
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/execution/{planExecutionId}/policy-evaluation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get policy evaluations for a pipeline execution
      effect: read
      questions:
      - Which OPA policies were evaluated against this pipeline run, and did they pass?
      - Can I page through the policy evaluation results for one execution?
      instructions:
      - text: Show the policy evaluations for execution {execution}.
        slots:
          execution: path.planExecutionId
      - text: List page {page} of the policy results from run {execution}.
        slots:
          page: query.page
          execution: path.planExecutionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/execution/executionSummary'].post
  update:
    x-apievangelist-phrasing:
      intent: List pipeline execution identifiers
      effect: read
      questions:
      - How do I get just the IDs of executions for a pipeline, without the full summaries?
      - Can I pull execution identifiers filtered by a branch or repo?
      instructions:
      - text: List the execution identifiers for pipeline {pipeline} using filter type {filter_type}.
        slots:
          pipeline: query.pipelineIdentifier
          filter_type: requestBody.filterType
      - text: Get execution IDs on branch {branch} with filter type {filter_type}.
        slots:
          branch: query.branch
          filter_type: requestBody.filterType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/execution/summary'].post
  update:
    x-apievangelist-phrasing:
      intent: Search and list pipeline executions
      effect: read
      questions:
      - Which pipeline runs failed in a project this week?
      - Can I filter execution history by status, trigger type or pipeline tags?
      - How do I find only my own deployments in the run history?
      instructions:
      - text: List executions of pipeline {pipeline} with status {status}, filter type {filter_type}.
        slots:
          pipeline: query.pipelineIdentifier
          status: query.status
          filter_type: requestBody.filterType
      - text: Search execution summaries for {term} using filter type {filter_type}.
        slots:
          term: query.searchTerm
          filter_type: requestBody.filterType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/execution/summary/outline'].post
  update:
    x-apievangelist-phrasing:
      intent: List a lightweight outline of executions
      effect: read
      questions:
      - Is there a lighter-weight list of runs I can page through by last seen start time?
      - Can I get an outline of executions for a set of execution IDs?
      instructions:
      - text: Get the execution outline for pipeline {pipeline}.
        slots:
          pipeline: requestBody.pipelineIdentifier
      - text: Continue the execution outline after execution {last_seen}.
        slots:
          last_seen: query.lastSeenExecutionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/execution/{planExecutionId}/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the notes on a pipeline execution
      effect: read
      questions:
      - What notes did someone leave on this pipeline run?
      - Can I read execution notes with only the account and run ID?
      instructions:
      - text: Show the notes on execution {execution}.
        slots:
          execution: path.planExecutionId
      - text: Read the notes left on run {execution} in account {account}.
        slots:
          execution: path.planExecutionId
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/execution/{planExecutionId}/notes'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the notes on a pipeline execution
      effect: write
      questions:
      - How do I add or change a note on a pipeline execution?
      - Can I record why a deployment was rolled back as a note on the run?
      instructions:
      - text: Set the notes on execution {execution} to {notes}.
        slots:
          execution: path.planExecutionId
          notes: query.notesForPipelineExecution
      - text: Replace run {execution}'s note with {notes} in project {project}.
        slots:
          execution: path.planExecutionId
          notes: query.notesForPipelineExecution
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/execution/{planExecutionId}/annotations'].get
  update:
    x-apievangelist-phrasing:
      intent: List annotations on a pipeline execution
      effect: read
      questions:
      - Which annotations were attached to steps during this pipeline run?
      - Can I list all annotations for an execution before opening one in full?
      instructions:
      - text: List the annotations on execution {execution} of pipeline {pipeline}.
        slots:
          execution: path.planExecutionId
          pipeline: query.pipelineIdentifier
      - text: Show every annotation summary for run {execution}.
        slots:
          execution: path.planExecutionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/execution/{planExecutionId}/workflow-graph'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow graph for visualizing an execution
      effect: read
      questions:
      - How do I get a graph of an execution suitable for drawing a visualization?
      - Can I limit the workflow graph to a certain depth under one node?
      instructions:
      - text: Get the workflow visualization graph for execution {execution}.
        slots:
          execution: path.planExecutionId
      - text: Build the workflow graph for run {execution} from node {node} to depth {depth}.
        slots:
          execution: path.planExecutionId
          node: query.nodeExecutionId
          depth: query.depth
      method: generated
      generated: '2026-09-26'