Service

Shape

• created_atstring
• display_namestring
• group_idGroupId (string · uuid)The declaring group — where the entry lives for listing and quota purposes. Not necessarily the owner.
• 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.
• updated_atstring
• versioninteger · int64The service's revision, incremented on every change. Send it with an update to have the update refused with a 409 if someone changed the service since you read it.
• annotationsobjectoptional
• api_specsarray of ApiSpecRefoptional

  • The ApiSpecRef schema
  • pathRepoPath (string)
  • repository_idRepositoryId (string · uuid)
  • spec_kindApiSpecKindopenapigrpcasyncapiWhich interface-description format a spec is written in.
• created_byActorSummary or nulloptional

  • The ActorSummary schema
  • emailstring
  • idstring
  • usernamestring
  • avatar_urlstring or nulloptional
• descriptionstring or nulloptional
• externalbooleanoptionalWhether the service is built outside gitmoap — a vendor SaaS, a service on another forge, a database provisioned elsewhere. The catalog records its name, owner and the dependencies on it, and nothing else. An external service has no repository paths.
• linksarray of ServiceLinkoptional

  • The ServiceLink schema
  • link_typeServiceLinkTyperunbookdashboarddocschatotherWhat a service link points at. other covers anything the listed kinds do not.
  • urlHttpsUrl (string)
• orphaned_atstring or nulloptionalWhen the catalog file declaring this service stopped declaring it. The service is kept, with its history, rather than deleted.
• ownerOwnerRef or nulloptionalWho owns the service. Absent when nobody does.
• providesarray of ProvidedArtifactoptional

  • The ProvidedArtifact schema
  • formatPackageRegistryFormatnpmcargopypiThe package ecosystem a registry speaks. A group has at most one registry per format.
  • namePackageName (string)
• repo_pathsarray of ServiceRepoPathoptional

  • The ServiceRepoPath schema
  • path_globstring
  • path_prefixstringThe longest literal prefix of path_glob, worked out by the platform. Read-only.
  • repository_idRepositoryId (string · uuid)
  • is_excludebooleanoptionalWhether this glob removes its matches from the service's paths instead of adding them. It affects only its own service.

Graph

Used by