Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Org Infrastructures API

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

$.info
$.paths['/v1/orgs/{org}/environments/{environment}/infrastructures'].get
$.paths['/v1/orgs/{org}/environments/{environment}/infrastructures'].post
$.paths['/v1/orgs/{org}/environments/{environment}/infrastructures/{infrastructure-definition}'].get
$.paths['/v1/orgs/{org}/environments/{environment}/infrastructures/{infrastructure-definition}'].put
$.paths['/v1/orgs/{org}/environments/{environment}/infrastructures/{infrastructure-definition}'].delete

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 Org Infrastructures API
  version: 1.0.0
extends: openapi/harness-org-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: 5
- target: $.paths['/v1/orgs/{org}/environments/{environment}/infrastructures'].get
  update:
    x-apievangelist-phrasing:
      intent: List org-level infrastructure definitions
      effect: read
      questions:
      - Which infrastructure definitions exist in an org-level environment?
      - Can I filter an environment's infrastructures by deployment type or service?
      instructions:
      - text: List infrastructures in environment {environment} of org {org}.
        slots:
          environment: path.environment
          org: path.org
      - text: Show {deployment_type} infrastructures in {org} environment {environment}.
        slots:
          deployment_type: query.deployment_type
          org: path.org
          environment: path.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/environments/{environment}/infrastructures'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an org-level infrastructure definition
      effect: write
      questions:
      - How do I define a new deployment target infrastructure shared across an org?
      - What YAML and type does an org scoped infrastructure need?
      instructions:
      - text: Create {type} infrastructure {name} ({identifier}) in environment {environment} of org {org} from YAML {yaml}.
        slots:
          type: requestBody.type
          name: requestBody.name
          identifier: requestBody.identifier
          environment: path.environment
          org: path.org
          yaml: requestBody.yaml
      - text: Add a new org infrastructure {identifier} named {name} of type {type} to {org}/{environment} with {yaml}.
        slots:
          identifier: requestBody.identifier
          name: requestBody.name
          type: requestBody.type
          org: path.org
          environment: path.environment
          yaml: requestBody.yaml
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/environments/{environment}/infrastructures/{infrastructure-definition}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an org-level infrastructure definition
      effect: read
      questions:
      - What does an org-level infrastructure definition's YAML look like?
      - Can I retrieve one infrastructure definition by its identifier?
      instructions:
      - text: Show infrastructure {infra} in environment {environment} of org {org}.
        slots:
          infra: path.infrastructure-definition
          environment: path.environment
          org: path.org
      - text: Get the YAML of org infrastructure {infra} in {org}/{environment}.
        slots:
          infra: path.infrastructure-definition
          org: path.org
          environment: path.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/environments/{environment}/infrastructures/{infrastructure-definition}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an org-level infrastructure definition
      effect: write
      questions:
      - How do I change the YAML of an existing org infrastructure definition?
      - Can I rename an org scoped infrastructure?
      instructions:
      - text: 'Update infrastructure {infra} in {org}/{environment}: name {name}, identifier {identifier}, type {type}, YAML {yaml}.'
        slots:
          infra: path.infrastructure-definition
          org: path.org
          environment: path.environment
          name: requestBody.name
          identifier: requestBody.identifier
          type: requestBody.type
          yaml: requestBody.yaml
      - text: Replace the YAML of existing infrastructure {infra} in {org}/{environment} with {yaml} ({identifier}, {name}, {type}).
        slots:
          infra: path.infrastructure-definition
          org: path.org
          environment: path.environment
          yaml: requestBody.yaml
          identifier: requestBody.identifier
          name: requestBody.name
          type: requestBody.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/environments/{environment}/infrastructures/{infrastructure-definition}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an org-level infrastructure definition
      effect: destructive
      questions:
      - How do I delete an infrastructure definition from an org environment?
      - Can I force-delete an infrastructure that is still referenced?
      instructions:
      - text: Delete infrastructure {infra} from environment {environment} in org {org}.
        slots:
          infra: path.infrastructure-definition
          environment: path.environment
          org: path.org
      - text: Force-delete org infrastructure {infra} in {org}/{environment}, force={force}.
        slots:
          infra: path.infrastructure-definition
          org: path.org
          environment: path.environment
          force: query.forceDelete
      method: generated
      generated: '2026-09-26'