Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Fault Templates API

12 actions 12 updates phrasing extends openapi/harness-fault-templates-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 12

$.info
$.paths['/gateway/chaos/manager/api/rest/faults/{identity}'].put
$.paths['/gateway/chaos/manager/api/rest/faults/{identity}'].delete
$.paths['/gateway/chaos/manager/api/rest/faulttemplates'].get
$.paths['/gateway/chaos/manager/api/rest/faulttemplates'].post
$.paths['/gateway/chaos/manager/api/rest/faulttemplates/{identity}'].get
$.paths['/gateway/chaos/manager/api/rest/faulttemplates/{identity}'].put
$.paths['/gateway/chaos/manager/api/rest/faulttemplates/{identity}'].delete
$.paths['/gateway/chaos/manager/api/rest/faulttemplates/{identity}/compare'].get
$.paths['/gateway/chaos/manager/api/rest/faulttemplates/{identity}/revisions'].get
$.paths['/gateway/chaos/manager/api/rest/faulttemplates/{identity}/variables'].get
$.paths['/gateway/chaos/manager/api/rest/faulttemplates/{identity}/yaml'].get

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 Fault Templates API
  version: 1.0.0
extends: openapi/harness-fault-templates-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: 11
- target: $.paths['/gateway/chaos/manager/api/rest/faults/{identity}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a chaos fault
      effect: write
      questions:
      - How do I edit a chaos fault's inputs or spec after creating it?
      - Can I change the infrastructure type a fault targets?
      instructions:
      - text: Update chaos fault {identity} and rename it to {name}.
        slots:
          identity: path.identity
          name: requestBody.name
      - text: Change fault {identity}'s category to {category}.
        slots:
          identity: path.identity
          category: requestBody.category
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/faults/{identity}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a chaos fault
      effect: destructive
      questions:
      - How do I remove a chaos fault I created?
      - Can I delete a fault scoped to a single project?
      instructions:
      - text: Delete chaos fault {identity}.
        slots:
          identity: path.identity
      - text: Remove fault {identity} from project {projectIdentifier}.
        slots:
          identity: path.identity
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/faulttemplates'].get
  update:
    x-apievangelist-phrasing:
      intent: List fault templates in a ChaosHub
      effect: read
      questions:
      - Which chaos fault templates are available in a hub?
      - Can I filter fault templates by infrastructure type, category or tags?
      instructions:
      - text: List fault templates in hub {hubIdentity}.
        slots:
          hubIdentity: query.hubIdentity
      - text: Show {category} fault templates for {infrastructureType} infrastructure.
        slots:
          category: query.category
          infrastructureType: query.infrastructureType
      - text: Search fault templates for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/faulttemplates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a fault template in a hub
      effect: write
      questions:
      - How do I add a custom fault template to a ChaosHub?
      - What must a new fault template have besides a name?
      instructions:
      - text: Create fault template {name} with identity {identity} in hub {hubIdentity}.
        slots:
          name: requestBody.name
          identity: requestBody.identity
          hubIdentity: query.hubIdentity
      - text: Add a {category} fault template {identity} to hub {hubIdentity}.
        slots:
          category: requestBody.category
          identity: requestBody.identity
          hubIdentity: query.hubIdentity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/faulttemplates/{identity}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one fault template revision
      effect: read
      questions:
      - What does a specific fault template contain at a given revision?
      - Can I open a single fault template from a hub?
      instructions:
      - text: Get fault template {identity} revision {revision} from hub {hubIdentity}.
        slots:
          identity: path.identity
          revision: query.revision
          hubIdentity: query.hubIdentity
      - text: Show fault template {identity} at revision {revision}.
        slots:
          identity: path.identity
          revision: query.revision
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/faulttemplates/{identity}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a fault template in a hub
      effect: write
      questions:
      - Can I update a fault template that lives in a ChaosHub?
      - Is updating a hub fault template scoped to a project?
      instructions:
      - text: Update fault template {identity} in hub {hubIdentity}.
        slots:
          identity: path.identity
          hubIdentity: query.hubIdentity
      - text: Refresh hub {hubIdentity}'s fault template {identity} in project {projectIdentifier}.
        slots:
          hubIdentity: query.hubIdentity
          identity: path.identity
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/faulttemplates/{identity}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a fault template from a hub
      effect: destructive
      questions:
      - How do I remove a fault template from a ChaosHub?
      - Does deleting a hub fault template need the hub identity?
      instructions:
      - text: Delete fault template {identity} from hub {hubIdentity}.
        slots:
          identity: path.identity
          hubIdentity: query.hubIdentity
      - text: Remove template {identity} from ChaosHub {hubIdentity}.
        slots:
          identity: path.identity
          hubIdentity: query.hubIdentity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/faulttemplates/{identity}/compare'].get
  update:
    x-apievangelist-phrasing:
      intent: Compare two revisions of a fault template
      effect: read
      questions:
      - What changed between two versions of a fault template?
      - Can I diff fault template revisions in a hub?
      instructions:
      - text: Diff fault template {identity} between revision {revision1} and {revision2}.
        slots:
          identity: path.identity
          revision1: query.revision1
          revision2: query.revision2
      - text: Compare revisions {revision1} and {revision2} of template {identity} in hub {hubIdentity}.
        slots:
          revision1: query.revision1
          revision2: query.revision2
          identity: path.identity
          hubIdentity: query.hubIdentity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/faulttemplates/{identity}/revisions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a fault template's revisions
      effect: read
      questions:
      - How many revisions does a fault template have?
      - Can I page through the revision history of a hub fault template?
      instructions:
      - text: List the revisions of fault template {identity} in hub {hubIdentity}.
        slots:
          identity: path.identity
          hubIdentity: query.hubIdentity
      - text: Show page {page} of template {identity}'s revision history, {limit} per page.
        slots:
          page: query.page
          identity: path.identity
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/faulttemplates/{identity}/variables'].get
  update:
    x-apievangelist-phrasing:
      intent: List a fault template's inputs
      effect: read
      questions:
      - Which inputs or variables does a fault template need?
      - Do a fault template's inputs change between revisions?
      instructions:
      - text: List the inputs of fault template {identity} at revision {revision}.
        slots:
          identity: path.identity
          revision: query.revision
      - text: Show the variables I must set for template {identity} in hub {hubIdentity}.
        slots:
          identity: path.identity
          hubIdentity: query.hubIdentity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/faulttemplates/{identity}/yaml'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a fault template's YAML
      effect: read
      questions:
      - Where can I see the raw YAML definition of a fault template?
      - Can I export a fault template as YAML at a specific revision?
      instructions:
      - text: Get the YAML for fault template {identity} at revision {revision}.
        slots:
          identity: path.identity
          revision: query.revision
      - text: Export template {identity} from hub {hubIdentity} as YAML.
        slots:
          identity: path.identity
          hubIdentity: query.hubIdentity
      method: generated
      generated: '2026-09-26'