Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Groups API

8 actions 8 updates phrasing extends openapi/harness-groups-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 8

$.info
$.paths['/v1/groups/{group-identifier}'].get
$.paths['/v1/groups/{group-identifier}'].delete
$.paths['/v1/groups'].get
$.paths['/v1/groups'].put
$.paths['/v1/groups'].post
$.paths['/v1/groups/yaml'].get
$.paths['/v1/groups/workflows'].get

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 Groups API
  version: 1.0.0
extends: openapi/harness-groups-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: 7
- target: $.paths['/v1/groups/{group-identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the details of one group
      effect: read
      questions:
      - What does a specific group in my Harness account contain?
      - Can I look up one group by its identifier?
      instructions:
      - text: Get the details of group {group}.
        slots:
          group: path.group-identifier
      - text: Show me group {group}.
        slots:
          group: path.group-identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/groups/{group-identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group
      effect: destructive
      questions:
      - How do I delete a group I no longer need?
      - Can I remove a single group by its identifier?
      instructions:
      - text: Delete group {group}.
        slots:
          group: path.group-identifier
      - text: Remove group {group} from my account.
        slots:
          group: path.group-identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List all groups in the account
      effect: read
      questions:
      - Which groups exist across my whole account?
      - Is there a way to see every group at once?
      instructions:
      - text: List all groups in my account.
      - text: Show every group defined for this account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/groups'].put
  update:
    x-apievangelist-phrasing:
      intent: Update groups in bulk
      effect: write
      questions:
      - Can I update several groups in one request?
      - How do I save changes to the account's existing groups?
      instructions:
      - text: Update the account's groups with my changes.
      - text: Save the edited set of groups back to the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a new group
      effect: write
      questions:
      - How do I create a new group in my account?
      - Can I save a single group definition?
      instructions:
      - text: Save group {group}.
        slots:
          group: requestBody.group
      - text: Create a new group from definition {group}.
        slots:
          group: requestBody.group
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/groups/yaml'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the groups definition as YAML
      effect: read
      questions:
      - Can I export my groups configuration as YAML?
      - What does the YAML for all my groups look like?
      instructions:
      - text: Get the groups YAML for my account.
      - text: Export all groups as a YAML document.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/groups/workflows'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflows in the account
      effect: read
      questions:
      - Which workflows are available in my account to put into groups?
      - Can I page through the account's workflows?
      instructions:
      - text: List the workflows in my account.
      - text: Show page {page} of account workflows, {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-09-26'