Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Account Environments API

6 actions 6 updates phrasing extends openapi/harness-account-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/environments'].get
$.paths['/v1/environments'].post
$.paths['/v1/environments/{environment}'].get
$.paths['/v1/environments/{environment}'].put
$.paths['/v1/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 Account Environments API
  version: 1.0.0
extends: openapi/harness-account-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/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List account-level environments
      effect: read
      questions:
      - Which account-level deployment environments can I see?
      - Can I search account environments by name or specific IDs?
      instructions:
      - text: List the account-scoped environments.
      - text: Find account environments matching {search_term}.
        slots:
          search_term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/environments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account-level environment
      effect: write
      questions:
      - How do I create an environment shared across the whole account?
      - Do I have to choose production or pre-production when creating an environment?
      instructions:
      - text: Create account environment {name} with identifier {identifier} of type {type}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          type: requestBody.type
      - text: Add a new {type} environment {identifier} at account scope.
        slots:
          type: requestBody.type
          identifier: requestBody.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/environments/{environment}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account-level environment
      effect: read
      questions:
      - What is configured on a specific account-level environment?
      - Can I fetch an account environment's YAML?
      instructions:
      - text: Get account environment {environment}.
        slots:
          environment: path.environment
      - text: Show the details of account-scoped environment {environment}.
        slots:
          environment: path.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/environments/{environment}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account-level environment
      effect: write
      questions:
      - How do I change the type or color of an account environment?
      - Can I edit the YAML of an existing account-scoped environment?
      instructions:
      - text: Update account environment {environment} to type {type}.
        slots:
          environment: path.environment
          type: requestBody.type
      - text: Rename account-scoped environment {environment} to {name}.
        slots:
          environment: path.environment
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/environments/{environment}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account-level environment
      effect: destructive
      questions:
      - How do I delete an environment at the account level?
      - Can I force-delete an account environment that is still referenced?
      instructions:
      - text: Delete account environment {environment}.
        slots:
          environment: path.environment
      - text: Force-delete account-scoped environment {environment}.
        slots:
          environment: path.environment
      method: generated
      generated: '2026-09-26'