Skip to content
GitmoapAPIBeta
Schema

ValidatePipelineRunResponse

The result of checking a pipeline graph without running it. valid is true when violations is empty; resolved names the provider image each step would run; warnings are advisories that do not block a run, such as a deprecated provider version.

Shape

  • resolvedarray of ResolvedNodeImage
    • The ResolvedNodeImage schema
    • cache_enabledboolean
    • capability_idCapabilityId (string)
    • default_timeout_secondsinteger · int320–∞
    • image_uristring
    • node_idNodeId (string)
    • provider_idProviderId (string)
    • requires_dockerboolean
    • resolved_versionProviderVersion (string)
    • version_sourceVersionSourcenodegroup_defaulttrack_latestWhere a step's provider version came from: node (the step pins it), group_default (the default version set for the repository or a group above it) or track_latest (the latest published version when the run started).
    • image_digeststring or nulloptional
  • validboolean
  • violationsarray of ProviderViolation
    • The ProviderViolation schema
    • codeViolationCodeprovider_not_enabledprovider_disabledprovider_tier_not_acceptedprovider_version_unspecifiedprovider_version_not_allowedprovider_version_not_in_catalogcapability_not_in_versionprovider_version_sunsetprovider_namespace_not_verifiedprovider_private_foreign_orgWhy steps failed the provider checks made when a run starts. Each code is stable: match on the code, never on the message.
    • detailstring
    • node_idsarray of NodeId (string)
    • provider_idProviderId (string)
    • allowedVersionPolicy or nulloptionalThe version policy that refused requested_version, when that is the cause.
    • capability_idCapabilityId (string) or nulloptional
    • denying_scope_idstring or nulloptionalThe id of the group or repository where the provider is disabled, when that is the cause.
    • requested_versionProviderVersion (string) or nulloptional
  • warningsarray of ProviderWarningoptional
    • The ProviderWarning schema
    • codeWarningCodeprovider_version_deprecatedprovider_version_sunset_pendingAn advisory about a step's provider version that does not stop the run: provider_version_deprecated (the version still runs but is discouraged) or provider_version_sunset_pending (the version is sunset and its grace period is running out).
    • detailstring
    • node_idsarray of NodeId (string)
    • provider_idProviderId (string)
    • requested_versionProviderVersion (string) or nulloptional

Example

Synthesized example
{
"resolved": [
{
"cache_enabled": false,
"capability_id": "1669bb9b-1760-4f5d-80c5-1046f7b60f12",
"default_timeout_seconds": 59,
"image_uri": "https://gitmoap.example/acme/79b0d189",
"node_id": "e37b9de5-81fc-4a90-93da-ad9cf5b21ac4",
"provider_id": "c15d8732-534c-44ba-8cb5-34e1f8b78a4b",
"requires_docker": false,
"resolved_version": "resolved-version-54d7",
"version_source": "node"
}
],
"valid": false,
"violations": [
{
"code": "provider_not_enabled",
"detail": "detail-1049",
"node_ids": [],
"provider_id": "b36aa7b4-f102-4e3d-838b-6214b0183659"
},
{
"code": "provider_not_enabled",
"detail": "detail-254e",
"node_ids": [],
"provider_id": "4fe851ad-b973-4736-bcf6-774d41ad315a"
}
],
"warnings": [
{
"code": "provider_version_deprecated",
"detail": "detail-ae55",
"node_ids": [],
"provider_id": "6a572678-3019-4ffd-8881-37812dd24bc8"
}
]
}

Graph

Used inside

No schema contains this one.

Used by

Sent by 0 operations

No operation takes it as a request body.