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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Harness Orchestration V3 API
version: 1.0.0
extends: openapi/harness-orchestrationv3-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['/v2/orgs/{org}/projects/{project}/orchestration/{orchestration}/sbom-upload'].post
update:
x-apievangelist-phrasing:
intent: Upload an SBOM for an orchestration run
effect: write
questions:
- How do I upload an SBOM file generated during a supply-chain orchestration run?
- Can I name the SBOM I attach to an orchestration?
instructions:
- text: Upload SBOM {sbom} to orchestration {orchestration} in {org}/{project}.
slots:
sbom: requestBody.sbom
orchestration: path.orchestration
org: path.org
project: path.project
- text: Attach SBOM file named {sbom_name} to orchestration {orchestration}.
slots:
sbom_name: requestBody.sbom_name
orchestration: path.orchestration
method: generated
generated: '2026-09-26'
- target: $.paths['/v2/orgs/{org}/projects/{project}/orchestration/{orchestration}'].post
update:
x-apievangelist-phrasing:
intent: Save an SBOM orchestration record
effect: write
questions:
- How is an orchestration's artifact, SBOM metadata and attestation saved?
- Can I include the component list when saving an orchestration?
instructions:
- text: Save orchestration {orchestration} in {org}/{project} for artifact {artifact}.
slots:
orchestration: path.orchestration
org: path.org
project: path.project
artifact: requestBody.artifact
- text: Record attestation {attestation} and SBOM metadata {sbom_metadata} on orchestration {orchestration}.
slots:
attestation: requestBody.attestation
sbom_metadata: requestBody.sbom_metadata
orchestration: path.orchestration
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.