Skip to content
GitmoapAPIBeta
Schema

BlastRadiusFailure

One sampled pipeline that would stop validating.

Shape

  • pipeline_idPipelineId (string · uuid)
  • pipeline_namePipelineName (string)
  • repository_idRepositoryId (string · uuid)
  • violationsValidationSummary
    • The ValidationSummary schema
    • 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
{
"pipeline_id": "0f0b07b3-f2d9-4bd7-935a-3c916e15c421",
"pipeline_name": "payments-api",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70",
"violations": {
"valid": false,
"violations": [
{
"code": "code-71a2",
"message": "Inline scalar newtypes but keep their brand",
"target": {
"kind": "pipeline"
}
},
{
"code": "code-f088",
"message": "Draw the region map from operation density",
"target": {
"kind": "pipeline"
}
}
],
"warnings": [
{
"code": "code-29b3",
"message": "Pin a page's payload to the build that rendered it",
"target": {
"kind": "pipeline"
}
},
{
"code": "code-50c7",
"message": "Pin a page's payload to the build that rendered it",
"target": {
"kind": "pipeline"
}
}
]
}
}

Graph

Used inside
Contains

Used by

Sent by 0 operations

No operation takes it as a request body.

Returned by 0 operations

No operation returns it directly.