Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Sbom Drift API

4 actions 4 updates phrasing extends openapi/harness-sbomdrift-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 4

$.info
$.paths['/v1/orgs/{org}/projects/{project}/artifact/{artifact}/sbom-drift'].post
$.paths['/v1/orgs/{org}/projects/{project}/sbom-drift/{drift}/components'].get
$.paths['/v1/orgs/{org}/projects/{project}/sbom-drift/{drift}/licenses'].get

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 Drift API
  version: 1.0.0
extends: openapi/harness-sbomdrift-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: 3
- target: $.paths['/v1/orgs/{org}/projects/{project}/artifact/{artifact}/sbom-drift'].post
  update:
    x-apievangelist-phrasing:
      intent: Calculate SBOM drift between two artifact versions
      effect: write
      questions:
      - What changed in the SBOM between two tags of the same image?
      - How long is a calculated SBOM drift kept before it expires?
      instructions:
      - text: Calculate SBOM drift for artifact {artifact} from {base_tag} to {tag} in {org}/{project}.
        slots:
          artifact: path.artifact
          base_tag: requestBody.base_tag
          tag: requestBody.tag
          org: path.org
          project: path.project
      - text: Compare artifact {artifact} tag {tag} against base tag {base_tag} in org {org}, project {project}.
        slots:
          artifact: path.artifact
          tag: requestBody.tag
          base_tag: requestBody.base_tag
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/sbom-drift/{drift}/components'].get
  update:
    x-apievangelist-phrasing:
      intent: List component changes in an SBOM drift
      effect: read
      questions:
      - Which components were added, removed or modified between the two versions?
      - Can I filter SBOM component drift to only added components?
      instructions:
      - text: Show component drift for drift {drift} in {org}/{project}.
        slots:
          drift: path.drift
          org: path.org
          project: path.project
      - text: List {status} components in drift {drift} for {org}/{project}.
        slots:
          status: query.status
          drift: path.drift
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/sbom-drift/{drift}/licenses'].get
  update:
    x-apievangelist-phrasing:
      intent: List license changes in an SBOM drift
      effect: read
      questions:
      - Did any open source licenses change between two builds of the artifact?
      - Can I search the license drift for a specific license name?
      instructions:
      - text: Show license drift for drift {drift} in {org}/{project}.
        slots:
          drift: path.drift
          org: path.org
          project: path.project
      - text: Search license changes in drift {drift} of {org}/{project} for {term}.
        slots:
          drift: path.drift
          org: path.org
          project: path.project
          term: query.search_term
      method: generated
      generated: '2026-09-26'