Skip to content

Commit 545f422

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
service catalog openapi spec for v2.1 schema (#1387)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 63edd0f commit 545f422

File tree

32 files changed

+1380
-79
lines changed

32 files changed

+1380
-79
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.4",
7-
"regenerated": "2023-03-28 08:41:43.325643",
8-
"spec_repo_commit": "21917b12"
7+
"regenerated": "2023-03-29 13:52:26.833708",
8+
"spec_repo_commit": "1f3268e7"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.4",
12-
"regenerated": "2023-03-28 08:41:43.337636",
13-
"spec_repo_commit": "21917b12"
12+
"regenerated": "2023-03-29 13:52:26.848231",
13+
"spec_repo_commit": "1f3268e7"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 205 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12101,6 +12101,7 @@ components:
1210112101
oneOf:
1210212102
- $ref: '#/components/schemas/ServiceDefinitionV1'
1210312103
- $ref: '#/components/schemas/ServiceDefinitionV2'
12104+
- $ref: '#/components/schemas/ServiceDefinitionV2Dot1'
1210412105
type: object
1210512106
ServiceDefinitionV1:
1210612107
deprecated: true
@@ -12331,6 +12332,209 @@ components:
1233112332
- name
1233212333
- url
1233312334
type: object
12335+
ServiceDefinitionV2Dot1:
12336+
description: Service definition v2.1 for providing service metadata and integrations.
12337+
properties:
12338+
application:
12339+
description: Identifier for a group of related services serving a product
12340+
feature, which the service is a part of.
12341+
example: my-app
12342+
type: string
12343+
contacts:
12344+
description: A list of contacts related to the services.
12345+
items:
12346+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1Contact'
12347+
type: array
12348+
dd-service:
12349+
description: Unique identifier of the service. Must be unique across all
12350+
services and is used to match with a service in Datadog.
12351+
example: my-service
12352+
type: string
12353+
description:
12354+
description: A short description of the service.
12355+
example: My service description
12356+
type: string
12357+
extensions:
12358+
additionalProperties: {}
12359+
description: Extensions to v2.1 schema.
12360+
example:
12361+
myorg/extension: extensionValue
12362+
type: object
12363+
integrations:
12364+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1Integrations'
12365+
lifecycle:
12366+
description: The current life cycle phase of the service.
12367+
example: sandbox
12368+
type: string
12369+
links:
12370+
description: A list of links related to the services.
12371+
items:
12372+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1Link'
12373+
type: array
12374+
schema-version:
12375+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1Version'
12376+
tags:
12377+
description: A set of custom tags.
12378+
example:
12379+
- my:tag
12380+
- service:tag
12381+
items:
12382+
type: string
12383+
type: array
12384+
team:
12385+
description: Team that owns the service. It is used to locate a team defined
12386+
in Datadog Teams if it exists.
12387+
example: my-team
12388+
type: string
12389+
tier:
12390+
description: Importance of the service.
12391+
example: High
12392+
type: string
12393+
required:
12394+
- schema-version
12395+
- dd-service
12396+
type: object
12397+
ServiceDefinitionV2Dot1Contact:
12398+
description: Service owner's contacts information.
12399+
oneOf:
12400+
- $ref: '#/components/schemas/ServiceDefinitionV2Dot1Email'
12401+
- $ref: '#/components/schemas/ServiceDefinitionV2Dot1Slack'
12402+
ServiceDefinitionV2Dot1Email:
12403+
description: Service owner's email.
12404+
properties:
12405+
contact:
12406+
description: Contact value.
12407+
12408+
format: email
12409+
type: string
12410+
name:
12411+
description: Contact email.
12412+
example: Team Email
12413+
type: string
12414+
type:
12415+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1EmailType'
12416+
required:
12417+
- type
12418+
- contact
12419+
type: object
12420+
ServiceDefinitionV2Dot1EmailType:
12421+
description: Contact type.
12422+
enum:
12423+
- email
12424+
example: email
12425+
type: string
12426+
x-enum-varnames:
12427+
- EMAIL
12428+
ServiceDefinitionV2Dot1Integrations:
12429+
description: Third party integrations that Datadog supports.
12430+
properties:
12431+
opsgenie:
12432+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1Opsgenie'
12433+
pagerduty:
12434+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1Pagerduty'
12435+
type: object
12436+
ServiceDefinitionV2Dot1Link:
12437+
description: Service's external links.
12438+
properties:
12439+
name:
12440+
description: Link name.
12441+
example: Runbook
12442+
type: string
12443+
provider:
12444+
description: Link provider.
12445+
example: Github
12446+
type: string
12447+
type:
12448+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1LinkType'
12449+
url:
12450+
description: Link URL.
12451+
example: https://my-runbook
12452+
type: string
12453+
required:
12454+
- name
12455+
- type
12456+
- url
12457+
type: object
12458+
ServiceDefinitionV2Dot1LinkType:
12459+
description: Link type.
12460+
enum:
12461+
- doc
12462+
- repo
12463+
- runbook
12464+
- dashboard
12465+
- other
12466+
example: runbook
12467+
type: string
12468+
x-enum-varnames:
12469+
- DOC
12470+
- REPO
12471+
- RUNBOOK
12472+
- DASHBOARD
12473+
- OTHER
12474+
ServiceDefinitionV2Dot1Opsgenie:
12475+
description: Opsgenie integration for the service.
12476+
properties:
12477+
region:
12478+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1OpsgenieRegion'
12479+
service-url:
12480+
description: Opsgenie service url.
12481+
example: https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000
12482+
type: string
12483+
required:
12484+
- service-url
12485+
type: object
12486+
ServiceDefinitionV2Dot1OpsgenieRegion:
12487+
description: Opsgenie instance region.
12488+
enum:
12489+
- US
12490+
- EU
12491+
example: US
12492+
type: string
12493+
x-enum-varnames:
12494+
- US
12495+
- EU
12496+
ServiceDefinitionV2Dot1Pagerduty:
12497+
description: PagerDuty integration for the service.
12498+
properties:
12499+
service-url:
12500+
description: PagerDuty service url.
12501+
example: https://my-org.pagerduty.com/service-directory/PMyService
12502+
type: string
12503+
type: object
12504+
ServiceDefinitionV2Dot1Slack:
12505+
description: Service owner's Slack channel.
12506+
properties:
12507+
contact:
12508+
description: Slack Channel.
12509+
example: https://yourcompany.slack.com/archives/channel123
12510+
type: string
12511+
name:
12512+
description: Contact Slack.
12513+
example: Team Slack
12514+
type: string
12515+
type:
12516+
$ref: '#/components/schemas/ServiceDefinitionV2Dot1SlackType'
12517+
required:
12518+
- type
12519+
- contact
12520+
type: object
12521+
ServiceDefinitionV2Dot1SlackType:
12522+
description: Contact type.
12523+
enum:
12524+
- slack
12525+
example: slack
12526+
type: string
12527+
x-enum-varnames:
12528+
- SLACK
12529+
ServiceDefinitionV2Dot1Version:
12530+
default: v2.1
12531+
description: Schema version being used.
12532+
enum:
12533+
- v2.1
12534+
example: v2.1
12535+
type: string
12536+
x-enum-varnames:
12537+
- V2_1
1233412538
ServiceDefinitionV2Email:
1233512539
description: Service owner's email.
1233612540
properties:
@@ -12489,6 +12693,7 @@ components:
1248912693
ServiceDefinitionsCreateRequest:
1249012694
description: Create service definitions request.
1249112695
oneOf:
12696+
- $ref: '#/components/schemas/ServiceDefinitionV2Dot1'
1249212697
- $ref: '#/components/schemas/ServiceDefinitionV2'
1249312698
- $ref: '#/components/schemas/ServiceDefinitionRaw'
1249412699
ServiceDefinitionsListResponse:

docs/datadog_api_client.v2.model.rst

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5671,6 +5671,90 @@ service\_definition\_v2\_doc
56715671
:members:
56725672
:show-inheritance:
56735673

5674+
service\_definition\_v2\_dot1
5675+
-----------------------------
5676+
5677+
.. automodule:: datadog_api_client.v2.model.service_definition_v2_dot1
5678+
:members:
5679+
:show-inheritance:
5680+
5681+
service\_definition\_v2\_dot1\_contact
5682+
--------------------------------------
5683+
5684+
.. automodule:: datadog_api_client.v2.model.service_definition_v2_dot1_contact
5685+
:members:
5686+
:show-inheritance:
5687+
5688+
service\_definition\_v2\_dot1\_email
5689+
------------------------------------
5690+
5691+
.. automodule:: datadog_api_client.v2.model.service_definition_v2_dot1_email
5692+
:members:
5693+
:show-inheritance:
5694+
5695+
service\_definition\_v2\_dot1\_email\_type
5696+
------------------------------------------
5697+
5698+
.. automodule:: datadog_api_client.v2.model.service_definition_v2_dot1_email_type
5699+
:members:
5700+
:show-inheritance:
5701+
5702+
service\_definition\_v2\_dot1\_integrations
5703+
-------------------------------------------
5704+
5705+
.. automodule:: datadog_api_client.v2.model.service_definition_v2_dot1_integrations
5706+
:members:
5707+
:show-inheritance:
5708+
5709+
service\_definition\_v2\_dot1\_link
5710+
-----------------------------------
5711+
5712+
.. automodule:: datadog_api_client.v2.model.service_definition_v2_dot1_link
5713+
:members:
5714+
:show-inheritance:
5715+
5716+
service\_definition\_v2\_dot1\_link\_type
5717+
-----------------------------------------
5718+
5719+
.. automodule:: datadog_api_client.v2.model.service_definition_v2_dot1_link_type
5720+
:members:
5721+
:show-inheritance:
5722+
5723+
service\_definition\_v2\_dot1\_opsgenie
5724+
---------------------------------------
5725+
5726+
.. automodule:: datadog_api_client.v2.model.service_definition_v2_dot1_opsgenie
5727+
:members:
5728+
:show-inheritance:
5729+
5730+
service\_definition\_v2\_dot1\_opsgenie\_region
5731+
-----------------------------------------------
5732+
5733+
.. automodule:: datadog_api_client.v2.model.service_definition_v2_dot1_opsgenie_region
5734+
:members:
5735+
:show-inheritance:
5736+
5737+
service\_definition\_v2\_dot1\_pagerduty
5738+
----------------------------------------
5739+
5740+
.. automodule:: datadog_api_client.v2.model.service_definition_v2_dot1_pagerduty
5741+
:members:
5742+
:show-inheritance:
5743+
5744+
service\_definition\_v2\_dot1\_slack
5745+
------------------------------------
5746+
5747+
.. automodule:: datadog_api_client.v2.model.service_definition_v2_dot1_slack
5748+
:members:
5749+
:show-inheritance:
5750+
5751+
service\_definition\_v2\_dot1\_slack\_type
5752+
------------------------------------------
5753+
5754+
.. automodule:: datadog_api_client.v2.model.service_definition_v2_dot1_slack_type
5755+
:members:
5756+
:show-inheritance:
5757+
56745758
service\_definition\_v2\_email
56755759
------------------------------
56765760

0 commit comments

Comments
 (0)