Skip to content
GitmoapAPIBeta
Schema

ListResponse_ServiceListItem

Shape

  • itemsarray of object
    • deploymentsarray of ServiceTierDeploymentAt most one entry per tier, ordered development, testing, staging, production. Empty for a library, an external service, or anything never deployed.
      • The ServiceTierDeployment schema
      • deployedboolean
      • statusDeploymentStatusrequestedawaiting_approvalrejectedrunningsucceededfailedcancelledsupersededskippedWhere a deployment is in its life. It starts requested; waits as awaiting_approval when the environment needs approval, ending rejected if refused; then running, ending succeeded, failed or cancelled. skipped means another deploy held the environment and its policy is to skip. A successful deployment becomes superseded when a later one replaces it.
      • tierEnvironmentTierdevelopmenttestingstagingproductionWhat kind of environment this is, whatever it is called: development, testing, staging or production. A production environment is protected by default.
    • 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 library has 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 inferred means a person has vouched for the entry.
      • externalbooleanoptional
      • orphaned_atstring or nulloptional
      • ownerOwnerRef or nulloptional
  • next_tokenstring or nulloptional

Example

Synthesized example
{
"items": [
{
"deployments": [
{
"deployed": false,
"status": "requested",
"tier": "development"
},
{
"deployed": false,
"status": "requested",
"tier": "development"
}
],
"service": {
"display_name": "Tomás Reyes",
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"kind": "service",
"lifecycle": "experimental",
"service_id": "5f753002-572e-4f30-9d98-712d46b5b28b",
"slug": "slug-7fb0",
"source": "inferred"
}
},
{
"deployments": [
{
"deployed": false,
"status": "requested",
"tier": "development"
}
],
"service": {
"display_name": "Tomás Reyes",
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"kind": "service",
"lifecycle": "experimental",
"service_id": "d7c58962-8afb-481a-9826-1347e036edfc",
"slug": "slug-9651",
"source": "inferred"
}
}
],
"next_token": "next-token-df5e"
}

Graph

Used inside

No schema contains this one.

Used by