Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Org Environments API

6 actions 6 updates phrasing extends openapi/harness-org-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}/environments'].get
$.paths['/v1/orgs/{org}/environments'].post
$.paths['/v1/orgs/{org}/environments/{environment}'].get
$.paths['/v1/orgs/{org}/environments/{environment}'].put
$.paths['/v1/orgs/{org}/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 Org Environments API
  version: 1.0.0
extends: openapi/harness-org-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}/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List environments in an organization
      effect: read
      questions:
      - What deployment environments are defined at the org level?
      - Can I search org environments by name or fetch a specific set of IDs?
      instructions:
      - text: List environments in org {org}.
        slots:
          org: path.org
      - text: Search org {org} environments for {term}.
        slots:
          org: path.org
          term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/environments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an environment in an organization
      effect: write
      questions:
      - How do I add a production or pre-production environment shared across an org?
      - Can I define a new org environment from YAML?
      instructions:
      - text: Create a {type} environment {name} with identifier {identifier} in org {org}.
        slots:
          type: requestBody.type
          name: requestBody.name
          identifier: requestBody.identifier
          org: path.org
      - text: Add an org environment to {org} from YAML {yaml}.
        slots:
          org: path.org
          yaml: requestBody.yaml
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/environments/{environment}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an environment in an organization
      effect: read
      questions:
      - What is configured for a specific org-level environment?
      - Is a given org environment marked as production or pre-production?
      instructions:
      - text: Get environment {environment} in org {org}.
        slots:
          environment: path.environment
          org: path.org
      - text: Show the type and tags of org environment {environment} in {org}.
        slots:
          environment: path.environment
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/environments/{environment}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an environment in an organization
      effect: write
      questions:
      - How do I change an org environment from pre-production to production?
      - Can I update the description or color of an existing org environment?
      instructions:
      - text: Update environment {environment} in org {org} to type {type}.
        slots:
          environment: path.environment
          org: path.org
          type: requestBody.type
      - text: Rename existing org environment {environment} in {org} to {name}.
        slots:
          environment: path.environment
          org: path.org
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/environments/{environment}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an environment from an organization
      effect: destructive
      questions:
      - How do I remove an environment defined at the org level?
      - Can I force-delete an org environment that services still reference?
      instructions:
      - text: Delete environment {environment} from org {org}.
        slots:
          environment: path.environment
          org: path.org
      - text: Force delete org environment {environment} in {org}.
        slots:
          environment: path.environment
          org: path.org
      method: generated
      generated: '2026-09-26'