Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Queued Pipeline Executions API

3 actions 3 updates phrasing extends openapi/harness-queued-pipeline-executions-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Harness's API. It is a proposal applied on top of the contract, not a document Harness publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/pipeline/api/pipelines/queue-management/bulk-abort'].post
$.paths['/pipeline/api/pipelines/queue-management/queued-pipelines'].post

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 Harness Queued Pipeline Executions API
  version: 1.0.0
extends: openapi/harness-queued-pipeline-executions-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: 2
- target: $.paths['/pipeline/api/pipelines/queue-management/bulk-abort'].post
  update:
    x-apievangelist-phrasing:
      intent: Abort several queued pipeline executions
      effect: destructive
      questions:
      - Can I cancel a bunch of queued pipeline runs in one go?
      - Is there a way to clear stuck executions from the pipeline queue?
      instructions:
      - text: Abort queued pipeline executions {ids}.
        slots:
          ids: requestBody.planExecutionIds
      - text: 'Cancel these queued runs in account {account}: {ids}.'
        slots:
          account: query.accountIdentifier
          ids: requestBody.planExecutionIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines/queue-management/queued-pipelines'].post
  update:
    x-apievangelist-phrasing:
      intent: List queued and running pipeline executions
      effect: read
      questions:
      - Which pipeline executions are waiting in the queue right now?
      - Where does a queued run sit in the global queue?
      - Can I list only running pipelines across the account?
      instructions:
      - text: List queued pipeline executions with filter type {type}.
        slots:
          type: requestBody.filterType
      - text: Show queued runs for pipelines {pipelines} with filter type {type}.
        slots:
          pipelines: requestBody.pipelineIdentifiers
          type: requestBody.filterType
      method: generated
      generated: '2026-09-26'