Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Ssca Pipeline View API

3 actions 3 updates phrasing extends openapi/harness-sscapipelineview-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/orgs/{org}/projects/{project}/pipelines/{pipeline}/executions/{execution}/ssca-summary'].get

$.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/executions/{execution}/artifacts'].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 Ssca Pipeline View API
  version: 1.0.0
extends: openapi/harness-sscapipelineview-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/orgs/{org}/projects/{project}/pipelines/{pipeline}/executions/{execution}/ssca-summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the supply chain summary for a run
      effect: read
      questions:
      - What does the supply chain security tab show for a pipeline execution?
      - Can I get SBOM and policy results summarized for one run?
      instructions:
      - text: Show the SSCA summary for execution {execution} of pipeline {pipeline} in {org}/{project}.
        slots:
          execution: path.execution
          pipeline: path.pipeline
          org: path.org
          project: path.project
      - text: Get supply chain results for run {execution} of {pipeline}, project {project}, org {org}.
        slots:
          execution: path.execution
          pipeline: path.pipeline
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/executions/{execution}/artifacts'].post
  update:
    x-apievangelist-phrasing:
      intent: List artifacts produced by a pipeline run
      effect: read
      questions:
      - Which artifacts did a pipeline execution produce?
      - Can I filter a run's artifacts by type or name?
      instructions:
      - text: List artifacts from execution {execution} of pipeline {pipeline} in {org}/{project}.
        slots:
          execution: path.execution
          pipeline: path.pipeline
          org: path.org
          project: path.project
      - text: Find {artifact_type} artifacts matching {search_term} in run {execution} of {pipeline}, project {project}, org {org}.
        slots:
          artifact_type: requestBody.artifact_type
          search_term: requestBody.search_term
          execution: path.execution
          pipeline: path.pipeline
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'