Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Faults API

9 actions 9 updates phrasing extends openapi/harness-faults-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 9

$.info
$.paths['/gateway/chaos/manager/api/rest/faults'].get
$.paths['/gateway/chaos/manager/api/rest/faults'].post
$.paths['/gateway/chaos/manager/api/rest/faults/{identity}'].get
$.paths['/gateway/chaos/manager/api/rest/faults/{identity}/experimentruns'].get
$.paths['/gateway/chaos/manager/api/rest/faults/{identity}/variables'].get
$.paths['/gateway/chaos/manager/api/rest/faults/{identity}/yaml'].get
$.paths['/gateway/chaos/manager/api/rest/hubs/faults'].get
$.paths['/gateway/chaos/manager/api/v3/faults/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 Faults API
  version: 1.0.0
extends: openapi/harness-faults-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: 8
- target: $.paths['/gateway/chaos/manager/api/rest/faults'].get
  update:
    x-apievangelist-phrasing:
      intent: List chaos faults in a project
      effect: read
      questions:
      - Which chaos faults are defined in my project?
      - Can I filter project faults by category or infrastructure type?
      instructions:
      - text: List faults in project {project} for account {account}.
        slots:
          project: query.projectIdentifier
          account: query.accountIdentifier
      - text: Show project faults in category {category} on infrastructure type {infra_type}.
        slots:
          category: query.category
          infra_type: query.infrastructureType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/faults'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a chaos fault
      effect: write
      questions:
      - How do I define a custom chaos fault?
      - What fields does a new fault need besides a name and identity?
      instructions:
      - text: Create fault {name} with identity {identity}.
        slots:
          name: requestBody.name
          identity: requestBody.identity
      - text: Create a {category} fault {name} ({identity}) for infrastructure type {infra_type}.
        slots:
          category: requestBody.category
          name: requestBody.name
          identity: requestBody.identity
          infra_type: requestBody.infraType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/faults/{identity}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a chaos fault from a project
      effect: read
      questions:
      - What does a particular chaos fault do and which infrastructures support it?
      - Can I look up a fault in my project by its identity?
      instructions:
      - text: Get fault {fault}.
        slots:
          fault: path.identity
      - text: Show the details of fault {fault} in project {project}.
        slots:
          fault: path.identity
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/faults/{identity}/experimentruns'].get
  update:
    x-apievangelist-phrasing:
      intent: List experiment runs that used a fault
      effect: read
      questions:
      - Which experiment runs have injected a given fault?
      - How often has a fault been exercised in recent experiments?
      instructions:
      - text: List experiment runs that used fault {fault}.
        slots:
          fault: path.identity
      - text: Show runs of fault {fault} for experiment type {type}.
        slots:
          fault: path.identity
          type: query.experimentType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/faults/{identity}/variables'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the inputs a chaos fault accepts
      effect: read
      questions:
      - What input variables can I tune on a chaos fault?
      - Which parameters does a fault expect before it can be used?
      instructions:
      - text: List the inputs of fault {fault}.
        slots:
          fault: path.identity
      - text: Show tunable variables for fault {fault} in project {project}.
        slots:
          fault: path.identity
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/faults/{identity}/yaml'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the YAML of a chaos fault
      effect: read
      questions:
      - Can I see the raw YAML definition of a fault?
      - Where do I export a fault's YAML to reuse elsewhere?
      instructions:
      - text: Get the YAML for fault {fault}.
        slots:
          fault: path.identity
      - text: Export fault {fault} as YAML from project {project}.
        slots:
          fault: path.identity
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/hubs/faults'].get
  update:
    x-apievangelist-phrasing:
      intent: List faults in a chaos hub
      effect: read
      questions:
      - Which faults are available in a chaos hub?
      - Can I search a hub's fault catalog by infrastructure type?
      instructions:
      - text: List faults in chaos hub {hub} matching {search}, page {page}, {limit} per page.
        slots:
          hub: query.hubIdentity
          search: query.search
          page: query.page
          limit: query.limit
      - text: Search hub faults for {search} on infra type {infra_type}.
        slots:
          search: query.search
          infra_type: query.infraType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/v3/faults/list-metadata'].post
  update:
    x-apievangelist-phrasing:
      intent: List metadata for faults
      effect: read
      questions:
      - Can I get just the names and tags of faults, including all scopes?
      - What lightweight metadata is available for a set of fault identifiers?
      instructions:
      - text: List fault metadata for identifiers {identifiers}.
        slots:
          identifiers: requestBody.identifiers
      - text: Get metadata of faults tagged {tags} in account {account}.
        slots:
          tags: query.tags
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'