Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Project Environments API

6 actions 6 updates phrasing extends openapi/harness-project-environments-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'].get
$.paths['/v1/orgs/{org}/projects/{project}/environments'].post
$.paths['/v1/orgs/{org}/projects/{project}/environments/{environment}'].get
$.paths['/v1/orgs/{org}/projects/{project}/environments/{environment}'].put
$.paths['/v1/orgs/{org}/projects/{project}/environments/{environment}'].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 Environments API
  version: 1.0.0
extends: openapi/harness-project-environments-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List environments in a project
      effect: read
      questions:
      - Which deployment environments exist in my Harness project?
      - Can I search a project's environments by name?
      instructions:
      - text: List environments in project {project} of org {org}.
        slots:
          project: path.project
          org: path.org
      - text: Search environments in {org}/{project} for {term}.
        slots:
          org: path.org
          project: path.project
          term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/environments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an environment in a project
      effect: write
      questions:
      - How do I create a new production or pre-production environment?
      - Can I add tags and a color when creating an environment?
      instructions:
      - text: Create a {type} environment {name} ({env_id}) in project {project} of org {org}.
        slots:
          type: requestBody.type
          name: requestBody.name
          env_id: requestBody.identifier
          project: path.project
          org: path.org
      - text: Add environment {env_id} named {name}, type {type}, to {org}/{project}.
        slots:
          env_id: requestBody.identifier
          name: requestBody.name
          type: requestBody.type
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/environments/{environment}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an environment
      effect: read
      questions:
      - How do I look up one environment's type and settings?
      - Is a given environment marked as production?
      instructions:
      - text: Get environment {environment} in project {project} of org {org}.
        slots:
          environment: path.environment
          project: path.project
          org: path.org
      - text: Show details for environment {environment} in {org}/{project}.
        slots:
          environment: path.environment
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/environments/{environment}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an environment
      effect: write
      questions:
      - Can I rename an environment or switch it between production and pre-production?
      - How do I change an environment's tags or YAML?
      instructions:
      - text: 'Update environment {environment} in {org}/{project}: name {name}, type {type}, id {env_id}.'
        slots:
          environment: path.environment
          org: path.org
          project: path.project
          name: requestBody.name
          type: requestBody.type
          env_id: requestBody.identifier
      - text: Rename environment {environment} to {name} in project {project}, org {org}, keeping id {env_id} and type {type}.
        slots:
          environment: path.environment
          name: requestBody.name
          project: path.project
          org: path.org
          env_id: requestBody.identifier
          type: requestBody.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/environments/{environment}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an environment
      effect: destructive
      questions:
      - How do I delete an environment from a project?
      - Can I force-delete an environment that is still referenced?
      instructions:
      - text: Delete environment {environment} from project {project} in org {org}.
        slots:
          environment: path.environment
          project: path.project
          org: path.org
      - text: Force-delete environment {environment} in {org}/{project}, force {force}.
        slots:
          environment: path.environment
          org: path.org
          project: path.project
          force: query.forceDelete
      method: generated
      generated: '2026-09-26'