Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Cluster Orchestrator API

5 actions 5 updates phrasing extends openapi/harness-cluster-orchestrator-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 5

$.info
$.paths['/gateway/lw/api/accounts/{account_id}/clusters'].get
$.paths['/gateway/lw/api/accounts/{account_id}/clusters/orchestrator'].post
$.paths['/gateway/lw/api/accounts/{account_id}/clusters/orchestrator/{orchestrator_id}'].get
$.paths['/gateway/lw/api/accounts/{account_id}/clusters/orchestrator/{orchestrator_id}/config'].put

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 Cluster Orchestrator API
  version: 1.0.0
extends: openapi/harness-cluster-orchestrator-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: 4
- target: $.paths['/gateway/lw/api/accounts/{account_id}/clusters'].get
  update:
    x-apievangelist-phrasing:
      intent: List Kubernetes clusters connected to CCM
      effect: read
      questions:
      - Which Kubernetes clusters are connected to Harness cloud cost management?
      - How can I tell which connected clusters are already onboarded to Cluster Orchestrator?
      instructions:
      - text: List the Kubernetes clusters connected to account {account}.
        slots:
          account: path.account_id
      - text: Show which clusters in account {account} are onboarded to Cluster Orchestrator.
        slots:
          account: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/clusters/orchestrator'].post
  update:
    x-apievangelist-phrasing:
      intent: Onboard a Kubernetes cluster to Cluster Orchestrator
      effect: write
      questions:
      - How do I enable Cluster Orchestrator on a cluster that already has a CCM Kubernetes connector?
      - What config do I need to onboard a cluster to the orchestrator?
      instructions:
      - text: Onboard cluster {name} using connector {connector} to Cluster Orchestrator in account {account} with config {config}.
        slots:
          name: requestBody.name
          connector: requestBody.k8s_connector_id
          account: path.account_id
          config: requestBody.user_config
      - text: Enable Cluster Orchestrator for {name} via Kubernetes connector {connector}, account {account}, settings {config}.
        slots:
          name: requestBody.name
          connector: requestBody.k8s_connector_id
          account: path.account_id
          config: requestBody.user_config
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/clusters/orchestrator/{orchestrator_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of an orchestrated cluster
      effect: read
      questions:
      - What region, VPC and status does an orchestrated cluster have?
      - Can I look up a connected cluster by its orchestrator ID?
      instructions:
      - text: Show the cluster behind orchestrator {orchestrator} in account {account}.
        slots:
          orchestrator: path.orchestrator_id
          account: path.account_id
      - text: Get region and status for orchestrator {orchestrator}, account {account}.
        slots:
          orchestrator: path.orchestrator_id
          account: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/lw/api/accounts/{account_id}/clusters/orchestrator/{orchestrator_id}/config'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Cluster Orchestrator's config
      effect: write
      questions:
      - How do I change the subnets or security groups a cluster orchestrator uses?
      - Can I edit an orchestrator's configuration after onboarding?
      instructions:
      - text: Update orchestrator {orchestrator} in account {account} to use subnets {subnets}.
        slots:
          orchestrator: path.orchestrator_id
          account: path.account_id
          subnets: requestBody.subnets
      - text: Set security groups {groups} on orchestrator {orchestrator} config, account {account}.
        slots:
          groups: requestBody.security_groups
          orchestrator: path.orchestrator_id
          account: path.account_id
      method: generated
      generated: '2026-09-26'