Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness ChaosGuard Rules API

7 actions 7 updates phrasing extends openapi/harness-chaosguard-rules-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/v3/chaosguard-rules'].get
$.paths['/gateway/chaos/manager/api/v3/chaosguard-rules'].post
$.paths['/gateway/chaos/manager/api/v3/chaosguard-rules/{identity}'].get
$.paths['/gateway/chaos/manager/api/v3/chaosguard-rules/{identity}'].put
$.paths['/gateway/chaos/manager/api/v3/chaosguard-rules/{identity}'].delete
$.paths['/gateway/chaos/manager/api/v3/chaosguard-rules/{identity}/enable'].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 ChaosGuard Rules API
  version: 1.0.0
extends: openapi/harness-chaosguard-rules-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/v3/chaosguard-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List ChaosGuard rules
      effect: read
      questions:
      - What ChaosGuard rules are governing chaos experiments in my project?
      - Can I filter chaos guard rules by infrastructure type or tags?
      instructions:
      - text: List ChaosGuard rules in project {projectIdentifier}.
        slots:
          projectIdentifier: query.projectIdentifier
      - text: Search chaos guard rules for {search} on {infrastructureType} infrastructure.
        slots:
          search: query.search
          infrastructureType: query.infrastructureType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/v3/chaosguard-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a ChaosGuard rule
      effect: write
      questions:
      - How do I restrict who can run chaos experiments and when?
      - Can a ChaosGuard rule apply only during certain time windows?
      instructions:
      - text: Create chaos guard rule {name} with ID {ruleId} for user groups {userGroupIds}.
        slots:
          name: requestBody.name
          ruleId: requestBody.ruleId
          userGroupIds: requestBody.userGroupIds
      - text: Add a rule {ruleId} using conditions {conditionIds} active during {timeWindows}.
        slots:
          ruleId: requestBody.ruleId
          conditionIds: requestBody.conditionIds
          timeWindows: requestBody.timeWindows
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/v3/chaosguard-rules/{identity}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a ChaosGuard rule
      effect: read
      questions:
      - What conditions and user groups does one chaos guard rule cover?
      - Can I look up a ChaosGuard rule by its ID?
      instructions:
      - text: Get chaos guard rule {identity}.
        slots:
          identity: path.identity
      - text: Show the time windows on ChaosGuard rule {identity}.
        slots:
          identity: path.identity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/v3/chaosguard-rules/{identity}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a ChaosGuard rule
      effect: write
      questions:
      - Can I change the conditions or time windows on an existing chaos guard rule?
      - How do I add another user group to a ChaosGuard rule?
      instructions:
      - text: Update chaos guard rule {identity} to use conditions {conditionIds}.
        slots:
          identity: path.identity
          conditionIds: requestBody.conditionIds
      - text: Change ChaosGuard rule {identity} user groups to {userGroupIds}.
        slots:
          identity: path.identity
          userGroupIds: requestBody.userGroupIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/v3/chaosguard-rules/{identity}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a ChaosGuard rule
      effect: destructive
      questions:
      - How do I delete a chaos guard rule entirely?
      - Once a ChaosGuard rule is removed, can experiments it blocked run?
      instructions:
      - text: Delete chaos guard rule {identity}.
        slots:
          identity: path.identity
      - text: Remove ChaosGuard rule {identity} from project {projectIdentifier}.
        slots:
          identity: path.identity
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/v3/chaosguard-rules/{identity}/enable'].put
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable a ChaosGuard rule
      effect: write
      questions:
      - Can I temporarily switch off a chaos guard rule without deleting it?
      - How do I turn a disabled ChaosGuard rule back on?
      instructions:
      - text: Set chaos guard rule {identity} enabled to {enabled}.
        slots:
          identity: path.identity
          enabled: query.enabled
      - text: Toggle ChaosGuard rule {identity} on or off with {enabled}.
        slots:
          identity: path.identity
          enabled: query.enabled
      method: generated
      generated: '2026-09-26'