Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Account Resource Groups API

6 actions 6 updates phrasing extends openapi/harness-account-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/resource-groups'].get
$.paths['/v1/resource-groups'].post
$.paths['/v1/resource-groups/{resource-group}'].get
$.paths['/v1/resource-groups/{resource-group}'].put
$.paths['/v1/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 Account Resource Groups API
  version: 1.0.0
extends: openapi/harness-account-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/resource-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List account-level resource groups
      effect: read
      questions:
      - Which resource groups are defined at my Harness account level?
      - Can I search account resource groups by name?
      instructions:
      - text: List the resource groups in my account.
      - text: Search account resource groups for {search_term}.
        slots:
          search_term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/resource-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account-level resource group
      effect: write
      questions:
      - How do I create a custom resource group for access control at the account level?
      - Can an account resource group include all resources automatically?
      instructions:
      - text: Create account resource group {name} with identifier {identifier}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
      - text: Create account resource group {identifier} named {name} filtering resources by {resource_filter}.
        slots:
          identifier: requestBody.identifier
          name: requestBody.name
          resource_filter: requestBody.resource_filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/resource-groups/{resource-group}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account-level resource group
      effect: read
      questions:
      - Which resources does a particular account resource group cover?
      - Can I view an account-scope resource group by identifier?
      instructions:
      - text: Get account resource group {resource_group}.
        slots:
          resource_group: path.resource-group
      - text: Show what account resource group {resource_group} includes.
        slots:
          resource_group: path.resource-group
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/resource-groups/{resource-group}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account-level resource group
      effect: write
      questions:
      - How do I change the resources included in an account resource group?
      - Can I rename an account-scope resource group?
      instructions:
      - text: Update account resource group {resource_group} with name {name} and identifier {identifier}.
        slots:
          resource_group: path.resource-group
          name: requestBody.name
          identifier: requestBody.identifier
      - text: Change account resource group {resource_group}'s scope to {included_scope}.
        slots:
          resource_group: path.resource-group
          included_scope: requestBody.included_scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/resource-groups/{resource-group}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account-level resource group
      effect: destructive
      questions:
      - How do I delete a custom resource group at the account level?
      - Can I remove an account resource group that is no longer assigned?
      instructions:
      - text: Delete account resource group {resource_group}.
        slots:
          resource_group: path.resource-group
      - text: Remove the account-scope resource group {resource_group}.
        slots:
          resource_group: path.resource-group
      method: generated
      generated: '2026-09-26'