Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Registry V3 - Registries API

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

$.info
$.paths['/har/api/v3/registries'].get
$.paths['/har/api/v3/registries/{id}'].delete
$.paths['/har/api/v3/registries/{id}/metadata'].get
$.paths['/har/api/v3/registries/{id}/metadata'].put
$.paths['/har/api/v3/registries/{id}/metadata'].post
$.paths['/har/api/v3/registries/{id}/migrate'].post
$.paths['/har/api/v3/registries/{id}/rebuild-index'].post
$.paths['/har/api/v3/registries/{id}/restore'].post
$.paths['/har/api/v3/registries/stats'].post

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 Registry V3 - Registries API
  version: 1.0.0
extends: openapi/harness-registry-v3-registries-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: 9
- target: $.paths['/har/api/v3/registries'].get
  update:
    x-apievangelist-phrasing:
      intent: List artifact registries
      effect: read
      questions:
      - Which artifact registries exist in my Harness account?
      - Can I filter registries by package type or include soft-deleted ones?
      - How do I search registries by name?
      instructions:
      - text: List registries in project {project_identifier}.
        slots:
          project_identifier: query.project_identifier
      - text: List {package_types} registries matching {search_term}.
        slots:
          package_types: query.package_types
          search_term: query.search_term
      - text: Show soft-deleted registries in account {account_identifier}.
        slots:
          account_identifier: query.account_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v3/registries/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an artifact registry
      effect: destructive
      questions:
      - How do I delete a registry, and is it soft-deleted by default?
      - Can I force a hard delete of a registry?
      instructions:
      - text: Delete registry {id}.
        slots:
          id: path.id
      - text: Permanently delete registry {id} with force={force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v3/registries/{id}/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a registry's metadata
      effect: read
      questions:
      - What metadata key-values are attached to a registry?
      - Can I read all the metadata on one registry?
      instructions:
      - text: Get the metadata for registry {id}.
        slots:
          id: path.id
      - text: Show all metadata stored on registry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v3/registries/{id}/metadata'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace all metadata on a registry
      effect: write
      questions:
      - How do I overwrite a registry's metadata so only my new set remains?
      - Does replacing registry metadata drop keys I leave out?
      instructions:
      - text: Replace all metadata on registry {id} with {metadata}.
        slots:
          id: path.id
          metadata: requestBody.metadata
      - text: Reset registry {id}'s metadata to exactly {metadata}.
        slots:
          id: path.id
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v3/registries/{id}/metadata'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or overwrite metadata keys on a registry
      effect: write
      questions:
      - Can I add a few metadata keys to a registry without replacing the rest?
      - How do I upsert a metadata value on a registry?
      instructions:
      - text: Upsert metadata {metadata} on registry {id}.
        slots:
          metadata: requestBody.metadata
          id: path.id
      - text: 'Add or update these metadata keys on registry {id}: {metadata}.'
        slots:
          id: path.id
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v3/registries/{id}/migrate'].post
  update:
    x-apievangelist-phrasing:
      intent: Convert a generic registry to a raw registry
      effect: destructive
      questions:
      - How do I migrate a GENERIC registry to the RAW type?
      - Will migrating a generic registry to raw delete its images?
      instructions:
      - text: Migrate generic registry {id} to a raw registry.
        slots:
          id: path.id
      - text: Convert registry {id} from GENERIC to RAW, accepting that its images are deleted.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v3/registries/{id}/rebuild-index'].post
  update:
    x-apievangelist-phrasing:
      intent: Rebuild a registry's package index
      effect: write
      questions:
      - My registry index looks out of date; can I rebuild it?
      - Does rebuilding a registry index run in the background?
      instructions:
      - text: Rebuild the index for registry {id}.
        slots:
          id: path.id
      - text: Kick off a background index rebuild on registry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v3/registries/{id}/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a soft-deleted registry
      effect: write
      questions:
      - Can I bring back a registry I deleted by mistake?
      - How do I undo a soft delete on a registry?
      instructions:
      - text: Restore soft-deleted registry {id}.
        slots:
          id: path.id
      - text: Undelete registry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v3/registries/stats'].post
  update:
    x-apievangelist-phrasing:
      intent: Get usage statistics for several registries
      effect: read
      questions:
      - How many packages, downloads and bytes do my registries hold?
      - Can I get size and download counts for a batch of registries at once?
      instructions:
      - text: Get statistics for registries {registryIds}.
        slots:
          registryIds: requestBody.registryIds
      - text: Show package count, size and downloads for registries {registryIds}.
        slots:
          registryIds: requestBody.registryIds
      method: generated
      generated: '2026-09-26'