Harness · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Harness Probes API
12 actions
12 updates
phrasing
extends
openapi/harness-probes-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.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/gateway/chaos/manager/api/rest/v2/probes'].get
$.paths['/gateway/chaos/manager/api/rest/v2/probes'].post
$.paths['/gateway/chaos/manager/api/rest/v2/probes/experiment-run'].post
$.paths['/gateway/chaos/manager/api/rest/v2/probes/import'].post
$.paths['/gateway/chaos/manager/api/rest/v2/probes/manifest/{probeId}'].get
$.paths['/gateway/chaos/manager/api/rest/v2/probes/{probeId}'].get
$.paths['/gateway/chaos/manager/api/rest/v2/probes/{probeId}'].put
$.paths['/gateway/chaos/manager/api/rest/v2/probes/{probeId}'].delete
$.paths['/gateway/chaos/manager/api/rest/v2/probes/enable/{probeId}'].post
$.paths['/gateway/chaos/manager/api/rest/v2/probes/verify/{probeId}'].post
$.paths['/gateway/chaos/manager/api/v3/probes/list-metadata'].post
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Harness Probes API
version: 1.0.0
extends: openapi/harness-probes-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/v2/probes'].get
update:
x-apievangelist-phrasing:
intent: List chaos resilience probes
effect: read
questions:
- What resilience probes are defined in my chaos engineering project?
- Can I filter probes by tags, date range or infrastructure type?
instructions:
- text: List chaos probes in project {projectIdentifier} of org {organizationIdentifier}.
slots:
projectIdentifier: query.projectIdentifier
organizationIdentifier: query.organizationIdentifier
- text: Find probes named like {search} on infrastructure type {infraType}.
slots:
search: query.search
infraType: query.infraType
method: generated
generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/v2/probes'].post
update:
x-apievangelist-phrasing:
intent: Create a chaos probe
effect: write
questions:
- How do I create a new resilience probe for chaos experiments?
- What properties can I set when defining a probe from scratch?
instructions:
- text: Create a probe named {name} of type {type} in project {projectIdentifier}.
slots:
name: requestBody.name
type: requestBody.type
projectIdentifier: query.projectIdentifier
- text: Define a new chaos probe {name} for infrastructure {infrastructureType}.
slots:
name: requestBody.name
infrastructureType: requestBody.infrastructureType
method: generated
generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/v2/probes/experiment-run'].post
update:
x-apievangelist-phrasing:
intent: Get probes used in experiment runs
effect: read
questions:
- Which probes ran as part of a chaos experiment run?
- Can I look up probes for several experiment runs at once?
instructions:
- text: Get the probes for experiment runs {experimentRunIds}.
slots:
experimentRunIds: requestBody.experimentRunIds
- text: Show probes attached to experiment runs {experimentRunIds} in project {projectIdentifier}.
slots:
experimentRunIds: requestBody.experimentRunIds
projectIdentifier: query.projectIdentifier
method: generated
generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/v2/probes/import'].post
update:
x-apievangelist-phrasing:
intent: Import a probe from a ChaosHub
effect: write
questions:
- How do I import an existing probe template into my project?
- Can I bring a probe in from a hub instead of building it myself?
instructions:
- text: Import probe {probeRef} as {name} with identity {identity} and import type {importType}.
slots:
probeRef: requestBody.probeRef
name: requestBody.name
identity: requestBody.identity
importType: requestBody.importType
- text: Import probe {probeRef} from hub {hubRef} into project {projectIdentifier}.
slots:
probeRef: requestBody.probeRef
hubRef: requestBody.hubRef
projectIdentifier: query.projectIdentifier
method: generated
generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/v2/probes/manifest/{probeId}'].get
update:
x-apievangelist-phrasing:
intent: Get a probe's manifest
effect: read
questions:
- Where can I see the raw manifest YAML behind a probe?
- Can I export a probe's manifest by its ID?
instructions:
- text: Get the manifest of probe {probeId}.
slots:
probeId: path.probeId
- text: Show the probe manifest for {probeId} in project {projectIdentifier}.
slots:
probeId: path.probeId
projectIdentifier: query.projectIdentifier
method: generated
generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/v2/probes/{probeId}'].get
update:
x-apievangelist-phrasing:
intent: Get a probe's details
effect: read
questions:
- What is configured on a specific chaos probe?
- Can I see a probe's recent runs and properties by ID?
instructions:
- text: Get the details of probe {probeId}.
slots:
probeId: path.probeId
- text: Show probe {probeId} configuration in project {projectIdentifier}.
slots:
probeId: path.probeId
projectIdentifier: query.projectIdentifier
method: generated
generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/v2/probes/{probeId}'].put
update:
x-apievangelist-phrasing:
intent: Update a probe's configuration
effect: write
questions:
- How do I change the properties of an existing probe?
- Can I edit the run properties of a probe that's already in use?
instructions:
- text: Update probe {probeId} with new run properties {runProperties}.
slots:
probeId: path.probeId
runProperties: requestBody.runProperties
- text: Rename probe {probeId} to {name}.
slots:
probeId: path.probeId
name: requestBody.name
method: generated
generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/v2/probes/{probeId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a probe
effect: destructive
questions:
- How do I delete a chaos probe I no longer need?
- Can I remove a probe from a project permanently?
instructions:
- text: Delete probe {probeId}.
slots:
probeId: path.probeId
- text: Remove probe {probeId} from project {projectIdentifier}.
slots:
probeId: path.probeId
projectIdentifier: query.projectIdentifier
method: generated
generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/v2/probes/enable/{probeId}'].post
update:
x-apievangelist-phrasing:
intent: Enable or disable a probe across experiments
effect: write
questions:
- Can I turn a probe off in every experiment that uses it?
- How do I re-enable a disabled probe across experiments?
instructions:
- text: Disable probe {probeId} across all experiments.
slots:
probeId: path.probeId
- text: Set probe {probeId} enabled to {isEnabled} as a bulk update.
slots:
probeId: path.probeId
isEnabled: requestBody.isEnabled
method: generated
generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/v2/probes/verify/{probeId}'].post
update:
x-apievangelist-phrasing:
intent: Mark a probe as verified
effect: write
questions:
- How do I mark a probe as verified?
- Can I unverify a probe later?
instructions:
- text: Verify probe {probeId}.
slots:
probeId: path.probeId
- text: Set the verified flag on probe {probeId} to {verify}.
slots:
probeId: path.probeId
verify: requestBody.verify
method: generated
generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/v3/probes/list-metadata'].post
update:
x-apievangelist-phrasing:
intent: List probe metadata across scopes
effect: read
questions:
- Can I get lightweight metadata for probes across all scopes?
- Which probe metadata matches a set of identifiers?
instructions:
- text: List probe metadata for identifiers {identifiers} in account {accountIdentifier}.
slots:
identifiers: requestBody.identifiers
accountIdentifier: query.accountIdentifier
- text: Show probe metadata matching {search} including all scopes.
slots:
search: query.search
method: generated
generated: '2026-09-26'