Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Compliance Results V2 API

2 actions 2 updates phrasing extends openapi/harness-complianceresultsv2-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 2

$.info
$.paths['/v2/orgs/{org}/projects/{project}/compliance-results'].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 Compliance Results V2 API
  version: 1.0.0
extends: openapi/harness-complianceresultsv2-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: 1
- target: $.paths['/v2/orgs/{org}/projects/{project}/compliance-results'].post
  update:
    x-apievangelist-phrasing:
      intent: Save compliance scan results for a repository
      effect: write
      questions:
      - How do I submit supply chain compliance results for a repository scan?
      - Can I attach compliance results to a specific pipeline execution?
      - What details are needed to save results from a CI/CD platform scan?
      instructions:
      - text: Save {scan_type} compliance results {results} for repo {name} at {url} from {source_platform} in project {project} of {org}.
        slots:
          scan_type: requestBody.scan_type
          results: requestBody.results
          name: requestBody.name
          url: requestBody.url
          source_platform: requestBody.source_platform
          project: path.project
          org: path.org
      - text: Record compliance results {results} for {name} ({url}), scan {scan_type} on {source_platform}, pipeline run {pipeline_execution_identifier}.
        slots:
          results: requestBody.results
          name: requestBody.name
          url: requestBody.url
          scan_type: requestBody.scan_type
          source_platform: requestBody.source_platform
          pipeline_execution_identifier: requestBody.pipeline_execution_identifier
      method: generated
      generated: '2026-09-26'