Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Orchestration V2 API

5 actions 5 updates phrasing extends openapi/harness-orchestrationv2-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 5

$.info
$.paths['/v1/org/{org}/project/{project}/orchestration/{orchestration-id}/sbom-download'].get
$.paths['/v1/orgs/{org}/projects/{project}/orchestration/{orchestration}/sbom-drift'].post
$.paths['/v1/orgs/{org}/projects/{project}/orchestration/{orchestration-id}/sbom-upload'].post
$.paths['/v1/orgs/{org}/projects/{project}/orchestration/{orchestration-id}'].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 Orchestration V2 API
  version: 1.0.0
extends: openapi/harness-orchestrationv2-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: 4
- target: $.paths['/v1/org/{org}/project/{project}/orchestration/{orchestration-id}/sbom-download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the SBOM for an artifact
      effect: read
      questions:
      - How do I download the software bill of materials generated for an artifact?
      - Can I get the SBOM file from a specific orchestration run?
      instructions:
      - text: Download the SBOM from orchestration {orchestration_id} in project {project} of {org}.
        slots:
          orchestration_id: path.orchestration-id
          project: path.project
          org: path.org
      - text: Get the SBOM file for orchestration run {orchestration_id}.
        slots:
          orchestration_id: path.orchestration-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/orchestration/{orchestration}/sbom-drift'].post
  update:
    x-apievangelist-phrasing:
      intent: Calculate SBOM drift for an orchestration step
      effect: read
      questions:
      - What components changed between this SBOM and a baseline?
      - Can I compare an orchestration step's SBOM against a base to detect drift?
      instructions:
      - text: Calculate SBOM drift for orchestration {orchestration} against base {base}.
        slots:
          orchestration: path.orchestration
          base: requestBody.base
      - text: Compare orchestration {orchestration} in project {project} of {org} to base {base} using variant {variant}.
        slots:
          orchestration: path.orchestration
          project: path.project
          org: path.org
          base: requestBody.base
          variant: requestBody.variant
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/orchestration/{orchestration-id}/sbom-upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an SBOM for an orchestration run
      effect: write
      questions:
      - Can I upload an SBOM I generated elsewhere and attach it to an orchestration run?
      - How do I give an uploaded SBOM a name?
      instructions:
      - text: Upload SBOM {sbom} to orchestration {orchestration_id} with execution context {execution_context}.
        slots:
          sbom: requestBody.sbom
          orchestration_id: path.orchestration-id
          execution_context: requestBody.execution_context
      - text: Attach SBOM {sbom} named {sbom_name} to run {orchestration_id} in project {project} of {org}, context {execution_context}.
        slots:
          sbom: requestBody.sbom
          sbom_name: requestBody.sbom_name
          orchestration_id: path.orchestration-id
          project: path.project
          org: path.org
          execution_context: requestBody.execution_context
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/orchestration/{orchestration-id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Save an SBOM orchestration record
      effect: write
      questions:
      - How do I record an orchestration with its artifact, SBOM metadata and attestation?
      - Can I save the component list together with an orchestration?
      instructions:
      - text: Save orchestration {orchestration_id} for artifact {artifact} with SBOM metadata {sbom_metadata} and attestation {attestation}.
        slots:
          orchestration_id: path.orchestration-id
          artifact: requestBody.artifact
          sbom_metadata: requestBody.sbom_metadata
          attestation: requestBody.attestation
      - text: Record orchestration {id} in {project} of {org} with components {components}, artifact {artifact}, metadata {meta}, attestation {att}.
        slots:
          id: path.orchestration-id
          project: path.project
          org: path.org
          components: requestBody.components
          artifact: requestBody.artifact
          meta: requestBody.sbom_metadata
          att: requestBody.attestation
      method: generated
      generated: '2026-09-26'