Skip to content
GitmoapAPIBeta
Schema

ComponentRepinReport

What a re-pin did, or would do.

Shape

  • candidatesinteger · int320–∞Consumers matching the filter that the sweep looked at, before authorization or validation.
  • dry_runbooleanTrue when nothing was written and the report describes what would have happened.
  • toComponentVersionRef (string)
  • repinnedarray of RepinnedPipelineoptional
  • skippedarray of RepinSkipoptional
    • The RepinSkip schema
    • pipeline_idPipelineId (string · uuid)
    • pipeline_namePipelineName (string)
    • reasonRepinSkipReasonforbiddenunreadablealready_pinnedvalidation_failedpipeline_missingWhy a re-pin left a pipeline unchanged: forbidden (you cannot manage its pipelines), unreadable (you cannot read its repository), already_pinned (it already uses the requested reference), validation_failed (the change would make it invalid) or pipeline_missing (the pipeline no longer exists).
    • repository_idRepositoryId (string · uuid)
    • detailstring or nulloptionalWhat went wrong, when the reason alone does not say. Carries the validation message for a pipeline that would stop validating.
  • truncatedbooleanoptionalTrue when the component has more consumers than one sweep examines. The remainder are reached by running the sweep again.

Example

Synthesized example
{
"candidates": 25,
"dry_run": false,
"to": "to-2a86",
"repinned": [
{
"instances": [],
"pipeline_id": "ef583e4f-54f4-4c18-8140-755f7db7e821",
"pipeline_name": "payments-api",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70"
},
{
"instances": [],
"pipeline_id": "c506c44d-7b14-4e28-bb2b-ce489e94fda1",
"pipeline_name": "payments-api",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70"
}
],
"skipped": [
{
"pipeline_id": "4193a112-5c1d-4271-94b6-6d0d4e8216cd",
"pipeline_name": "payments-api",
"reason": "forbidden",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70"
}
],
"truncated": false
}

Graph

Used inside

No schema contains this one.

Used by