Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Infrastructures API

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

$.info
$.paths['/ng/api/infrastructures'].get
$.paths['/ng/api/infrastructures'].put
$.paths['/ng/api/infrastructures'].post
$.paths['/ng/api/infrastructures/{infraIdentifier}'].get
$.paths['/ng/api/infrastructures/{infraIdentifier}'].delete
$.paths['/ng/api/infrastructures/import'].post
$.paths['/ng/api/infrastructures/move-config/{infraIdentifier}'].post
$.paths['/ng/api/infrastructures/{infraIdentifier}/update-git-metadata'].put

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 Infrastructures API
  version: 1.0.0
extends: openapi/harness-infrastructures-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: 8
- target: $.paths['/ng/api/infrastructures'].get
  update:
    x-apievangelist-phrasing:
      intent: List infrastructure definitions in an environment
      effect: read
      questions:
      - Which infrastructure definitions exist in a given environment?
      - Can I filter an environment's infrastructures by deployment type or search term?
      instructions:
      - text: List infrastructures in environment {environment}.
        slots:
          environment: query.environmentIdentifier
      - text: Find {deploymentType} infrastructures in {environment} matching {search}.
        slots:
          deploymentType: query.deploymentType
          environment: query.environmentIdentifier
          search: query.searchTerm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/infrastructures'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an infrastructure definition
      effect: write
      questions:
      - Can I change an existing infrastructure definition's YAML or name?
      - How do I edit the cluster or namespace settings of an infrastructure I already have?
      instructions:
      - text: 'Update infrastructure {identifier} with this YAML: {yaml}.'
        slots:
          identifier: requestBody.identifier
          yaml: requestBody.yaml
      - text: Rename existing infrastructure {identifier} to {name}.
        slots:
          identifier: requestBody.identifier
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/infrastructures'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an infrastructure in an environment
      effect: write
      questions:
      - How do I define where a service deploys inside an environment?
      - What YAML do I need to add a new infrastructure definition?
      instructions:
      - text: Create infrastructure {name} in environment {environment} from YAML {yaml}.
        slots:
          name: requestBody.name
          environment: requestBody.environmentRef
          yaml: requestBody.yaml
      - text: Add a new {type} infrastructure definition using {yaml}.
        slots:
          type: requestBody.type
          yaml: requestBody.yaml
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/infrastructures/{infraIdentifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an infrastructure definition
      effect: read
      questions:
      - What is configured in one infrastructure definition?
      - Can I look up an infrastructure that was deleted?
      instructions:
      - text: Show infrastructure {infra} in environment {environment}.
        slots:
          infra: path.infraIdentifier
          environment: query.environmentIdentifier
      - text: 'Get infrastructure {infra}, including if deleted: {deleted}.'
        slots:
          infra: path.infraIdentifier
          deleted: query.deleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/infrastructures/{infraIdentifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an infrastructure definition
      effect: destructive
      questions:
      - How do I remove an infrastructure definition from an environment?
      - Can I force delete an infrastructure that is still referenced?
      instructions:
      - text: Delete infrastructure {infra} from environment {environment}.
        slots:
          infra: path.infraIdentifier
          environment: query.environmentIdentifier
      - text: Force delete infrastructure {infra}.
        slots:
          infra: path.infraIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/infrastructures/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import an infrastructure from Git
      effect: write
      questions:
      - Can I create an infrastructure from a YAML file that already lives in my Git repo?
      - How do I import infrastructure definitions from a branch and file path?
      instructions:
      - text: Import infrastructure from {file} on branch {branch} of repo {repo} into {environment}.
        slots:
          file: query.filePath
          branch: query.branch
          repo: query.repoName
          environment: query.environmentIdentifier
      - text: Create an infrastructure in {environment} from Git file {file} in {repo}.
        slots:
          environment: query.environmentIdentifier
          file: query.filePath
          repo: query.repoName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/infrastructures/move-config/{infraIdentifier}'].post
  update:
    x-apievangelist-phrasing:
      intent: Move an infrastructure YAML to Git
      effect: write
      questions:
      - Can I move an inline infrastructure definition into a remote Git repository?
      - How do I store an infrastructure's YAML in Git on a new branch?
      instructions:
      - text: Move infrastructure {infra} from inline to remote with move type {moveType}.
        slots:
          infra: path.infraIdentifier
          moveType: query.moveConfigType
      - text: Store infrastructure {infra} YAML in repo {repo} at {file} on branch {branch}.
        slots:
          infra: path.infraIdentifier
          repo: query.repoName
          file: query.filePath
          branch: query.branch
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/infrastructures/{infraIdentifier}/update-git-metadata'].put
  update:
    x-apievangelist-phrasing:
      intent: Update Git metadata of a remote infrastructure
      effect: write
      questions:
      - Can I point a remote infrastructure at a different repo or file path?
      - How do I fix the Git connector reference on a remote infrastructure?
      instructions:
      - text: Update the Git metadata of infrastructure {infra} to repo {repo} and file {file}.
        slots:
          infra: path.infraIdentifier
          repo: query.repoName
          file: query.filePath
      - text: Change the connector of remote infrastructure {infra} to {connector}.
        slots:
          infra: path.infraIdentifier
          connector: query.connectorRef
      method: generated
      generated: '2026-09-26'