CreateServiceRequest
Shape
- slugServiceSlug (string)
- annotationsobjectoptional
api_specsarray of ApiSpecRefoptional
- 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 nulloptionalDefaults to the slug.
- externalbooleanoptional
- kindServiceKindservicelibrarywebsitejobdatastoreapiml_modelotheroptionalWhat sort of thing a service is. The kind decides which scorecard checks apply: a
libraryhas no deployments, so a deployment check is not applicable to it rather than failing. For your own classifications, use annotations. - lifecycleServiceLifecycleexperimentalproductiondeprecatedretiredoptionalWhere a service is in its life.
linksarray of ServiceLinkoptional
- The ServiceLink schema
- link_typeServiceLinkTyperunbookdashboarddocschatotherWhat a service link points at.
othercovers anything the listed kinds do not. - urlHttpsUrl (string)
- owner_group_idGroupId (string · uuid) or nulloptionalThe group that owns this service. Naming a group here requires Maintainer on that group as well, since it makes that team responsible for the service.
- owner_principal_idPrincipalId (string · uuid) or nulloptional
- owner_team_idTeamId (string · uuid) or nulloptionalThe team that owns this service. Naming a team here requires maintaining that team, or managing the organization's teams.
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 ServiceRepoPathInputoptional
- The ServiceRepoPathInput schema
- path_globstring
- repository_idRepositoryId (string · uuid)
- is_excludebooleanoptional
Example
Synthesized example{
"slug": "slug-a90a",
"annotations": {},
"api_specs": [
{
"path": "path-832c",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70",
"spec_kind": "openapi"
},
{
"path": "path-dde9",
"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/59372966"
},
{
"link_type": "runbook",
"url": "https://gitmoap.example/acme/8464007f"
}
],
"owner_group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"owner_principal_id": "fecadf32-ee5d-446d-aca9-bfa2fd9a797b",
"owner_team_id": "2064176f-fa19-4ba8-9058-2bfb102d0266",
"provides": [
{
"format": "npm",
"name": "payments-api"
},
{
"format": "npm",
"name": "payments-api"
}
],
"repo_paths": [
{
"path_glob": "path-glob-818b",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70"
}
]
}
Graph
Used inside
No schema contains this one.
Used by
Sent by 1 operation
Returned by 0 operations
No operation returns it directly.