Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness System API

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

$.info
$.paths['/sto/api/v2/system/health'].get
$.paths['/sto/api/v2/system/version'].get
$.paths['/pm/api/v1/system/health'].get
$.paths['/pm/api/v1/system/version'].get
$.paths['/iacm/api/health'].get
$.paths['/iacm/api/latest-plugin-version'].post
$.paths['/iacm/api/provisioners/{provisioner}/config'].get
$.paths['/iacm/api/provisioners/supported/{provisioner}'].get
$.paths['/iacm/api/version'].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 System API
  version: 1.0.0
extends: openapi/harness-system-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: 9
- target: $.paths['/sto/api/v2/system/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the STO service health
      effect: read
      questions:
      - Is the Security Testing Orchestration service up right now?
      - Can I ping STO to confirm it's healthy?
      instructions:
      - text: Check STO service health.
      - text: Ping the security testing service health endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/system/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the STO service version
      effect: read
      questions:
      - Which version of the Security Testing Orchestration service is running?
      - Can I find out what STO build is deployed?
      instructions:
      - text: Get the STO service version.
      - text: Report which security testing service release is live.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pm/api/v1/system/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the policy management service health
      effect: read
      questions:
      - Is the policy management service responding?
      - Can I health-check the governance policy engine?
      instructions:
      - text: Check the policy management service health.
      - text: Ping the policy engine to confirm it's up.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pm/api/v1/system/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the policy management service version
      effect: read
      questions:
      - What version of the policy management service is deployed?
      - Can I read the governance policy engine's version number?
      instructions:
      - text: Get the policy management service version.
      - text: Show which policy engine release is running.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the IaCM server health
      effect: read
      questions:
      - Is the Infrastructure as Code Management server healthy?
      - Can I verify IaCM is reachable before running a workspace?
      instructions:
      - text: Check IaCM server health.
      - text: Ping the infrastructure-as-code server.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/latest-plugin-version'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up the latest IaCM plugin version
      effect: read
      questions:
      - Is the IaCM plugin I'm running the newest release?
      - Can I find the latest plugin version given my current commit and version?
      instructions:
      - text: Get the latest IaCM plugin version for commit {commit} and version {version}.
        slots:
          commit: requestBody.commit
          version: requestBody.version
      - text: Check if plugin version {version} at commit {commit} is the latest.
        slots:
          commit: requestBody.commit
          version: requestBody.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/provisioners/{provisioner}/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an IaC provisioner's configuration
      effect: read
      questions:
      - What configuration settings does a given IaC provisioner expose?
      - Can I see a provisioner's settings together with its supported versions?
      instructions:
      - text: Get the configuration for provisioner {provisioner}.
        slots:
          provisioner: path.provisioner
      - text: Show the provisioner config for {provisioner}, including its settings.
        slots:
          provisioner: path.provisioner
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/provisioners/supported/{provisioner}'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported versions of a provisioner
      effect: read
      questions:
      - Which versions of a provisioner can my IaCM workspaces use?
      - Is a particular provisioner version supported by IaCM?
      instructions:
      - text: List supported versions for provisioner {provisioner}.
        slots:
          provisioner: path.provisioner
      - text: Tell me which {provisioner} releases IaCM accepts.
        slots:
          provisioner: path.provisioner
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the IaCM server version
      effect: read
      questions:
      - Which IaCM server version is deployed?
      - Can I read the infrastructure-as-code server's build version?
      instructions:
      - text: Get the IaCM server version.
      - text: Report the infrastructure-as-code server release.
      method: generated
      generated: '2026-09-26'