Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Organization Resource Groups API

6 actions 6 updates phrasing extends openapi/harness-organization-resource-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 6

$.info
$.paths['/v1/orgs/{org}/resource-groups'].get
$.paths['/v1/orgs/{org}/resource-groups'].post
$.paths['/v1/orgs/{org}/resource-groups/{resource-group}'].get
$.paths['/v1/orgs/{org}/resource-groups/{resource-group}'].put
$.paths['/v1/orgs/{org}/resource-groups/{resource-group}'].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 Organization Resource Groups API
  version: 1.0.0
extends: openapi/harness-organization-resource-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: 5
- target: $.paths['/v1/orgs/{org}/resource-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List resource groups in an organization
      effect: read
      questions:
      - Which resource groups exist in my organization?
      - Can I search an org's resource groups by name?
      instructions:
      - text: List resource groups in org {org}.
        slots:
          org: path.org
      - text: Find resource groups in org {org} matching {search}.
        slots:
          org: path.org
          search: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/resource-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a resource group in an organization
      effect: write
      questions:
      - How do I create a custom resource group at the org level?
      - Can a new org resource group include all resources in the org?
      instructions:
      - text: Create resource group {name} with identifier {identifier} in org {org}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          org: path.org
      - text: Create org {org} resource group {name} ({identifier}) with resource filter {filter}.
        slots:
          org: path.org
          name: requestBody.name
          identifier: requestBody.identifier
          filter: requestBody.resource_filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/resource-groups/{resource-group}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization resource group
      effect: read
      questions:
      - Which resources does a particular org resource group cover?
      - Can I look up an org-level resource group by identifier?
      instructions:
      - text: Get resource group {resource_group} in org {org}.
        slots:
          resource_group: path.resource-group
          org: path.org
      - text: Show what org {org} resource group {resource_group} includes.
        slots:
          org: path.org
          resource_group: path.resource-group
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/resource-groups/{resource-group}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an organization resource group
      effect: write
      questions:
      - How do I change which resources an org resource group includes?
      - Can I rename or recolor an existing org resource group?
      instructions:
      - text: Update org {org} resource group {resource_group} with name {name} and identifier {identifier}.
        slots:
          org: path.org
          resource_group: path.resource-group
          name: requestBody.name
          identifier: requestBody.identifier
      - text: Change resource group {resource_group} in {org} to filter {filter}, keeping identifier {identifier} and name {name}.
        slots:
          resource_group: path.resource-group
          org: path.org
          filter: requestBody.resource_filter
          identifier: requestBody.identifier
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/resource-groups/{resource-group}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization resource group
      effect: destructive
      questions:
      - How do I remove a custom resource group from an organization?
      - What happens to role assignments when an org resource group is deleted?
      instructions:
      - text: Delete resource group {resource_group} from org {org}.
        slots:
          resource_group: path.resource-group
          org: path.org
      - text: Remove org {org} custom resource group {resource_group}.
        slots:
          org: path.org
          resource_group: path.resource-group
      method: generated
      generated: '2026-09-26'