Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Healthsources API

7 actions 7 updates phrasing extends openapi/harness-healthsources-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['/cv/api/health-sources'].get
$.paths['/cv/api/health-sources'].put
$.paths['/cv/api/health-sources'].post
$.paths['/cv/api/health-sources/{identifier}'].get
$.paths['/cv/api/health-sources/{identifier}'].delete
$.paths['/cv/api/health-sources/{identifier}/runtime-inputs'].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 Healthsources API
  version: 1.0.0
extends: openapi/harness-healthsources-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['/cv/api/health-sources'].get
  update:
    x-apievangelist-phrasing:
      intent: List health sources
      effect: read
      questions:
      - Which monitoring health sources are configured in my project?
      - What metric and log sources does continuous verification pull from?
      instructions:
      - text: List the health sources in project {projectIdentifier}.
        slots:
          projectIdentifier: query.projectIdentifier
      - text: Show every configured health source.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/health-sources'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a health source
      effect: write
      questions:
      - How do I change the queries a health source runs?
      - Can I point an existing health source at a different connector?
      instructions:
      - text: Update health source {identifier} named {name} to use connector {connectorRef} with type {dataSourceType} and queries {queryDefinitions}.
        slots:
          identifier: requestBody.identifier
          name: requestBody.name
          connectorRef: requestBody.connectorRef
          dataSourceType: requestBody.dataSourceType
          queryDefinitions: requestBody.queryDefinitions
      - text: Change the query definitions of existing health source {identifier} to {queryDefinitions}.
        slots:
          identifier: requestBody.identifier
          queryDefinitions: requestBody.queryDefinitions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/health-sources'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a health source
      effect: write
      questions:
      - Can I add a new metrics or logs source for deployment verification?
      - What connector and queries does a new health source need?
      instructions:
      - text: Create health source {name} ({identifier}) of type {dataSourceType} via connector {connectorRef} with queries {queryDefinitions}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          dataSourceType: requestBody.dataSourceType
          connectorRef: requestBody.connectorRef
          queryDefinitions: requestBody.queryDefinitions
      - text: Add a new {dataSourceType} health source called {name} using {connectorRef}.
        slots:
          dataSourceType: requestBody.dataSourceType
          name: requestBody.name
          connectorRef: requestBody.connectorRef
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/health-sources/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a health source
      effect: read
      questions:
      - What queries and connector does a given health source use?
      - Can I see the full configuration of one health source?
      instructions:
      - text: Show health source {identifier}.
        slots:
          identifier: path.identifier
      - text: Get the configuration of health source {identifier} in project {projectIdentifier}.
        slots:
          identifier: path.identifier
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/health-sources/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a health source
      effect: destructive
      questions:
      - Is it possible to remove a health source we no longer monitor?
      - What happens to verification when I delete its health source?
      instructions:
      - text: Delete health source {identifier}.
        slots:
          identifier: path.identifier
      - text: Remove health source {identifier} from project {projectIdentifier}.
        slots:
          identifier: path.identifier
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/health-sources/{identifier}/runtime-inputs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get runtime inputs for a health source
      effect: read
      questions:
      - Which values in a health source have to be supplied at runtime?
      - What runtime inputs does this health source expect?
      instructions:
      - text: List the runtime inputs of health source {identifier}.
        slots:
          identifier: path.identifier
      - text: Show what must be provided at runtime for health source {identifier}.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'