Skip to content
GitmoapAPIBeta
Schema

PublishComponentVersionResponse

What a publish did, or — under dry_run — what it would do.

Shape

  • blast_radiusComponentBlastRadius
    • The ComponentBlastRadius schema
    • floating_pipelinesinteger · int320–∞Pipelines whose reference would resolve to this version.
    • sampledinteger · int320–∞How many of them were re-expanded and re-validated.
    • 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.
  • capability_requirementsarray of CapabilityId (string)
  • contract_changeContractChangepatchminormajorHow far the contract moved between the last published version and the draft.
  • depthinteger · int320–∞
  • expanded_node_countinteger · int320–∞
  • minimum_versionComponentVersion (string)The lowest version the compatibility gate permits for this contract delta.
  • variable_requirementsarray of EnvironmentVariableName (string)The variables the version's steps read from the pipeline that uses it.
  • versionComponentVersion (string)

Example

Synthesized example
{
"blast_radius": {
"floating_pipelines": 16,
"sampled": 40,
"sample_failures": [
{
"pipeline_id": "5aa028db-85ea-4e06-8503-784706e1d311",
"pipeline_name": "payments-api",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70",
"violations": {
"valid": false,
"violations": []
}
}
]
},
"capability_requirements": [
"capability-requirements-890d"
],
"contract_change": "patch",
"depth": 42,
"expanded_node_count": 7,
"minimum_version": "minimum-version-2656",
"variable_requirements": [
"variable-requirements-f703"
],
"version": "version-607e"
}

Graph

Used inside

No schema contains this one.

Used by