Skip to content
GitmoapAPIBeta
Schema

ValidationSummary

The result of validating a pipeline definition: reported on a draft, and returned with a 400 when saving a published definition fails. Each problem carries a stable code.

Shape

  • validboolean
  • violationsarray of ValidationViolation
    • The ValidationViolation schema
    • codestringStable machine-readable code (e.g. cycle_detected, type_mismatch, required_input_not_wired).
    • messagestringHuman-readable description.
    • targetValidationTarget
      • The ValidationTarget schema
      • kindValidationTargetKindpipelinestagenodeedgecomponent_instanceWhich kind of element a validation violation targets.
      • idstringoptionalId of the stage, step, connection or component instance at fault; empty for a problem with the pipeline as a whole.
  • warningsarray of ValidationWarningoptionalThings worth knowing that do not make the definition invalid, such as a deprecated component version. A violation stops a published definition from being saved; a warning never does. Left out when there are none.
    • The ValidationWarning schema
    • codestringStable machine code — the warning rule's own name, exactly as a violation's is.
    • messagestring
    • targetValidationTarget
      • The ValidationTarget schema
      • kindValidationTargetKindpipelinestagenodeedgecomponent_instanceWhich kind of element a validation violation targets.
      • idstringoptionalId of the stage, step, connection or component instance at fault; empty for a problem with the pipeline as a whole.

Example

Synthesized example
{
"valid": false,
"violations": [
{
"code": "code-4a4c",
"message": "Draw the region map from operation density",
"target": {
"kind": "pipeline"
}
},
{
"code": "code-71e9",
"message": "Draw the region map from operation density",
"target": {
"kind": "pipeline"
}
}
],
"warnings": [
{
"code": "code-583f",
"message": "Stream pipeline status into the run header",
"target": {
"kind": "pipeline"
}
}
]
}

Graph

Used inside
Contains

Used by

Sent by 0 operations

No operation takes it as a request body.

Returned by 11 operations