Skip to content
GitmoapAPIBeta
Schema

ServiceListItem

One entry in the service catalog listing: a service, and how far along the promotion track it has got.

Shape

  • 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

Example

Synthesized example
{
"deployments": [
{
"deployed": false,
"status": "requested",
"tier": "development"
},
{
"deployed": false,
"status": "requested",
"tier": "development"
}
],
"service": {
"display_name": "Lin Park",
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"kind": "service",
"lifecycle": "experimental",
"service_id": "9221e5c1-5802-4f3c-9237-1eeb5f984279",
"slug": "slug-ccb0",
"source": "inferred",
"external": false,
"orphaned_at": "2026-10-16T19:00:31Z",
"owner": {
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"kind": "group",
"full_path": "acme/payments-api"
}
}
}

Graph

Used by

Sent by 0 operations

No operation takes it as a request body.

Returned by 0 operations

No operation returns it directly.