Skip to content
GitmoapAPIBeta
Shipcatalog
GET/catalog/services/{service_id}/dependents

List the services that depend on this service

list_service_dependents
  • catalog:read
    A token needs the catalog:read scope: Read the service catalog: services, their bindings, their owners and their overviewsGranted by read_api, write_api.Every operation this scope unlocks
  • Filtered across resources

    x-gitmoap-isolation: {"kind":"cross_resource_filtered"}

Returns each inbound dependency with its kind (package, api or datastore), how it was learned, and the repository whose file established it. A dependent you cannot see is left out but counted, and a very large list is cut short and flagged. Anyone who can see the service may call it.

Parameters

Path
  • service_idServiceId (string · uuid)The service's id

Responses

200Inbound edges, each with its source and provenance, and a count of any dropped because their far end is not visibleapplication/json
  • 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.
200 exampleSynthesized example
{
"edges": [
{
"confidence": 87,
"from_service_id": "e9437fe6-1d31-4193-bf16-0fbd661c1825",
"kind": "package",
"source": "observed_lockfile",
"to": {
"display_name": "Mara Okafor",
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"kind": "service",
"lifecycle": "experimental",
"service_id": "cced649a-2985-48b7-b6b4-063d57a89d41",
"slug": "slug-0760",
"source": "inferred"
}
}
],
"hidden": 56,
"truncated": false
}
400Bad request — a path parameter is not a well-formed value of its typeapplication/json
Error codes
  • BAD_REQUESTThe request is malformed: a parameter or a body field is not a well-formed value of its type
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
400 exampleSynthesized example
{
"error": {
"code": "code-9d65",
"message": "Label every synthesized example"
}
}
401Unauthenticated — no credential, or an invalid oneapplication/json
Error codes
  • UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
401 exampleSynthesized example
{
"error": {
"code": "code-5814",
"message": "Stream pipeline status into the run header"
}
}
403Forbidden — the caller's access level or token scope is insufficientapplication/json
Error codes
  • FORBIDDENYou are signed in but may not do this here; reason names the permission or the rule that refused it
  • INSUFFICIENT_SCOPEThe access token lacks the scope this operation needs; required_scope names it
  • PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
403 exampleSynthesized example
{
"error": {
"code": "code-830e",
"message": "Inline scalar newtypes but keep their brand"
}
}
404No such service, or it is not visible to the callerapplication/json
Error codes
  • NOT_FOUNDThe resource does not exist — or exists and you cannot see it: a private resource you have no access to answers exactly as an absent one does
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
404 exampleSynthesized example
{
"error": {
"code": "code-1177",
"message": "Inline scalar newtypes but keep their brand"
}
}

CLI

gitmoap catalog list-service-dependents

  • --service-ididThe service's id

Used in these guides