Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Artifacts API

17 actions 17 updates phrasing extends openapi/harness-artifacts-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 17 · first 16 shown; the file carries all of them

$.info

$.paths['/har/api/v1/registry/{registry_identifier}/artifact/{artifact}/redirect'].get

$.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}'].delete

$.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/labels'].put

$.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/stats'].get

$.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/summary'].get

$.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/tags'].get

$.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}'].delete

$.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/bulk-download'].get

$.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/deploymentdetails'].get

$.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/details'].get

$.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/file/{file_name}'].get

$.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/files'].get

$.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/summary'].get

$.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/versions'].get

$.paths['/har/api/v1/registry/{registry_ref}/artifact/labels'].get

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 Artifacts API
  version: 1.0.0
extends: openapi/harness-artifacts-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: 16
- target: $.paths['/har/api/v1/registry/{registry_identifier}/artifact/{artifact}/redirect'].get
  update:
    x-apievangelist-phrasing:
      intent: Open an artifact's page in the registry UI
      effect: read
      questions:
      - Is there a link that redirects straight to an artifact's page in Harness Artifact Registry?
      - Can I jump to the UI page for a particular version of an artifact?
      instructions:
      - text: Redirect me to the page for artifact {artifact} in registry {registry}.
        slots:
          artifact: path.artifact
          registry: path.registry_identifier
      - text: Open the registry page for {artifact} version {version} in {registry}.
        slots:
          artifact: path.artifact
          version: query.version
          registry: path.registry_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an artifact and all its versions
      effect: destructive
      questions:
      - How do I delete an entire artifact from a Harness registry?
      - Can I remove a package along with every version it has?
      instructions:
      - text: Delete artifact {artifact} from registry {registry}.
        slots:
          artifact: path.artifact
          registry: path.registry_ref
      - text: Remove the whole {artifact} package, all versions, from {registry}.
        slots:
          artifact: path.artifact
          registry: path.registry_ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/labels'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the labels on an artifact
      effect: write
      questions:
      - How do I add or change labels on an artifact in my registry?
      - Can I replace an artifact's labels in one request?
      instructions:
      - text: Set the labels on artifact {artifact} in {registry} to {labels}.
        slots:
          artifact: path.artifact
          registry: path.registry_ref
          labels: requestBody.labels
      - text: Label {artifact} in registry {registry} as {labels}.
        slots:
          artifact: path.artifact
          registry: path.registry_ref
          labels: requestBody.labels
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get download and usage stats for one artifact
      effect: read
      questions:
      - How many downloads has a specific artifact had over a date range?
      - What are the usage stats for one package in my registry?
      instructions:
      - text: Get stats for artifact {artifact} in {registry} from {from} to {to}.
        slots:
          artifact: path.artifact
          registry: path.registry_ref
          from: query.from
          to: query.to
      - text: Show usage statistics for the {artifact} artifact in registry {registry}.
        slots:
          artifact: path.artifact
          registry: path.registry_ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a summary of an artifact
      effect: read
      questions:
      - What's the overview of an artifact, like its type and latest version?
      - Can I get a quick summary of a package across all its versions?
      instructions:
      - text: Summarize artifact {artifact} in registry {registry}.
        slots:
          artifact: path.artifact
          registry: path.registry_ref
      - text: Give me the artifact-level summary for {artifact} of type {type} in {registry}.
        slots:
          artifact: path.artifact
          type: query.artifact_type
          registry: path.registry_ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List tags of an OCI image
      effect: read
      questions:
      - Which tags exist for a container image in my Harness registry?
      - Can I search an OCI artifact's tags by name?
      instructions:
      - text: List the OCI tags for image {artifact} in registry {registry}.
        slots:
          artifact: path.artifact
          registry: path.registry_ref
      - text: Find tags on image {artifact} in {registry} matching {term}.
        slots:
          artifact: path.artifact
          registry: path.registry_ref
          term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one version of an artifact
      effect: destructive
      questions:
      - How do I delete a single version of a package without removing the others?
      - Can I remove one bad release of an artifact from the registry?
      instructions:
      - text: Delete version {version} of artifact {artifact} in {registry}.
        slots:
          version: path.version
          artifact: path.artifact
          registry: path.registry_ref
      - text: Remove only release {version} of {artifact} from registry {registry}.
        slots:
          version: path.version
          artifact: path.artifact
          registry: path.registry_ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/bulk-download'].get
  update:
    x-apievangelist-phrasing:
      intent: Request a bulk download of an artifact version
      effect: write
      questions:
      - Can I download all the files of an artifact version in one bulk request?
      - How do I start a bulk download for a specific package version?
      instructions:
      - text: Create a bulk download request for {artifact} version {version} in {registry}.
        slots:
          artifact: path.artifact
          version: path.version
          registry: path.registry_ref
      - text: Start a bulk download of every file in {artifact}:{version} from registry {registry}.
        slots:
          artifact: path.artifact
          version: path.version
          registry: path.registry_ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/deploymentdetails'].get
  update:
    x-apievangelist-phrasing:
      intent: See where an artifact version is deployed
      effect: read
      questions:
      - Which environments is this artifact version deployed to?
      - Can I filter an artifact version's deployments to production environments only?
      instructions:
      - text: Show deployments of {artifact} version {version} from registry {registry}.
        slots:
          artifact: path.artifact
          version: path.version
          registry: path.registry_ref
      - text: List where {artifact}:{version} in {registry} is deployed in {env_type} environments.
        slots:
          artifact: path.artifact
          version: path.version
          registry: path.registry_ref
          env_type: query.env_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get full details of an artifact version
      effect: read
      questions:
      - What are the full details of a specific artifact version, including child versions?
      - Can I see the metadata recorded for one release of a package?
      instructions:
      - text: Get details for {artifact} version {version} in registry {registry}.
        slots:
          artifact: path.artifact
          version: path.version
          registry: path.registry_ref
      - text: Describe child version {child} of {artifact}:{version} in {registry}.
        slots:
          child: query.childVersion
          artifact: path.artifact
          version: path.version
          registry: path.registry_ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/file/{file_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a file exists in an artifact version
      effect: read
      questions:
      - Does a given file exist inside a specific artifact version?
      - Can I validate that a named file was published with a package release?
      instructions:
      - text: Check that file {file} exists in {artifact} version {version} in {registry}.
        slots:
          file: path.file_name
          artifact: path.artifact
          version: path.version
          registry: path.registry_ref
      - text: Confirm {file} was published with {artifact}:{version} in registry {registry}.
        slots:
          file: path.file_name
          artifact: path.artifact
          version: path.version
          registry: path.registry_ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List the files in an artifact version
      effect: read
      questions:
      - What files make up a particular artifact version?
      - Can I search the file list of a package release by name?
      instructions:
      - text: List files in {artifact} version {version} in registry {registry}.
        slots:
          artifact: path.artifact
          version: path.version
          registry: path.registry_ref
      - text: Find files named like {term} in {artifact}:{version} from {registry}.
        slots:
          term: query.search_term
          artifact: path.artifact
          version: path.version
          registry: path.registry_ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a summary of one artifact version
      effect: read
      questions:
      - What's the at-a-glance summary for one version of an artifact?
      - Can I summarize an image version by its digest?
      instructions:
      - text: Summarize version {version} of {artifact} in {registry}.
        slots:
          version: path.version
          artifact: path.artifact
          registry: path.registry_ref
      - text: Give the version summary of {artifact}:{version} in {registry} for digest {digest}.
        slots:
          artifact: path.artifact
          version: path.version
          registry: path.registry_ref
          digest: query.digest
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/artifact/{artifact}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List all versions of an artifact
      effect: read
      questions:
      - Which versions of this package have been published to my registry?
      - Can I include deleted versions when listing an artifact's releases?
      instructions:
      - text: List every version of artifact {artifact} in registry {registry}.
        slots:
          artifact: path.artifact
          registry: path.registry_ref
      - text: Show versions of {artifact} in {registry} matching {term}.
        slots:
          artifact: path.artifact
          registry: path.registry_ref
          term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/artifact/labels'].get
  update:
    x-apievangelist-phrasing:
      intent: List labels used in a registry
      effect: read
      questions:
      - What labels are used on artifacts across this registry?
      - Can I search the registry's artifact labels by keyword?
      instructions:
      - text: List artifact labels in registry {registry}.
        slots:
          registry: path.registry_ref
      - text: Find labels in {registry} containing {term}.
        slots:
          registry: path.registry_ref
          term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/artifact/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get artifact stats for a whole registry
      effect: read
      questions:
      - How many artifacts and downloads does my registry have overall?
      - What are registry-wide artifact statistics for last month?
      instructions:
      - text: Get registry-wide artifact stats for {registry}.
        slots:
          registry: path.registry_ref
      - text: Show artifact statistics across registry {registry} between {from} and {to}.
        slots:
          registry: path.registry_ref
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'