Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Environment Group API

6 actions 6 updates phrasing extends openapi/harness-environmentgroup-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['/ng/api/environmentGroup'].post
$.paths['/ng/api/environmentGroup/{envGroupIdentifier}'].get
$.paths['/ng/api/environmentGroup/{envGroupIdentifier}'].put
$.paths['/ng/api/environmentGroup/{envGroupIdentifier}'].delete
$.paths['/ng/api/environmentGroup/list'].post

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 Environment Group API
  version: 1.0.0
extends: openapi/harness-environmentgroup-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['/ng/api/environmentGroup'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an environment group
      effect: write
      questions:
      - How do I group several environments together?
      - Can an environment group have a color?
      instructions:
      - text: Create an environment group from YAML {yaml}.
        slots:
          yaml: requestBody.yaml
      - text: Create environment group {identifier} colored {color} using YAML {yaml}.
        slots:
          identifier: requestBody.identifier
          color: requestBody.color
          yaml: requestBody.yaml
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/environmentGroup/{envGroupIdentifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an environment group
      effect: read
      questions:
      - Which environments are in a given environment group?
      - Can I fetch an environment group from a specific git branch?
      instructions:
      - text: Show environment group {envGroupIdentifier}.
        slots:
          envGroupIdentifier: path.envGroupIdentifier
      - text: Get environment group {envGroupIdentifier} from branch {branch}.
        slots:
          envGroupIdentifier: path.envGroupIdentifier
          branch: query.branch
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/environmentGroup/{envGroupIdentifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an environment group
      effect: write
      questions:
      - How do I change the YAML of an environment group?
      - Can I commit an environment group update to a git branch with a message?
      instructions:
      - text: Update environment group {envGroupIdentifier} with YAML {yaml}.
        slots:
          envGroupIdentifier: path.envGroupIdentifier
          yaml: requestBody.yaml
      - text: Update environment group {envGroupIdentifier} with {yaml} on branch {branch} using commit message {commitMsg}.
        slots:
          envGroupIdentifier: path.envGroupIdentifier
          yaml: requestBody.yaml
          branch: query.branch
          commitMsg: query.commitMsg
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/environmentGroup/{envGroupIdentifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an environment group
      effect: destructive
      questions:
      - How do I delete an environment group?
      - Can I force delete an environment group that is still referenced?
      instructions:
      - text: Delete environment group {envGroupIdentifier}.
        slots:
          envGroupIdentifier: path.envGroupIdentifier
      - text: 'Force delete environment group {envGroupIdentifier}: {forceDelete}.'
        slots:
          envGroupIdentifier: path.envGroupIdentifier
          forceDelete: query.forceDelete
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/environmentGroup/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List environment groups
      effect: read
      questions:
      - What environment groups exist in my project?
      - Can I filter environment groups by tags?
      instructions:
      - text: List environment groups with filter type {filterType}.
        slots:
          filterType: requestBody.filterType
      - text: Search environment groups for {searchTerm} using filter type {filterType}.
        slots:
          searchTerm: query.searchTerm
          filterType: requestBody.filterType
      method: generated
      generated: '2026-09-26'