Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Registries API

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

$.info
$.paths['/har/api/v1/registry'].post
$.paths['/har/api/v1/registry/{registry_ref}'].get
$.paths['/har/api/v1/registry/{registry_ref}'].put
$.paths['/har/api/v1/registry/{registry_ref}'].delete
$.paths['/har/api/v1/registry/{registry_ref}/artifacts'].get
$.paths['/har/api/v1/registry/{registry_ref}/client-setup-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 Registries API
  version: 1.0.0
extends: openapi/harness-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: 6
- target: $.paths['/har/api/v1/registry'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an artifact registry
      effect: write
      questions:
      - How do I create a new Docker or Helm registry in Harness Artifact Registry?
      - Can I make a registry public and restrict which artifact names are allowed?
      instructions:
      - text: Create a private {package_type} registry {identifier} under {parent} in space {space}.
        slots:
          package_type: requestBody.packageType
          identifier: requestBody.identifier
          parent: requestBody.parentRef
          space: query.space_ref
      - text: Create registry {identifier} for {package_type} in {parent}, space {space}, public={public}.
        slots:
          identifier: requestBody.identifier
          package_type: requestBody.packageType
          parent: requestBody.parentRef
          space: query.space_ref
          public: requestBody.isPublic
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an artifact registry's details
      effect: read
      questions:
      - What package type, visibility and cleanup policy does a registry have?
      - Can I look up one registry's configuration by its reference?
      instructions:
      - text: Show the details of registry {registry}.
        slots:
          registry: path.registry_ref
      - text: Get the configuration of artifact registry {registry}.
        slots:
          registry: path.registry_ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an artifact registry
      effect: write
      questions:
      - How do I add a cleanup policy or blocked pattern to an existing registry?
      - Can I change a registry's visibility after creating it?
      instructions:
      - text: Update registry {registry} to public={public}, keeping identifier {identifier}, type {package_type}, parent {parent}.
        slots:
          registry: path.registry_ref
          public: requestBody.isPublic
          identifier: requestBody.identifier
          package_type: requestBody.packageType
          parent: requestBody.parentRef
      - text: Set blocked pattern {pattern} on existing registry {registry} ({identifier}, {package_type}, parent {parent}, public {public}).
        slots:
          pattern: requestBody.blockedPattern
          registry: path.registry_ref
          identifier: requestBody.identifier
          package_type: requestBody.packageType
          parent: requestBody.parentRef
          public: requestBody.isPublic
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an artifact registry
      effect: destructive
      questions:
      - How do I delete an entire artifact registry?
      - Can I remove a registry we have stopped using?
      instructions:
      - text: Delete artifact registry {registry}.
        slots:
          registry: path.registry_ref
      - text: Remove the registry {registry} from the account.
        slots:
          registry: path.registry_ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/artifacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List artifacts in a registry
      effect: read
      questions:
      - Which artifacts are stored in a particular registry?
      - Can I filter a registry's artifacts by label or search term?
      instructions:
      - text: List the artifacts in registry {registry}.
        slots:
          registry: path.registry_ref
      - text: Find artifacts in {registry} labelled {label}.
        slots:
          registry: path.registry_ref
          label: query.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v1/registry/{registry_ref}/client-setup-details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get CLI setup steps for a registry
      effect: read
      questions:
      - How do I configure docker or helm on my machine to push to this registry?
      - What login and pull commands should I use for a specific artifact version?
      instructions:
      - text: Show the CLI client setup steps for registry {registry}.
        slots:
          registry: path.registry_ref
      - text: Give me the client commands to pull {artifact} version {version} from {registry}.
        slots:
          artifact: query.artifact
          version: query.version
          registry: path.registry_ref
      method: generated
      generated: '2026-09-26'