Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Schemas API

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

$.info
$.paths['/v1/pipeline-schema/individual-schema'].get
$.paths['/v1/pipeline-schema/inputs-schema'].post
$.paths['/v1/template-schema/individual-schema'].get
$.paths['/v1/template-schema/inputs-schema'].post

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 Schemas API
  version: 1.0.0
extends: openapi/harness-schemas-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: 4
- target: $.paths['/v1/pipeline-schema/individual-schema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the JSON schema for a pipeline step or stage
      effect: read
      questions:
      - Where can I get the JSON schema for one pipeline step or stage type?
      - Can I fetch the static schema for a step group or strategy node?
      instructions:
      - text: Get the pipeline schema for node type {type} in group {group}.
        slots:
          type: query.node_type
          group: query.node_group
      - text: Fetch the version {version} static pipeline schema for step {type}.
        slots:
          version: query.version
          type: query.node_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/pipeline-schema/inputs-schema'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the runtime inputs schema of a pipeline
      effect: read
      questions:
      - What runtime inputs does my pipeline YAML expect, as a schema?
      - Can I derive an input schema from a pipeline definition?
      instructions:
      - text: Get the inputs schema for pipeline YAML {yaml}.
        slots:
          yaml: requestBody.pipeline_yaml
      - text: 'Work out the runtime inputs of this pipeline: {yaml}.'
        slots:
          yaml: requestBody.pipeline_yaml
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/template-schema/individual-schema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the JSON schema for a template node
      effect: read
      questions:
      - Where do I get the schema for a step or stage template type?
      - Can I fetch a template's JSON schema for a specific version?
      instructions:
      - text: Get the template schema for node type {type} in group {group}.
        slots:
          type: query.node_type
          group: query.node_group
      - text: Fetch version {version} of the template schema for {type}.
        slots:
          version: query.version
          type: query.node_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/template-schema/inputs-schema'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the inputs schema of a template
      effect: read
      questions:
      - What inputs does a template YAML expect when someone uses it?
      - Can I derive an inputs schema from a template definition in a project?
      instructions:
      - text: Get the inputs schema for template YAML {yaml}.
        slots:
          yaml: requestBody.template_yaml
      - text: Work out the template inputs of {yaml} in project {project}.
        slots:
          yaml: requestBody.template_yaml
          project: query.project_id
      method: generated
      generated: '2026-09-26'