Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Products API

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

$.info

$.paths['/sto/api/v2/products'].get

$.paths['/sto/api/v2/products/{id}'].get

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 Products API
  version: 1.0.0
extends: openapi/harness-products-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: 2
- target: $.paths['/sto/api/v2/products'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported security scan tools
      effect: read
      questions:
      - Which security scan tools can I use with security testing orchestration?
      - Can I search the supported scanners by name?
      instructions:
      - text: List the available scan tools.
      - text: Find scan tools named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/products/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scan tool by ID
      effect: read
      questions:
      - What details are recorded for one scan tool?
      - Can I look up a security scanner by its product ID?
      instructions:
      - text: Get scan tool {id}.
        slots:
          id: path.id
      - text: Show the details of scanner product {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'