Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Sbom Processor API

3 actions 3 updates phrasing extends openapi/harness-sbomprocessor-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['/v1/org/{org}/project/{project}/sbom/process'].post
$.paths['/v1/org/{org}/project/{project}/sbom/enforcement'].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 Processor API
  version: 1.0.0
extends: openapi/harness-sbomprocessor-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['/v1/org/{org}/project/{project}/sbom/process'].post
  update:
    x-apievangelist-phrasing:
      intent: Normalize and ingest a raw SBOM
      effect: write
      questions:
      - How do I turn a raw SBOM into the normalized form used for policy checks?
      - Can I include an attestation when processing an SBOM?
      instructions:
      - text: Process the raw SBOM for artifact {artifact} in {org}/{project}.
        slots:
          artifact: requestBody.artifact
          org: path.org
          project: path.project
      - text: Normalize and inject SBOM {sbom_process} with attestation {attestation}.
        slots:
          sbom_process: requestBody.sbom_process
          attestation: requestBody.attestation
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/{org}/project/{project}/sbom/enforcement'].post
  update:
    x-apievangelist-phrasing:
      intent: Enforce policies on a normalized SBOM
      effect: write
      questions:
      - How do I check an artifact's SBOM against our allow and deny policies?
      - Can I enforce SBOM policy using a specific policy set?
      instructions:
      - text: Enforce SBOM policies for artifact {artifact} as enforcement {enforcement_id} in {org}/{project}.
        slots:
          artifact: requestBody.artifact
          enforcement_id: requestBody.enforcement_id
          org: path.org
          project: path.project
      - text: Run enforcement {enforcement_id} using policy set {policy_set_ref}.
        slots:
          enforcement_id: requestBody.enforcement_id
          policy_set_ref: requestBody.policy_set_ref
      method: generated
      generated: '2026-09-26'