Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness SBOM API

3 actions 3 updates phrasing extends openapi/harness-sbom-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['/gateway/ssca-manager/v1/orgs/{org}/projects/{project}/sbom-download'].post
$.paths['/gateway/ssca-manager/v1/orgs/{org}/projects/{project}/sbom-score'].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 SBOM API
  version: 1.0.0
extends: openapi/harness-sbom-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['/gateway/ssca-manager/v1/orgs/{org}/projects/{project}/sbom-download'].post
  update:
    x-apievangelist-phrasing:
      intent: Download the SBOM for an artifact
      effect: read
      questions:
      - How do I download the software bill of materials for a build artifact?
      - Can I pull an artifact's SBOM for a compliance audit?
      instructions:
      - text: Download the SBOM for artifact {spec} in {org}/{project}.
        slots:
          spec: requestBody.spec
          org: path.org
          project: path.project
      - text: Export the bill of materials for artifact {spec} from org {org}, project {project}.
        slots:
          spec: requestBody.spec
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/ssca-manager/v1/orgs/{org}/projects/{project}/sbom-score'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the SBOM quality score for an artifact
      effect: read
      questions:
      - How complete and high-quality is an artifact's SBOM?
      - Can I get a score for the bill of materials of an image?
      instructions:
      - text: Get the SBOM score for artifact {spec} in {org}/{project}.
        slots:
          spec: requestBody.spec
          org: path.org
          project: path.project
      - text: Rate the quality of the bill of materials for {spec} in org {org}, project {project}.
        slots:
          spec: requestBody.spec
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'