harness_schema
Fetch Harness YAML schema definitions or example snippets for any resource type. Drill into sections, search examples by keyword, or retrieve a full schema summary.
Instructions
Fetch Harness YAML schema or examples for a resource type. Pipeline/template schemas are bundled from harness-schema; connector, environment, service, secret, and infrastructure schemas are fetched live from NG /yaml-schema (pass scope, org_id, project_id). Use without path for a summary of fields and available sections. Use with path to drill into a specific section. Use with example to fetch a named example YAML snippet. Use with example_search to find examples by keyword. Precedence: example > example_search > path > summary. Available schemas: pipeline, template, trigger, pipeline_v1, template_v1, inputSet_v1, overlayInputSet_v1, agent-pipeline, connector, environment, service, secret, infrastructure.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | Dot-separated path to drill into a specific definition section. Omit for a top-level summary showing all available sections. | |
| scope | No | Harness YAML scope for live entity schemas (connector, environment, service, secret, infrastructure). Defaults to account. Org/project scoped entities require org_id and/or project_id. | |
| org_id | No | Organization identifier — required when scope is org or project (live entity schemas). | |
| example | No | Fetch a specific example by name (e.g. 'minimal-ci'). Returns the full YAML snippet and description. | |
| identifier | No | Optional entity identifier for NG yaml-schema. Use when updating an existing entity to fetch an entity-specific schema. Omit for generic create-time schemas — a placeholder identifier is sent automatically for all live entity types at any scope. | |
| project_id | No | Project identifier — required when scope is project (live entity schemas). | |
| resource_type | No | Schema to fetch. Available: pipeline, template, trigger, pipeline_v1, template_v1, inputSet_v1, overlayInputSet_v1, agent-pipeline, connector, environment, service, secret, infrastructure. Required for schema/path lookups, optional for example_search. | |
| example_search | No | Search examples by keyword. Returns matching example names and descriptions. Optionally combine with resource_type to filter. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||