Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Registry V3 - Metadata API

4 actions 4 updates phrasing extends openapi/harness-registry-v3-metadata-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 4

$.info

$.paths['/har/api/v3/metadata/{id}'].delete

$.paths['/har/api/v3/metadata/keys'].get

$.paths['/har/api/v3/metadata/values'].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 Registry V3 - Metadata API
  version: 1.0.0
extends: openapi/harness-registry-v3-metadata-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: 3
- target: $.paths['/har/api/v3/metadata/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a registry metadata entry
      effect: destructive
      questions:
      - How do I remove a metadata key-value pair from the artifact registry?
      - Can I delete a metadata entry by its ID?
      instructions:
      - text: Delete metadata entry {id} in account {account}.
        slots:
          id: path.id
          account: query.account_identifier
      - text: Remove registry metadata {id} for account {account}.
        slots:
          id: path.id
          account: query.account_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v3/metadata/keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List metadata keys used in the registry
      effect: read
      questions:
      - What metadata keys are in use across my artifact registry?
      - Can I search the available metadata keys by name?
      instructions:
      - text: List metadata keys in account {account}.
        slots:
          account: query.account_identifier
      - text: Search registry metadata keys for {term} in account {account}.
        slots:
          term: query.search_term
          account: query.account_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v3/metadata/values'].get
  update:
    x-apievangelist-phrasing:
      intent: List values recorded for a metadata key
      effect: read
      questions:
      - Which values have been set for a particular metadata key in the registry?
      - Can I search the values of one metadata key?
      instructions:
      - text: List values for metadata key {key} in account {account}.
        slots:
          key: query.key
          account: query.account_identifier
      - text: Find values of key {key} matching {term} (account {account}).
        slots:
          key: query.key
          term: query.search_term
          account: query.account_identifier
      method: generated
      generated: '2026-09-26'