Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Scorecard API

3 actions 3 updates phrasing extends openapi/harness-scorecard-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}/orchestration/{orchestration-id}/sbom-scorecard'].get

$.paths['/v1/org/{org}/project/{project}/orchestration/{orchestration-id}/sbom-scorecard'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Scorecard API
  version: 1.0.0
extends: openapi/harness-scorecard-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}/orchestration/{orchestration-id}/sbom-scorecard'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the SBOM scorecard for an orchestration
      effect: read
      questions:
      - How good is the quality score of the SBOM from my orchestration run?
      - Where can I see an SBOM's scorecard by category?
      instructions:
      - text: Get the SBOM scorecard for orchestration {orchestration_id} in project {project} of {org}.
        slots:
          orchestration_id: path.orchestration-id
          project: path.project
          org: path.org
      - text: Show the scorecard for SBOM run {orchestration_id}.
        slots:
          orchestration_id: path.orchestration-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/{org}/project/{project}/orchestration/{orchestration-id}/sbom-scorecard'].post
  update:
    x-apievangelist-phrasing:
      intent: Save an SBOM scorecard
      effect: write
      questions:
      - How do I store a computed scorecard for an SBOM?
      - Can I record the average and maximum score for an orchestration's SBOM?
      instructions:
      - text: Save a scorecard for orchestration {orchestration_id} with average score {avg_score} and max score {max_score}.
        slots:
          orchestration_id: path.orchestration-id
          avg_score: requestBody.avg_score
          max_score: requestBody.max_score
      - text: Record scorecard info {score_card_info} for SBOM run {orchestration_id} in {project} of {org}.
        slots:
          score_card_info: requestBody.score_card_info
          orchestration_id: path.orchestration-id
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'