Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Chaos Hubs API

7 actions 7 updates phrasing extends openapi/harness-chaos-hubs-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['/gateway/chaos/manager/api/rest/hubs'].get
$.paths['/gateway/chaos/manager/api/rest/hubs'].post
$.paths['/gateway/chaos/manager/api/rest/hubs/{hubIdentity}'].get
$.paths['/gateway/chaos/manager/api/rest/hubs/{hubIdentity}'].put
$.paths['/gateway/chaos/manager/api/rest/hubs/{hubIdentity}'].delete
$.paths['/gateway/chaos/manager/api/v3/hubs/list-metadata'].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 Chaos Hubs API
  version: 1.0.0
extends: openapi/harness-chaos-hubs-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['/gateway/chaos/manager/api/rest/hubs'].get
  update:
    x-apievangelist-phrasing:
      intent: List chaos hubs in a project
      effect: read
      questions:
      - Which chaos hubs are connected to my Harness project?
      - Can I include account- and org-level chaos hubs when listing a project's hubs?
      instructions:
      - text: List chaos hubs in project {project} of org {org} matching {search}, page {page} of {limit}, all scopes {includeAllScope}.
        slots:
          project: query.projectIdentifier
          org: query.organizationIdentifier
          search: query.search
          page: query.page
          limit: query.limit
          includeAllScope: query.includeAllScope
      - text: Search chaos hubs for {search} in project {project}.
        slots:
          search: query.search
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/hubs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a chaos hub
      effect: write
      questions:
      - How do I add a chaos hub backed by my own Git repository?
      - Can a new chaos hub point at a specific repo branch?
      instructions:
      - text: Create chaos hub {name} with identity {identity} in project {project}, org {org}.
        slots:
          name: requestBody.name
          identity: requestBody.identity
          project: query.projectIdentifier
          org: query.organizationIdentifier
      - text: Create chaos hub {name} ({identity}) from repo {repoName} branch {repoBranch} via connector {connectorRef}.
        slots:
          name: requestBody.name
          identity: requestBody.identity
          repoName: requestBody.repoName
          repoBranch: requestBody.repoBranch
          connectorRef: requestBody.connectorRef
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/hubs/{hubIdentity}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a chaos hub
      effect: read
      questions:
      - What repository and settings does a particular chaos hub use?
      - Can I fetch one chaos hub by its identity?
      instructions:
      - text: Get chaos hub {hub} in project {project}, org {org}.
        slots:
          hub: path.hubIdentity
          project: query.projectIdentifier
          org: query.organizationIdentifier
      - text: Show chaos hub {hub}.
        slots:
          hub: path.hubIdentity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/hubs/{hubIdentity}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or retag a chaos hub
      effect: write
      questions:
      - How do I rename a chaos hub or change its description?
      - Can I update the tags on an existing chaos hub?
      instructions:
      - text: Rename chaos hub {hub} to {name}.
        slots:
          hub: path.hubIdentity
          name: requestBody.name
      - text: Update chaos hub {hub} with name {name} and description {description}.
        slots:
          hub: path.hubIdentity
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/hubs/{hubIdentity}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a chaos hub
      effect: destructive
      questions:
      - How do I remove a chaos hub from a project?
      - Can I delete a chaos hub at the org scope?
      instructions:
      - text: Delete chaos hub {hub}.
        slots:
          hub: path.hubIdentity
      - text: Delete chaos hub {hub} from org {org}.
        slots:
          hub: path.hubIdentity
          org: query.organizationIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/v3/hubs/list-metadata'].post
  update:
    x-apievangelist-phrasing:
      intent: List chaos hub metadata
      effect: read
      questions:
      - Can I get lightweight metadata for many chaos hubs at once?
      - Which chaos hubs match certain tags, sorted by a field I choose?
      instructions:
      - text: List metadata for chaos hubs {identifiers}.
        slots:
          identifiers: requestBody.identifiers
      - text: Get chaos hub metadata tagged {tags}, sorted by {sortField}.
        slots:
          tags: query.tags
          sortField: query.sortField
      method: generated
      generated: '2026-09-26'