Harness · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Harness Pipelines API
14 actions
14 updates
phrasing
extends
openapi/harness-pipelines-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.
What the actions change
x-apievangelist-phrasing
Targets 14
$.info
$.paths['/v1/orgs/{org}/projects/{project}/pipelines'].get
$.paths['/v1/orgs/{org}/projects/{project}/pipelines'].post
$.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}'].get
$.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}'].put
$.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}'].delete
$.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}'].patch
$.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/validate'].post
$.paths['/v1/orgs/{org}/projects/{project}/pipelines/validate/{uuid}'].get
$.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/move-config'].post
$.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/import'].post
$.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/git-metadata'].put
$.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/inputs-schema'].get
$.paths['/pipeline/api/pipelines'].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 Harness Pipelines API
version: 1.0.0
extends: openapi/harness-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: 13
- target: $.paths['/v1/orgs/{org}/projects/{project}/pipelines'].get
update:
x-apievangelist-phrasing:
intent: List pipelines in a project
effect: read
questions:
- What pipelines exist in my Harness project?
- Can I filter pipelines by service, environment or deployment type?
instructions:
- text: List the pipelines in project {project} of org {org}.
slots:
project: path.project
org: path.org
- text: Find pipelines in {org}/{project} that deploy service {service_names}.
slots:
org: path.org
project: path.project
service_names: query.service_names
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/pipelines'].post
update:
x-apievangelist-phrasing:
intent: Create a pipeline
effect: write
questions:
- How do I create a new pipeline from YAML?
- Can I store a new pipeline in Git when I create it?
instructions:
- text: Create pipeline {name} with identifier {identifier} in {org}/{project} from YAML {pipeline_yaml}.
slots:
name: requestBody.name
identifier: requestBody.identifier
org: path.org
project: path.project
pipeline_yaml: requestBody.pipeline_yaml
- text: Add a new pipeline {identifier} to project {project} in org {org}.
slots:
identifier: requestBody.identifier
project: path.project
org: path.org
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}'].get
update:
x-apievangelist-phrasing:
intent: Get a pipeline
effect: read
questions:
- What does a specific pipeline's YAML look like?
- Can I fetch a pipeline with its templates applied from a given Git branch?
instructions:
- text: Get pipeline {pipeline} in project {project} of org {org}.
slots:
pipeline: path.pipeline
project: path.project
org: path.org
- text: Show pipeline {pipeline} in {org}/{project} from branch {branch_name}.
slots:
pipeline: path.pipeline
org: path.org
project: path.project
branch_name: query.branch_name
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}'].put
update:
x-apievangelist-phrasing:
intent: Replace a pipeline's full definition
effect: write
questions:
- How do I overwrite a pipeline with a completely new YAML?
- Does a full pipeline update require the name and identifier again?
instructions:
- text: Replace pipeline {pipeline} in {org}/{project} with YAML {pipeline_yaml}.
slots:
pipeline: path.pipeline
org: path.org
project: path.project
pipeline_yaml: requestBody.pipeline_yaml
- text: Fully update pipeline {pipeline} in project {project} of org {org}, keeping name {name}.
slots:
pipeline: path.pipeline
project: path.project
org: path.org
name: requestBody.name
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a pipeline
effect: destructive
questions:
- How do I delete a pipeline I no longer need?
- Can a pipeline be removed from a project permanently?
instructions:
- text: Delete pipeline {pipeline} from project {project} in org {org}.
slots:
pipeline: path.pipeline
project: path.project
org: path.org
- text: Remove the {pipeline} pipeline in {org}/{project}.
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}'].patch
update:
x-apievangelist-phrasing:
intent: Partially update a pipeline
effect: write
questions:
- Can I change just a pipeline's name or tags without resending all the YAML?
- Is there a patch operation for pipelines?
instructions:
- text: Patch pipeline {pipeline} in {org}/{project} to rename it {name}.
slots:
pipeline: path.pipeline
org: path.org
project: path.project
name: requestBody.name
- text: Change only the tags of pipeline {pipeline} in project {project} of org {org} to {tags}.
slots:
pipeline: path.pipeline
project: path.project
org: path.org
tags: requestBody.tags
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/validate'].post
update:
x-apievangelist-phrasing:
intent: Start validating a pipeline
effect: write
questions:
- How do I kick off a validation check for a pipeline?
- Can I validate the version of a pipeline stored on a specific Git branch?
instructions:
- text: Start a validation event for pipeline {pipeline} in {org}/{project}.
slots:
pipeline: path.pipeline
org: path.org
project: path.project
- text: Validate pipeline {pipeline} in project {project} of org {org} on branch {branch_name}.
slots:
pipeline: path.pipeline
project: path.project
org: path.org
branch_name: query.branch_name
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/pipelines/validate/{uuid}'].get
update:
x-apievangelist-phrasing:
intent: Get the result of a pipeline validation
effect: read
questions:
- Did my pipeline validation pass?
- Where do I read the outcome of a validation event by its UUID?
instructions:
- text: Get the pipeline validation result for event {uuid} in {org}/{project}.
slots:
uuid: path.uuid
org: path.org
project: path.project
- text: Check the outcome of validation {uuid} in project {project} of org {org}.
slots:
uuid: path.uuid
project: path.project
org: path.org
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/move-config'].post
update:
x-apievangelist-phrasing:
intent: Move a pipeline YAML from inline to Git
effect: write
questions:
- How do I move an inline pipeline into a Git repository?
- Can I convert a pipeline stored in Harness into a remote one?
instructions:
- text: Move pipeline {pipeline} in {org}/{project} to Git using {git_details}.
slots:
pipeline: path.pipeline
org: path.org
project: path.project
git_details: requestBody.git_details
- text: Make inline pipeline {pipeline} in project {project} of org {org} a remote pipeline.
slots:
pipeline: path.pipeline
project: path.project
org: path.org
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/import'].post
update:
x-apievangelist-phrasing:
intent: Import a pipeline YAML from a Git repository
effect: write
questions:
- How do I import a pipeline that already lives in Git?
- Can Harness create a pipeline record from a YAML file in my repo?
instructions:
- text: Import pipeline {pipeline} into {org}/{project} from Git with {git_import_info}.
slots:
pipeline: path.pipeline
org: path.org
project: path.project
git_import_info: requestBody.git_import_info
- text: Fetch pipeline {pipeline} YAML from the repo and save it in project {project} of org {org}.
slots:
pipeline: path.pipeline
project: path.project
org: path.org
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/git-metadata'].put
update:
x-apievangelist-phrasing:
intent: Update Git metadata for a remote pipeline
effect: write
questions:
- How do I repoint a remote pipeline to a different repo or file path?
- Can I change the connector a Git-stored pipeline uses?
instructions:
- text: Point remote pipeline {pipeline} in {org}/{project} at file {file_path} in repo {repo_name}.
slots:
pipeline: path.pipeline
org: path.org
project: path.project
file_path: requestBody.file_path
repo_name: requestBody.repo_name
- text: Set connector {connector_ref} on remote pipeline {pipeline} in project {project} of org {org}.
slots:
connector_ref: requestBody.connector_ref
pipeline: path.pipeline
project: path.project
org: path.org
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/inputs-schema'].get
update:
x-apievangelist-phrasing:
intent: Get a pipeline's runtime inputs schema
effect: read
questions:
- What runtime inputs does a pipeline expect?
- Can I see the input schema of a pipeline stored on a Git branch?
instructions:
- text: Get the inputs schema for pipeline {pipeline} in {org}/{project}.
slots:
pipeline: path.pipeline
org: path.org
project: path.project
- text: Show runtime input details of pipeline {pipeline} in project {project} of org {org} on branch {branch_name}.
slots:
pipeline: path.pipeline
project: path.project
org: path.org
branch_name: query.branch_name
method: generated
generated: '2026-09-26'
- target: $.paths['/pipeline/api/pipelines'].get
update:
x-apievangelist-phrasing:
intent: List pipelines via the pipeline service endpoint
effect: read
questions:
- Is there a simple pipeline-service call that lists a project's pipelines by account, org and project IDs?
- Which pipelines does the older /pipeline/api endpoint return for a project?
instructions:
- text: Using the pipeline service endpoint, list pipelines for account {accountIdentifier}, org {orgIdentifier}, project {projectIdentifier}.
slots:
accountIdentifier: query.accountIdentifier
orgIdentifier: query.orgIdentifier
projectIdentifier: query.projectIdentifier
- text: Call the legacy pipeline list for project {projectIdentifier} in org {orgIdentifier}.
slots:
projectIdentifier: query.projectIdentifier
orgIdentifier: query.orgIdentifier
method: generated
generated: '2026-09-26'