Skip to content

Validate Config

POST
/api/v1/configs/validate

Validate a pipeline configuration YAML without persisting it.

Always returns 200. Inspect is_valid / error_count to determine status.

ValidateConfigRequest

Request to validate a pipeline configuration without persisting it.

object
config_yaml
required
Config Yaml

Full YAML content to validate

string

Successful Response

ValidationReportResponse

Validation report returned by the config validator.

Returned verbatim in 200 responses from POST /configs/validate and embedded in 400 responses from create/update/run endpoints when validation fails.

object
is_valid
required
Is Valid

True when no errors present; warnings do not invalidate

boolean
issues
Issues

All findings, errors first then warnings

Array<object>
ValidationIssueResponse

A single validation finding emitted by the pipeline config validator.

object
severity
required
Severity

Error or warning

string
Allowed values: error warning
code
required
Code

Stable error code (e.g. E202, W501)

string
path
required
Path

Path into the config where the issue was found

string
message
required
Message

Human-readable description of the issue

string
suggestion
required
Suggestion

Deterministic, authoritative remediation guidance

string
error_count
required
Error Count

Number of errors

integer
warning_count
required
Warning Count

Number of warnings

integer

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object