Skip to content
GitmoapAPIBeta
Schema

ComponentUpgradeImpact

What moving every pipeline that uses the component onto one published version would involve. The counts and entries cover the pipelines you can read, up to the number one report examines; truncated says when there were more.

Shape

  • needs_repininteger · int320–∞
  • on_targetinteger · int320–∞
  • sampledinteger · int320–∞How many consumers were re-expanded against the target to see whether they still validate.
  • target_versionComponentVersion (string)
  • total_usagesinteger · int320–∞
  • unresolvableinteger · int320–∞
  • entriesarray of ComponentUpgradeEntryoptional
    • The ComponentUpgradeEntry schema
    • dispositionUpgradeDispositionon_targetneeds_repinunresolvableWhere a pipeline using the component stands against the target version: on_target (its reference already selects it), needs_repin (its reference has to be changed to reach it) or unresolvable (its reference selects no version at all, because every candidate has been retired).
    • instance_idNodeId (string)
    • pipeline_idPipelineId (string · uuid)
    • pipeline_namePipelineName (string)
    • repository_idRepositoryId (string · uuid)
    • version_refComponentVersionRef (string)
    • resolves_toComponentVersion (string) or nulloptionalThe version the pipeline's reference selects at the moment — for a floating reference, possibly newer than when the pipeline was last saved. Absent when it selects none.
  • sample_failuresarray of BlastRadiusFailureoptional
    • The BlastRadiusFailure schema
    • pipeline_idPipelineId (string · uuid)
    • pipeline_namePipelineName (string)
    • repository_idRepositoryId (string · uuid)
    • violationsValidationSummary
      • The ValidationSummary schema
      • validboolean
      • violationsarray of ValidationViolation
      • 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.
  • truncatedbooleanoptionalTrue when the component has more consumers than one report covers. The remainder are reached by narrowing to a target version, or by reading the usage listing directly.

Example

Synthesized example
{
"needs_repin": 39,
"on_target": 69,
"sampled": 64,
"target_version": "target-version-21ca",
"total_usages": 5,
"unresolvable": 35,
"entries": [
{
"disposition": "on_target",
"instance_id": "ca2fb77c-9004-4a97-b2c8-c7e98be82b85",
"pipeline_id": "983ef3dd-4a05-430b-bb06-7ccc255b6fcf",
"pipeline_name": "payments-api",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70",
"version_ref": "version-ref-d0c1"
},
{
"disposition": "on_target",
"instance_id": "22f0f933-48a5-40b5-82b3-1735dcf39315",
"pipeline_id": "28d8a04a-0396-47c5-bf7a-16af4849a556",
"pipeline_name": "payments-api",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70",
"version_ref": "version-ref-80ea"
}
],
"sample_failures": [
{
"pipeline_id": "fdceeb93-4798-4549-833a-51dddfeb37d2",
"pipeline_name": "payments-api",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70",
"violations": {
"valid": false,
"violations": []
}
}
],
"truncated": false
}

Graph

Used inside

No schema contains this one.

Used by