Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Artifact API

6 actions 6 updates phrasing extends openapi/harness-artifact-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 6

$.info
$.paths['/v1/org/{org}/project/{project}/artifacts'].post
$.paths['/v1/org/{org}/project/{project}/grouped-artifacts'].post
$.paths['/v1/org/{org}/project/{project}/artifact/{artifact}/tag/{tag}/components'].post
$.paths['/v1/org/{org}/project/{project}/artifact/{artifact}/tag/{tag}/deployments'].post
$.paths['/v1/org/{org}/project/{project}/artifact/{artifact}/tag/{tag}/details'].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 Artifact API
  version: 1.0.0
extends: openapi/harness-artifact-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: 5
- target: $.paths['/v1/org/{org}/project/{project}/artifacts'].post
  update:
    x-apievangelist-phrasing:
      intent: List all artifact versions in a project
      effect: read
      questions:
      - What artifacts has supply chain security tracked in my project?
      - Can I filter artifacts by license or policy violation?
      instructions:
      - text: List all artifacts in org {org} project {project}.
        slots:
          org: path.org
          project: path.project
      - text: List artifacts in project {project} with policy violation {policy_violation}.
        slots:
          project: path.project
          policy_violation: requestBody.policy_violation
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/{org}/project/{project}/grouped-artifacts'].post
  update:
    x-apievangelist-phrasing:
      intent: List the latest version of each artifact
      effect: read
      questions:
      - What's the newest version of every artifact in my project?
      - Can I see artifacts grouped so only the latest tag shows?
      instructions:
      - text: List the latest version of each artifact in org {org} project {project}.
        slots:
          org: path.org
          project: path.project
      - text: Show grouped artifacts, newest versions only, for project {project}.
        slots:
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/{org}/project/{project}/artifact/{artifact}/tag/{tag}/components'].post
  update:
    x-apievangelist-phrasing:
      intent: List the components inside an artifact tag
      effect: read
      questions:
      - Which open source components are inside this artifact version?
      - Can I filter an artifact's components by package manager or license?
      instructions:
      - text: List components of artifact {artifact} tag {tag} in org {org} project {project}.
        slots:
          org: path.org
          project: path.project
          artifact: path.artifact
          tag: path.tag
      - text: Show {package_manager} components in artifact {artifact}:{tag}.
        slots:
          package_manager: requestBody.package_manager
          artifact: path.artifact
          tag: path.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/{org}/project/{project}/artifact/{artifact}/tag/{tag}/deployments'].post
  update:
    x-apievangelist-phrasing:
      intent: List where an artifact tag is deployed
      effect: read
      questions:
      - Which environments is this artifact version deployed to?
      - Can I see only production deployments of an artifact?
      instructions:
      - text: Show deployments of artifact {artifact} tag {tag} in org {org} project {project}.
        slots:
          org: path.org
          project: path.project
          artifact: path.artifact
          tag: path.tag
      - text: List {environment_type} deployments of artifact {artifact}:{tag}.
        slots:
          environment_type: requestBody.environment_type
          artifact: path.artifact
          tag: path.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/{org}/project/{project}/artifact/{artifact}/tag/{tag}/details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of an artifact tag
      effect: read
      questions:
      - What are the details of a specific artifact version?
      - Can I look up an artifact by name and tag?
      instructions:
      - text: Get details for artifact {artifact} tag {tag} in org {org} project {project}.
        slots:
          org: path.org
          project: path.project
          artifact: path.artifact
          tag: path.tag
      - text: Show artifact {artifact}:{tag} details.
        slots:
          artifact: path.artifact
          tag: path.tag
      method: generated
      generated: '2026-09-26'