Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Probe Templates API

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

$.info
$.paths['/gateway/chaos/manager/api/rest/templates/probes'].get
$.paths['/gateway/chaos/manager/api/rest/templates/probes'].post
$.paths['/gateway/chaos/manager/api/rest/templates/probes/{identity}'].get
$.paths['/gateway/chaos/manager/api/rest/templates/probes/{identity}'].put
$.paths['/gateway/chaos/manager/api/rest/templates/probes/{identity}'].delete
$.paths['/gateway/chaos/manager/api/rest/templates/probes/{identity}/variables'].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 Probe Templates API
  version: 1.0.0
extends: openapi/harness-probe-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: 6
- target: $.paths['/gateway/chaos/manager/api/rest/templates/probes'].get
  update:
    x-apievangelist-phrasing:
      intent: List probe templates in a chaos hub
      effect: read
      questions:
      - Which chaos probe templates are available in a ChaosHub?
      - Can I filter probe templates by infrastructure type?
      instructions:
      - text: List probe templates in hub {hubIdentity} matching {search}, page {page} of size {limit}.
        slots:
          hubIdentity: query.hubIdentity
          search: query.search
          page: query.page
          limit: query.limit
      - text: Show {infraType} probe templates in hub {hubIdentity} that match {search}.
        slots:
          infraType: query.infraType
          hubIdentity: query.hubIdentity
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/templates/probes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a chaos probe template
      effect: write
      questions:
      - How do I save a reusable resilience probe as a template in a hub?
      - Can I define inputs and variables when creating a probe template?
      instructions:
      - text: Create probe template {name} in hub {hubRef}.
        slots:
          name: requestBody.name
          hubRef: requestBody.hubRef
      - text: Add a {type} probe template named {name} for infrastructure {infrastructureType} in project {projectIdentifier}.
        slots:
          type: requestBody.type
          name: requestBody.name
          infrastructureType: requestBody.infrastructureType
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/templates/probes/{identity}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a chaos probe template
      effect: read
      questions:
      - What does a specific probe template in my hub look like?
      - Can I fetch an older revision of a probe template?
      instructions:
      - text: Get probe template {identity} from hub {hubIdentity}.
        slots:
          identity: path.identity
          hubIdentity: query.hubIdentity
      - text: Show revision {revision} of probe template {identity} in {hubIdentity}.
        slots:
          revision: query.revision
          identity: path.identity
          hubIdentity: query.hubIdentity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/templates/probes/{identity}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a chaos probe template
      effect: write
      questions:
      - How do I change the configuration of an existing probe template?
      - Can I make an updated probe template the hub default?
      instructions:
      - text: Update probe template {identity} and set its name to {name}.
        slots:
          identity: path.identity
          name: requestBody.name
      - text: Change the run properties of probe template {identity} to {runProperties}, keeping name {name}.
        slots:
          identity: path.identity
          runProperties: requestBody.runProperties
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/templates/probes/{identity}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a chaos probe template
      effect: destructive
      questions:
      - How do I remove a probe template from a ChaosHub?
      - Can I delete just one revision of a probe template?
      instructions:
      - text: Delete probe template {identity} from hub {hubIdentity}.
        slots:
          identity: path.identity
          hubIdentity: query.hubIdentity
      - text: Remove revision {revision} of probe template {identity} in {hubIdentity}.
        slots:
          revision: query.revision
          identity: path.identity
          hubIdentity: query.hubIdentity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gateway/chaos/manager/api/rest/templates/probes/{identity}/variables'].get
  update:
    x-apievangelist-phrasing:
      intent: List inputs of a probe template revision
      effect: read
      questions:
      - Which inputs do I need to supply when using a probe template?
      - What variables does a particular probe template revision expect?
      instructions:
      - text: List the inputs of probe template {identity} revision {revision} in hub {hubIdentity}.
        slots:
          identity: path.identity
          revision: query.revision
          hubIdentity: query.hubIdentity
      - text: Show the variables required by {identity} at revision {revision}.
        slots:
          identity: path.identity
          revision: query.revision
      method: generated
      generated: '2026-09-26'