ServiceOverview

Shape

• debtServiceDebt

  • The ServiceDebt schema
  • driftedinteger · int320–∞
  • open_bugsinteger · int320–∞
  • rowsarray of AnchorDebtRow

    • The AnchorDebtRow schema
    • driftedinteger · int320–∞
    • markersinteger · int320–∞
    • open_bugsinteger · int320–∞
    • open_storiesinteger · int320–∞
    • pathRepoPath (string)
    • totalinteger · int320–∞
    • ownersarray of ActorSummaryoptionalWho the repository's CODEOWNERS file says owns this file. Absent when there is no CODEOWNERS file, or it names nobody for this path.

      • The ActorSummary schema
      • emailstring
      • idstring
      • usernamestring
      • avatar_urlstring or nulloptional
• dependency_countsDependencyCountsHow many dependencies the service has and how many services depend on it, with how many of those you cannot see.

  • The DependencyCounts schema
  • hiddeninteger · int320–∞Dependencies left out, in either direction, because you cannot see the service at the far end.
  • inboundinteger · int320–∞
  • outboundinteger · int320–∞
• open_merge_requestsinteger · int320–∞
• repositoriesarray of ServiceRepositoryRefThe repositories holding the service's code. Repositories you cannot see are left out.

  • The ServiceRepositoryRef schema
  • default_branchstring
  • full_pathstring
  • path_globsarray of string
  • repository_idRepositoryId (string · uuid)
  • visibilityVisibilitypublicinternalprivate
• serviceService

  • The Service schema
  • 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.
• current_deploymentsarray of DeploymentSummaryoptionalWhat is currently deployed, one entry per environment the service is running in. Absent when it has never been deployed.

  • The DeploymentSummary schema
  • commit_shastring
  • deployed_atstring
  • deployment_idDeploymentId (string · uuid)
  • environment_idEnvironmentId (string · uuid)
  • repository_idRepositoryId (string · uuid)
  • service_idServiceId (string · uuid)
  • 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.
  • pipeline_run_idPipelineRunId (string · uuid) or nulloptional
• latest_pipeline_runPipelineRunSummary or nulloptional

  • The PipelineRunSummary schema
  • pipeline_namestring
  • pipeline_run_idPipelineRunId (string · uuid)
  • repo_idRepositoryId (string · uuid)
  • started_atstring
  • statusPipelineStatusrunningsucceededsucceeded_with_warningsfailedtimed_outcancelledPer-PipelineRun status.
  • triggerTriggerContext

    • The TriggerContext schema
    • repo_idRepositoryId (string · uuid)
    • repo_pathstring
    • before_shastring or nulloptionalThe commit the ref pointed at before the push — what a paths filter compares against. On a run started by hand, the commit its starter named to compare from, if any.
    • branchstring or nulloptional
    • buildMrBuildTargetmerge_resultsourceor nulloptionalWhich commit a merge-request-triggered run built.
    • commit_shastring or nulloptional
    • depthinteger · int32optional0–∞How many pushes made by pipeline runs led to this run, one after another; 0 when no pipeline's push started it.
    • every_stepbooleanoptionalEvery step runs, whatever its path filter says — asked for by whoever started the run.
    • extraobjectoptionalAdditional fields supplied by whatever started the run, passed along without being interpreted.
    • kindTriggerKindpushmerge_requesttagschedulemanualoptionalWhat started this run.
    • mr_idMergeRequestId (integer · int64) or nulloptional
    • paramsobjectoptionalThe values a person supplied when starting the run, keyed by the parameter names the pipeline's manual trigger declares.
    • ref_namestring or nulloptionalThe full ref (e.g. refs/tags/v1.2.0). Set for runs a tag started, which branch cannot describe.
    • root_group_idGroupId (string · uuid) or nulloptionalThe organisation this run belongs to — the root group of the repository it was triggered for. Recorded when the run starts and never recalculated, so a repository moved to a different organisation part-way through a run keeps the artifacts, logs and cache it has already produced. Absent on runs that started before runs recorded this.
    • schedule_stemstring or nulloptionalWhich scheduled trigger fired, when kind is schedule.
    • source_shastring or nulloptionalThe source-branch commit this run tested: a merge request's source head for a merge-request run, whichever commit it built, and the commit itself for a push or manual run. Set by the platform; absent on a run whose graph the caller supplied, which never counts toward a merge request's pipelines.
    • target_branchstring or nulloptionalThe merge request's target branch.
    • target_shastring or nulloptionalThe target branch's tip this merge-request run was tested against. Once the target branch moves on, the merge check reports a merge-result run as out of date.
    • triggered_byActorSummaryoptionalWho started the run, set by the platform from the authenticated caller; a value supplied in a request is ignored.

      • The ActorSummary schema
      • emailstring
      • idstring
      • usernamestring
      • avatar_urlstring or nulloptional
    • trustTriggerTrusttrusteduntrustedoptionalWhether the code being built is trusted with the repository's connections and secrets. Set by the platform when the run starts, whatever a request says.
    • trust_reasonTrustReason or nulloptionalWhy the run has the trust it has: who wrote the code, a person's merge or approval, or the organization's AI configuration. Absent on runs that started before this was recorded.
  • finished_atstring or nulloptional
  • pipeline_idPipelineId (string · uuid) or nulloptionalThe pipeline definition this run was started from. Absent when that definition has since been deleted; pipeline_name still names what ran.
  • re_run_ofPipelineRunId (string · uuid) or nulloptional
  • stagesarray of StageRollupoptionalPer-stage counts of how many steps are in each status, in execution order — enough to draw the run's shape in a list. Empty for older runs recorded before these counts existed.

    • The StageRollup schema
    • barrier_passedbooleanWhether every step in the stage has finished.
    • countsNodeStatusCounts

      • The NodeStatusCounts schema
      • awaiting_approvalinteger · int32optional0–∞
      • cancelledinteger · int32optional0–∞
      • dispatchedinteger · int32optional0–∞
      • failedinteger · int32optional0–∞
      • pendinginteger · int32optional0–∞
      • runninginteger · int32optional0–∞
      • skippedinteger · int32optional0–∞
      • succeededinteger · int32optional0–∞
      • timed_outinteger · int32optional0–∞
    • stage_idStageId (string)
    • stage_indexinteger · int320–∞
    • tolerated_failuresinteger · int32optional0–∞How many of the stage's failed or timed-out steps were allowed to fail, so they degrade the run rather than fail it. Left out when zero.
• latest_releaseRelease or nulloptional

  • The Release schema
  • authorActorSummaryWho created the release.

    • The ActorSummary schema
    • emailstring
    • idstring
    • usernamestring
    • avatar_urlstring or nulloptional
  • commit_shaCommitHash (string)The commit the tag pointed to when the release was created.
  • created_atstring
  • nameReleaseName (string)
  • repository_idRepositoryId (string · uuid)
  • tag_nameTagName (string)
  • updated_atstring
  • assetsarray of ReleaseAssetoptionalThe release's files. Included when a single release is fetched.

    • The ReleaseAsset schema
    • asset_idReleaseAssetId (string · uuid)
    • content_typestring
    • created_atstring
    • nameAssetName (string)
    • repository_idRepositoryId (string · uuid)
    • sizeinteger · int640–∞
    • stateAssetStateuploadingavailableWhether a release file has been uploaded: uploading (an upload URL was issued, but the upload has not been confirmed yet) or available.
    • tag_nameTagName (string)
    • updated_atstring
    • uploaderActorSummaryWho uploaded the file.

      • The ActorSummary schema
      • emailstring
      • idstring
      • usernamestring
      • avatar_urlstring or nulloptional
    • download_urlstring or nulloptionalWhere to download the file.
  • bodyReleaseBody (string) or nulloptional
  • draftbooleanoptionalWhether the release is an unpublished draft, visible only to people with Developer access or above.
  • prereleasebooleanoptionalWhether the release is marked as a pre-release. A pre-release is never returned as the latest release.
  • published_atstring or nulloptionalSet when the release leaves draft.
  • tarball_urlstring or nulloptionalWhere to download the tagged source as a .tar.gz archive.
  • versioninteger · int64optional0–∞Increases with every change. Send it with an update so that a change made since you read the release is not overwritten.
  • zipball_urlstring or nulloptionalWhere to download the tagged source as a .zip archive.
• ownerOwnerRef or nulloptional
• scorecardsarray of ServiceScorecardSummaryoptionalEvery scorecard that applies to this service, with the level it reaches and its check counts. Absent when no scorecard applies.

  • The ServiceScorecardSummary schema
  • countsCheckStateCounts

    • The CheckStateCounts schema
    • expiredinteger · int320–∞
    • failinginteger · int320–∞
    • not_applicableinteger · int320–∞
    • passinginteger · int320–∞
    • staleinteger · int320–∞
    • unknowninteger · int320–∞
  • namestring
  • scorecard_idScorecardId (string · uuid)
  • slugScorecardSlug (string)
  • levelstring or nulloptionalThe highest level every required check satisfies, or null when the scorecard has no levels or the service reaches none of them.

Graph

Used by