Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Project Infrastructures API

6 actions 6 updates phrasing extends openapi/harness-project-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}/projects/{project}/environments/{environment}/infrastructures'].get
$.paths['/v1/orgs/{org}/projects/{project}/environments/{environment}/infrastructures'].post
$.paths['/v1/orgs/{org}/projects/{project}/environments/{environment}/infrastructures/{infrastructure-definition}'].get
$.paths['/v1/orgs/{org}/projects/{project}/environments/{environment}/infrastructures/{infrastructure-definition}'].put
$.paths['/v1/orgs/{org}/projects/{project}/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 Project Infrastructures API
  version: 1.0.0
extends: openapi/harness-project-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}/projects/{project}/environments/{environment}/infrastructures'].get
  update:
    x-apievangelist-phrasing:
      intent: List infrastructures in a project environment
      effect: read
      questions:
      - Which infrastructures are defined in an environment of my project?
      - Can I filter project infrastructures by the services that use them?
      instructions:
      - text: List infrastructures in environment {environment} of project {project} in org {org}.
        slots:
          environment: path.environment
          project: path.project
          org: path.org
      - text: Show project {project} infrastructures for services {service_refs}.
        slots:
          project: path.project
          service_refs: query.service_refs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/environments/{environment}/infrastructures'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an infrastructure in a project environment
      effect: write
      questions:
      - How do I define a new infrastructure for a project environment?
      - What fields are required to create an infrastructure in a project?
      instructions:
      - text: Create infrastructure {name} of type {type} in environment {environment}, project {project}, org {org}.
        slots:
          name: requestBody.name
          type: requestBody.type
          environment: path.environment
          project: path.project
          org: path.org
      - text: Add infrastructure {identifier} to project environment {environment} using YAML {yaml}.
        slots:
          identifier: requestBody.identifier
          environment: path.environment
          yaml: requestBody.yaml
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/environments/{environment}/infrastructures/{infrastructure-definition}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project infrastructure definition
      effect: read
      questions:
      - Can I view one infrastructure definition in a project environment?
      - What YAML does a project's infrastructure definition contain?
      instructions:
      - text: Get infrastructure {infra} in environment {environment} of project {project}, org {org}.
        slots:
          infra: path.infrastructure-definition
          environment: path.environment
          project: path.project
          org: path.org
      - text: Show project infrastructure {infra}.
        slots:
          infra: path.infrastructure-definition
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/environments/{environment}/infrastructures/{infrastructure-definition}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a project infrastructure definition
      effect: write
      questions:
      - How do I edit an infrastructure definition in my project?
      - Can I change the tags on a project infrastructure?
      instructions:
      - text: Update infrastructure {infra} in environment {environment}, project {project}, org {org} with YAML {yaml}.
        slots:
          infra: path.infrastructure-definition
          environment: path.environment
          project: path.project
          org: path.org
          yaml: requestBody.yaml
      - text: Retag project infrastructure {infra} with {tags}.
        slots:
          infra: path.infrastructure-definition
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/environments/{environment}/infrastructures/{infrastructure-definition}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project infrastructure
      effect: destructive
      questions:
      - Can I delete an infrastructure from a project environment?
      - Is there a force option when deleting a project infrastructure?
      instructions:
      - text: Delete infrastructure {infra} from environment {environment} in project {project}, org {org}.
        slots:
          infra: path.infrastructure-definition
          environment: path.environment
          project: path.project
          org: path.org
      - text: Force-delete project infrastructure {infra}, force {force}.
        slots:
          infra: path.infrastructure-definition
          force: query.forceDelete
      method: generated
      generated: '2026-09-26'