Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Slsa API

5 actions 5 updates phrasing extends openapi/harness-slsa-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 5

$.info

$.paths['/v1/orgs/{org}/projects/{project}/provenance/{provenance}'].get

$.paths['/v1/orgs/{org}/projects/{project}/provenance/{provenance}'].post

$.paths['/v1/orgs/{org}/projects/{project}/slsa-verification/{provenance}'].post

$.paths['/v1/orgs/{org}/projects/{project}/slsa-verification/{provenance}/policy-violations'].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 Slsa API
  version: 1.0.0
extends: openapi/harness-slsa-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: 4
- target: $.paths['/v1/orgs/{org}/projects/{project}/provenance/{provenance}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get SLSA provenance for an artifact
      effect: read
      questions:
      - What SLSA build provenance was recorded for an artifact?
      - Can I retrieve a stored provenance attestation by its ID?
      instructions:
      - text: Get provenance {provenance} in project {project}, org {org}.
        slots:
          provenance: path.provenance
          project: path.project
          org: path.org
      - text: Show the build attestation {provenance} recorded in {org}/{project}.
        slots:
          provenance: path.provenance
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/provenance/{provenance}'].post
  update:
    x-apievangelist-phrasing:
      intent: Store SLSA provenance for a pipeline build
      effect: write
      questions:
      - Where do I store the SLSA provenance a pipeline step generated?
      - Can I link a stored provenance record to a specific pipeline execution?
      instructions:
      - text: Save provenance {provenance} for artifact {artifact} in {org}/{project}.
        slots:
          provenance: path.provenance
          artifact: requestBody.artifact
          org: path.org
          project: path.project
      - text: Record provenance {provenance} from pipeline execution {execution} in project {project}, org {org}.
        slots:
          provenance: path.provenance
          execution: requestBody.pipeline_execution_id
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/slsa-verification/{provenance}'].post
  update:
    x-apievangelist-phrasing:
      intent: Record the SLSA verification result
      effect: write
      questions:
      - Can I record whether an artifact passed SLSA provenance verification?
      - Can I save the verification status from a specific pipeline step?
      instructions:
      - text: Save SLSA verification status {status} for provenance {provenance} in {org}/{project}.
        slots:
          status: requestBody.verification_status
          provenance: path.provenance
          org: path.org
          project: path.project
      - text: Mark provenance {provenance} as verified for artifact {artifact} in project {project}, org {org}.
        slots:
          provenance: path.provenance
          artifact: requestBody.artifact
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/slsa-verification/{provenance}/policy-violations'].post
  update:
    x-apievangelist-phrasing:
      intent: Record SLSA policy violations
      effect: write
      questions:
      - How do I save the policy violations found when verifying SLSA provenance?
      - Can I attach a list of violated policies to a verification record?
      instructions:
      - text: Save policy violations {violations} for provenance {provenance} in {org}/{project}.
        slots:
          violations: requestBody.violations
          provenance: path.provenance
          org: path.org
          project: path.project
      - text: Record SLSA policy failures with status {status} against provenance {provenance} in project {project}, org {org}.
        slots:
          status: requestBody.status
          provenance: path.provenance
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'