Skip to content
GitmoapAPIBeta
Schema

UpdateServiceRequest

A partial update. Each owner field is three-state: absent leaves it alone, null clears it, and a value sets it.

Shape

  • annotationsobjectoptional
  • api_specsarray of ApiSpecRef or nulloptional
    • The ApiSpecRef schema
    • pathRepoPath (string)
    • repository_idRepositoryId (string · uuid)
    • spec_kindApiSpecKindopenapigrpcasyncapiWhich interface-description format a spec is written in.
  • descriptionstring or nulloptional
  • display_namestring or nulloptional
  • externalboolean or nulloptional
  • kindServiceKindservicelibrarywebsitejobdatastoreapiml_modelotheror nulloptionalWhat 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.
  • lifecycleServiceLifecycleexperimentalproductiondeprecatedretiredor nulloptionalWhere a service is in its life.
  • linksarray of ServiceLink or nulloptional
    • The ServiceLink schema
    • link_typeServiceLinkTyperunbookdashboarddocschatotherWhat a service link points at. other covers anything the listed kinds do not.
    • urlHttpsUrl (string)
  • owner_group_idGroupId (string · uuid) or nulloptional
  • owner_principal_idPrincipalId (string · uuid) or nulloptional
  • owner_team_idTeamId (string · uuid) or nulloptional
  • providesarray of ProvidedArtifact or nulloptional
    • The ProvidedArtifact schema
    • formatPackageRegistryFormatnpmcargopypiThe package ecosystem a registry speaks. A group has at most one registry per format.
    • namePackageName (string)
  • repo_pathsarray of ServiceRepoPathInput or nulloptional
  • slugServiceSlug (string) or nulloptional
  • versioninteger · int64 or nulloptionalThe version you last read. When given and the service has changed since, the update is refused with a 409.

Example

Synthesized example
{
"annotations": {},
"api_specs": [
{
"path": "path-4620",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70",
"spec_kind": "openapi"
},
{
"path": "path-1bc5",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70",
"spec_kind": "openapi"
}
],
"description": "Renders each region as density contours of its operations.",
"display_name": "Lin Park",
"external": false,
"kind": "service",
"lifecycle": "experimental",
"links": [
{
"link_type": "runbook",
"url": "https://gitmoap.example/acme/23cc709f"
}
],
"owner_group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"owner_principal_id": "a5144291-2826-4949-be80-55854234acca",
"owner_team_id": "d53c53fb-b480-4deb-b432-27475b61b9f2",
"provides": [
{
"format": "npm",
"name": "payments-api"
},
{
"format": "npm",
"name": "payments-api"
}
],
"repo_paths": [
{
"path_glob": "path-glob-f55b",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70"
},
{
"path_glob": "path-glob-558a",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70"
}
],
"slug": "slug-0126",
"version": 20
}

Graph

Used inside

No schema contains this one.

Used by

Returned by 0 operations

No operation returns it directly.