Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Project Resource Groups API

6 actions 6 updates phrasing extends openapi/harness-project-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}/projects/{project}/resource-groups'].get
$.paths['/v1/orgs/{org}/projects/{project}/resource-groups'].post
$.paths['/v1/orgs/{org}/projects/{project}/resource-groups/{resource-group}'].get
$.paths['/v1/orgs/{org}/projects/{project}/resource-groups/{resource-group}'].put
$.paths['/v1/orgs/{org}/projects/{project}/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 Project Resource Groups API
  version: 1.0.0
extends: openapi/harness-project-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}/projects/{project}/resource-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List resource groups in a project
      effect: read
      questions:
      - Which resource groups are defined inside a specific Harness project?
      - Can I search a project's resource groups by name?
      instructions:
      - text: List resource groups in project {project} of org {org}.
        slots:
          project: path.project
          org: path.org
      - text: Search resource groups in org {org}, project {project} for {search_term}.
        slots:
          org: path.org
          project: path.project
          search_term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/resource-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a resource group in a project
      effect: write
      questions:
      - How do I create a custom resource group scoped to one project?
      - Can a project resource group be limited with a resource filter?
      instructions:
      - text: Create resource group {name} ({identifier}) in project {project}, org {org}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          project: path.project
          org: path.org
      - text: Create project resource group {identifier} named {name} in org {org}, project {project} with filter {resource_filter}.
        slots:
          identifier: requestBody.identifier
          name: requestBody.name
          org: path.org
          project: path.project
          resource_filter: requestBody.resource_filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/resource-groups/{resource-group}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a resource group in a project
      effect: read
      questions:
      - What resources does a project-level resource group include?
      - Can I look up one project resource group by identifier?
      instructions:
      - text: Get resource group {resource_group} in project {project}, org {org}.
        slots:
          resource_group: path.resource-group
          project: path.project
          org: path.org
      - text: Show project {project}'s resource group {resource_group} in org {org}.
        slots:
          project: path.project
          resource_group: path.resource-group
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/resource-groups/{resource-group}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a resource group in a project
      effect: write
      questions:
      - How do I change which resources a project resource group covers?
      - Can I rename a resource group that lives in a project?
      instructions:
      - text: Update resource group {resource_group} in project {project}, org {org} with name {name} and identifier {identifier}.
        slots:
          resource_group: path.resource-group
          project: path.project
          org: path.org
          name: requestBody.name
          identifier: requestBody.identifier
      - text: Set project {project} resource group {resource_group} in org {org} to include all resources {include_all_resources}.
        slots:
          project: path.project
          resource_group: path.resource-group
          org: path.org
          include_all_resources: requestBody.include_all_resources
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/resource-groups/{resource-group}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a resource group from a project
      effect: destructive
      questions:
      - How do I delete a custom resource group in a project?
      - Can I remove a project resource group I created by mistake?
      instructions:
      - text: Delete resource group {resource_group} from project {project}, org {org}.
        slots:
          resource_group: path.resource-group
          project: path.project
          org: path.org
      - text: Remove project {project}'s resource group {resource_group} in org {org}.
        slots:
          project: path.project
          resource_group: path.resource-group
          org: path.org
      method: generated
      generated: '2026-09-26'