DeploymentBoardResponse
A page of the deployment board: services down the side, environments across the top, and the current deployment in each cell.
Shape
environmentsarray of EnvironmentSummary
- The EnvironmentSummary schema
- archivedboolean
- environment_idEnvironmentId (string · uuid)
- scopeScopeRef
- slugEnvironmentSlug (string)
- tierEnvironmentTierdevelopmenttestingstagingproductionWhat kind of environment this is, whatever it is called:
development,testing,stagingorproduction. Aproductionenvironment is protected by default. - display_namestring or nulloptional
- urlstring or nulloptional
rowsarray of DeploymentBoardRow
- The DeploymentBoardRow schema
cellsarray of DeploymentBoardCell
- The DeploymentBoardCell schema
- environment_idEnvironmentId (string · uuid)
- commits_behindinteger · int32 or nulloptional0–∞How many commits the deployment is behind its repository's default branch. Only present when the request asks for it.
deploymentDeploymentSummary or nulloptional
- The DeploymentSummary schema
- commit_shastring
- deployed_atstring
- deployment_idDeploymentId (string · uuid)
- environment_idEnvironmentId (string · uuid)
- repository_idRepositoryId (string · uuid)
- service_idServiceId (string · uuid)
- statusDeploymentStatusrequestedawaiting_approvalrejectedrunningsucceededfailedcancelledsupersededskippedWhere a deployment is in its life. It starts
requested; waits asawaiting_approvalwhen the environment needs approval, endingrejectedif refused; thenrunning, endingsucceeded,failedorcancelled.skippedmeans another deploy held the environment and its policy is to skip. A successful deployment becomessupersededwhen a later one replaces it. - pipeline_run_idPipelineRunId (string · uuid) or nulloptional
serviceServiceSummary
- The ServiceSummary schema
- display_namestring
- group_idGroupId (string · uuid)
- kindServiceKindservicelibrarywebsitejobdatastoreapiml_modelotherWhat sort of thing a service is. The kind decides which scorecard checks apply: a
libraryhas no deployments, so a deployment check is not applicable to it rather than failing. For your own classifications, use annotations. - lifecycleServiceLifecycleexperimentalproductiondeprecatedretiredWhere a service is in its life.
- service_idServiceId (string · uuid)
- slugServiceSlug (string)
- sourceServiceSourceinferreddeclaredapiHow the catalog entry came to exist. Set by the platform, never accepted from a request. Any source other than
inferredmeans a person has vouched for the entry. - externalbooleanoptional
- orphaned_atstring or nulloptional
- next_tokenstring or nulloptional
Example
Synthesized example{
"environments": [
{
"archived": false,
"environment_id": "a2e6d30b-6085-4dfe-9c20-5e938fb581ef",
"scope": {
"group": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69"
},
"slug": "slug-ab22",
"tier": "development"
},
{
"archived": false,
"environment_id": "f282e7b6-f369-40a0-ad7c-fec973b75dfc",
"scope": {
"group": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69"
},
"slug": "slug-e8d6",
"tier": "development"
}
],
"rows": [
{
"cells": [],
"service": {
"display_name": "Mara Okafor",
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"kind": "service",
"lifecycle": "experimental",
"service_id": "d106ac94-1b2a-4031-8149-8afb78d20dcd",
"slug": "slug-88c9",
"source": "inferred"
}
}
],
"next_token": "next-token-7c58"
}
Graph
Used inside
No schema contains this one.
Used by
Sent by 0 operations
No operation takes it as a request body.
Returned by 1 operation