Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Registry V3 - Internal API

4 actions 4 updates phrasing extends openapi/harness-registry-v3-internal-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/internal/search/backfill'].post

$.paths['/har/api/v3/internal/search/backfill/state'].get

$.paths['/har/api/v3/internal/search/backfill/status/{job_id}'].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 - Internal API
  version: 1.0.0
extends: openapi/harness-registry-v3-internal-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/internal/search/backfill'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a registry search index backfill
      effect: write
      questions:
      - How do I rebuild the artifact registry search index for an account?
      - Can I reindex everything or only certain entity types in registry search?
      instructions:
      - text: Start a search backfill for account {account} covering entity types {types}.
        slots:
          account: query.account_identifier
          types: requestBody.entityTypes
      - text: Reindex all registry search entities of types {types} in {account}, full reindex {all}.
        slots:
          types: requestBody.entityTypes
          account: query.account_identifier
          all: requestBody.reindexAll
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v3/internal/search/backfill/state'].get
  update:
    x-apievangelist-phrasing:
      intent: Get registry search backfill state
      effect: read
      questions:
      - What state is the registry search backfill in for my account?
      - Is a search reindex currently running on this account?
      instructions:
      - text: Get the search backfill state for account {account}.
        slots:
          account: query.account_identifier
      - text: Check whether a registry reindex is in progress for {account}.
        slots:
          account: query.account_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/har/api/v3/internal/search/backfill/status/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the status of a backfill job
      effect: read
      questions:
      - Has a specific search backfill job finished yet?
      - Can I track one backfill job by its job ID?
      instructions:
      - text: Get the status of backfill job {job}.
        slots:
          job: path.job_id
      - text: Check progress of backfill job {job} in account {account}.
        slots:
          job: path.job_id
          account: query.account_identifier
      method: generated
      generated: '2026-09-26'