Skip to content
GitmoapAPIBeta
Schema

ServiceDependencyList

A service's dependencies in one direction. The list is not paginated.

Shape

  • edgesarray of ServiceDependency
    • The ServiceDependency schema
    • confidencenumber · floatHow certain the dependency is: 1.0 for anything the platform observed or a person stated, lower only for a derived one.
    • from_service_idServiceId (string · uuid)
    • kindDependencyKindpackageapidatastoreotherHow a service depends on the far end of a dependency — not what the far end is. The same library service can be consumed as a package by one service and called over HTTP by another.
    • sourceDependencySourceobserved_lockfileobserved_publishdeclaredinferredHow a dependency came to be known, and therefore how far it can be trusted. A declared and an observed dependency between the same two services are reported separately, so a declaration no lockfile mentions, or a lockfile entry nobody declared, stands out.
    • toServiceSummary
      • 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
    • detailDependencyDetailoptional
      • The DependencyDetail schema
      • formatPackageRegistryFormatnpmcargopypior nulloptionalThe package ecosystem a registry speaks. A group has at most one registry per format.
      • lockfile_pathstring or nulloptional
      • package_namePackageName (string) or nulloptional
      • resolvedstring or nulloptionalThe version the lockfile actually pins.
      • version_reqstring or nulloptionalWhat the manifest asked for, where the lockfile records it.
    • observed_atstring or nulloptional
    • observed_repoRepositoryId (string · uuid) or nulloptionalThe repository whose file established this dependency — a lockfile for an observed one, a catalog file for a declared one.
    • observed_shastring or nulloptional
  • hiddeninteger · int320–∞Dependencies left out because you cannot see the service at the far end.
  • truncatedbooleanWhether the list stopped at its limit of 500 and more exist.

Example

Synthesized example
{
"edges": [
{
"confidence": 3,
"from_service_id": "30eeff08-a84e-48fb-9bbd-72d1ff42bd91",
"kind": "package",
"source": "observed_lockfile",
"to": {
"display_name": "Mara Okafor",
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"kind": "service",
"lifecycle": "experimental",
"service_id": "a3695b9b-62a2-4a31-b490-2b17613471ec",
"slug": "slug-1aa9",
"source": "inferred"
}
}
],
"hidden": 19,
"truncated": false
}

Graph

Used inside

No schema contains this one.

Used by