Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Resource Group API

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

$.info
$.paths['/authz/api/v2/resourcegroup'].get
$.paths['/authz/api/v2/resourcegroup'].post
$.paths['/authz/api/v2/resourcegroup/{identifier}'].get
$.paths['/authz/api/v2/resourcegroup/{identifier}'].put
$.paths['/authz/api/v2/resourcegroup/{identifier}'].delete
$.paths['/authz/api/v2/resourcegroup/filter'].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 Resource Group API
  version: 1.0.0
extends: openapi/harness-harness-resource-group-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: 6
- target: $.paths['/authz/api/v2/resourcegroup'].get
  update:
    x-apievangelist-phrasing:
      intent: List resource groups
      effect: read
      questions:
      - Which resource groups exist in my account or project?
      - Can I search resource groups by name?
      instructions:
      - text: List resource groups in project {project}.
        slots:
          project: query.projectIdentifier
      - text: Find resource groups matching {term}.
        slots:
          term: query.searchTerm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/authz/api/v2/resourcegroup'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a resource group
      effect: write
      questions:
      - How do I create a resource group to scope access control?
      - Can I define which resources a role binding applies to at the org level?
      instructions:
      - text: Create resource group {group}.
        slots:
          group: requestBody.resourceGroup
      - text: Create a resource group {group} in organization {org}.
        slots:
          group: requestBody.resourceGroup
          org: query.orgIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/authz/api/v2/resourcegroup/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a resource group
      effect: read
      questions:
      - What resources are included in a particular resource group?
      - Where can I view a single resource group by identifier?
      instructions:
      - text: Get resource group {id}.
        slots:
          id: path.identifier
      - text: Show the resource selectors in resource group {id}.
        slots:
          id: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/authz/api/v2/resourcegroup/{identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a resource group
      effect: write
      questions:
      - Can I add more resources to an existing resource group?
      - How do I change what a resource group covers?
      instructions:
      - text: Update resource group {id} with {group}.
        slots:
          id: path.identifier
          group: requestBody.resourceGroup
      - text: Change the resources covered by resource group {id}.
        slots:
          id: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/authz/api/v2/resourcegroup/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a resource group
      effect: destructive
      questions:
      - How do I delete a resource group?
      - Can I remove a resource group at project scope?
      instructions:
      - text: Delete resource group {id}.
        slots:
          id: path.identifier
      - text: Remove resource group {id} from project {project}.
        slots:
          id: path.identifier
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/authz/api/v2/resourcegroup/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Filter resource groups by criteria
      effect: read
      questions:
      - Can I find resource groups that include a specific resource type?
      - Is there a way to list only Harness-managed resource groups?
      instructions:
      - text: Filter resource groups by resource selectors {selectors}.
        slots:
          selectors: requestBody.resourceSelectorFilterList
      - text: Search resource groups with identifiers {ids} across included scopes.
        slots:
          ids: requestBody.identifierFilter
      method: generated
      generated: '2026-09-26'