Skip to content

Commit e31ff04

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit e4b2672f of spec repo
1 parent a863de0 commit e31ff04

40 files changed

Lines changed: 1128 additions & 58 deletions

File tree

.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.6",
7-
"regenerated": "2025-05-27 17:12:13.841874",
8-
"spec_repo_commit": "ed439f7c"
7+
"regenerated": "2025-05-30 12:38:58.286884",
8+
"spec_repo_commit": "e4b2672f"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-05-27 17:12:13.857049",
13-
"spec_repo_commit": "ed439f7c"
12+
"regenerated": "2025-05-30 12:38:58.418252",
13+
"spec_repo_commit": "e4b2672f"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 212 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -563,6 +563,14 @@ components:
563563
required: true
564564
schema:
565565
type: string
566+
KindID:
567+
description: Entity kind.
568+
in: path
569+
name: kind_id
570+
required: true
571+
schema:
572+
example: my-job
573+
type: string
566574
MetricID:
567575
description: The name of the log-based metric.
568576
in: path
@@ -19121,6 +19129,90 @@ components:
1912119129
- index
1912219130
- caseIndex
1912319131
type: object
19132+
KindAttributes:
19133+
description: Kind attributes.
19134+
properties:
19135+
description:
19136+
description: Short description of the kind.
19137+
type: string
19138+
displayName:
19139+
description: User friendly name of the kind.
19140+
type: string
19141+
name:
19142+
description: The kind name.
19143+
example: my-job
19144+
minLength: 1
19145+
type: string
19146+
type: object
19147+
KindData:
19148+
description: Schema that defines the structure of a Kind object in the Software
19149+
Catalog.
19150+
properties:
19151+
attributes:
19152+
$ref: '#/components/schemas/KindAttributes'
19153+
id:
19154+
description: A read-only globally unique identifier for the entity generated
19155+
by Datadog. User supplied values are ignored.
19156+
example: 4b163705-23c0-4573-b2fb-f6cea2163fcb
19157+
minLength: 1
19158+
type: string
19159+
meta:
19160+
$ref: '#/components/schemas/KindMetadata'
19161+
type:
19162+
description: Kind.
19163+
type: string
19164+
type: object
19165+
KindMetadata:
19166+
description: Kind metadata.
19167+
properties:
19168+
createdAt:
19169+
description: The creation time.
19170+
type: string
19171+
modifiedAt:
19172+
description: The modification time.
19173+
type: string
19174+
type: object
19175+
KindObj:
19176+
description: Schema for kind.
19177+
properties:
19178+
description:
19179+
description: Short description of the kind.
19180+
type: string
19181+
displayName:
19182+
description: The display name of the kind. Automatically generated if not
19183+
provided.
19184+
type: string
19185+
kind:
19186+
description: The name of the kind to create or update. This must be in kebab-case
19187+
format.
19188+
example: my-job
19189+
type: string
19190+
required:
19191+
- kind
19192+
type: object
19193+
KindRaw:
19194+
description: Kind definition in raw JSON or YAML representation.
19195+
example: 'kind: service
19196+
19197+
displayName: Service
19198+
19199+
description: A service entity in the catalog.
19200+
19201+
'
19202+
type: string
19203+
KindResponseData:
19204+
description: List of kind responses.
19205+
items:
19206+
$ref: '#/components/schemas/KindData'
19207+
type: array
19208+
KindResponseMeta:
19209+
description: Kind response metadata.
19210+
properties:
19211+
count:
19212+
description: Total kinds count.
19213+
format: int64
19214+
type: integer
19215+
type: object
1912419216
Layer:
1912519217
description: Encapsulates a layer resource, holding attributes like rotation
1912619218
details, plus relationships to the members covering that layer.
@@ -19607,6 +19699,14 @@ components:
1960719699
meta:
1960819700
$ref: '#/components/schemas/HistoricalJobListMeta'
1960919701
type: object
19702+
ListKindCatalogResponse:
19703+
description: List kind response.
19704+
properties:
19705+
data:
19706+
$ref: '#/components/schemas/KindResponseData'
19707+
meta:
19708+
$ref: '#/components/schemas/KindResponseMeta'
19709+
type: object
1961019710
ListPipelinesResponse:
1961119711
description: Represents the response payload containing a list of pipelines
1961219712
and associated metadata.
@@ -39205,6 +39305,19 @@ components:
3920539305
description: Upsert entity response included item.
3920639306
oneOf:
3920739307
- $ref: '#/components/schemas/EntityResponseIncludedSchema'
39308+
UpsertCatalogKindRequest:
39309+
description: Create or update kind request.
39310+
oneOf:
39311+
- $ref: '#/components/schemas/KindObj'
39312+
- $ref: '#/components/schemas/KindRaw'
39313+
UpsertCatalogKindResponse:
39314+
description: Upsert kind response.
39315+
properties:
39316+
data:
39317+
$ref: '#/components/schemas/KindResponseData'
39318+
meta:
39319+
$ref: '#/components/schemas/KindResponseMeta'
39320+
type: object
3920839321
Urgency:
3920939322
description: Specifies the level of urgency for a routing rule (low, high, or
3921039323
dynamic).
@@ -43442,6 +43555,105 @@ paths:
4344243555
summary: Delete a single entity
4344343556
tags:
4344443557
- Software Catalog
43558+
/api/v2/catalog/kind:
43559+
get:
43560+
description: Get a list of entity kinds from Software Catalog.
43561+
operationId: ListCatalogKind
43562+
parameters:
43563+
- $ref: '#/components/parameters/PageOffset'
43564+
- description: Maximum number of kinds in the response.
43565+
example: 100
43566+
in: query
43567+
name: page[limit]
43568+
required: false
43569+
schema:
43570+
default: 100
43571+
format: int64
43572+
type: integer
43573+
- $ref: '#/components/parameters/FilterByID'
43574+
- $ref: '#/components/parameters/FilterByName'
43575+
responses:
43576+
'200':
43577+
content:
43578+
application/json:
43579+
schema:
43580+
$ref: '#/components/schemas/ListKindCatalogResponse'
43581+
description: OK
43582+
'400':
43583+
$ref: '#/components/responses/BadRequestResponse'
43584+
'403':
43585+
$ref: '#/components/responses/ForbiddenResponse'
43586+
'429':
43587+
$ref: '#/components/responses/TooManyRequestsResponse'
43588+
security:
43589+
- apiKeyAuth: []
43590+
appKeyAuth: []
43591+
- AuthZ:
43592+
- apm_service_catalog_read
43593+
summary: Get a list of entity kinds
43594+
tags:
43595+
- Software Catalog
43596+
x-pagination:
43597+
limitParam: page[limit]
43598+
pageOffsetParam: page[offset]
43599+
resultsPath: data
43600+
post:
43601+
description: Create or update kinds in Software Catalog.
43602+
operationId: UpsertCatalogKind
43603+
requestBody:
43604+
content:
43605+
application/json:
43606+
schema:
43607+
$ref: '#/components/schemas/UpsertCatalogKindRequest'
43608+
description: Kind YAML or JSON.
43609+
required: true
43610+
responses:
43611+
'202':
43612+
content:
43613+
application/json:
43614+
schema:
43615+
$ref: '#/components/schemas/UpsertCatalogKindResponse'
43616+
description: ACCEPTED
43617+
'400':
43618+
$ref: '#/components/responses/BadRequestResponse'
43619+
'403':
43620+
$ref: '#/components/responses/ForbiddenResponse'
43621+
'429':
43622+
$ref: '#/components/responses/TooManyRequestsResponse'
43623+
security:
43624+
- apiKeyAuth: []
43625+
appKeyAuth: []
43626+
- AuthZ:
43627+
- apm_service_catalog_write
43628+
summary: Create or update kinds
43629+
tags:
43630+
- Software Catalog
43631+
x-codegen-request-body-name: body
43632+
/api/v2/catalog/kind/{kind_id}:
43633+
delete:
43634+
description: Delete a single kind in Software Catalog.
43635+
operationId: DeleteCatalogKind
43636+
parameters:
43637+
- $ref: '#/components/parameters/KindID'
43638+
responses:
43639+
'204':
43640+
description: OK
43641+
'400':
43642+
$ref: '#/components/responses/BadRequestResponse'
43643+
'403':
43644+
$ref: '#/components/responses/ForbiddenResponse'
43645+
'404':
43646+
$ref: '#/components/responses/NotFoundResponse'
43647+
'429':
43648+
$ref: '#/components/responses/TooManyRequestsResponse'
43649+
security:
43650+
- apiKeyAuth: []
43651+
appKeyAuth: []
43652+
- AuthZ:
43653+
- apm_service_catalog_write
43654+
summary: Delete a single kind
43655+
tags:
43656+
- Software Catalog
4344543657
/api/v2/catalog/relation:
4344643658
get:
4344743659
description: Get a list of entity relations from Software Catalog.

docs/datadog_api_client.v2.model.rst

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7963,6 +7963,41 @@ datadog\_api\_client.v2.model.jsonapi\_error\_response module
79637963
:members:
79647964
:show-inheritance:
79657965

7966+
datadog\_api\_client.v2.model.kind\_attributes module
7967+
-----------------------------------------------------
7968+
7969+
.. automodule:: datadog_api_client.v2.model.kind_attributes
7970+
:members:
7971+
:show-inheritance:
7972+
7973+
datadog\_api\_client.v2.model.kind\_data module
7974+
-----------------------------------------------
7975+
7976+
.. automodule:: datadog_api_client.v2.model.kind_data
7977+
:members:
7978+
:show-inheritance:
7979+
7980+
datadog\_api\_client.v2.model.kind\_metadata module
7981+
---------------------------------------------------
7982+
7983+
.. automodule:: datadog_api_client.v2.model.kind_metadata
7984+
:members:
7985+
:show-inheritance:
7986+
7987+
datadog\_api\_client.v2.model.kind\_obj module
7988+
----------------------------------------------
7989+
7990+
.. automodule:: datadog_api_client.v2.model.kind_obj
7991+
:members:
7992+
:show-inheritance:
7993+
7994+
datadog\_api\_client.v2.model.kind\_response\_meta module
7995+
---------------------------------------------------------
7996+
7997+
.. automodule:: datadog_api_client.v2.model.kind_response_meta
7998+
:members:
7999+
:show-inheritance:
8000+
79668001
datadog\_api\_client.v2.model.layer module
79678002
------------------------------------------
79688003

@@ -8215,6 +8250,13 @@ datadog\_api\_client.v2.model.list\_historical\_jobs\_response module
82158250
:members:
82168251
:show-inheritance:
82178252

8253+
datadog\_api\_client.v2.model.list\_kind\_catalog\_response module
8254+
------------------------------------------------------------------
8255+
8256+
.. automodule:: datadog_api_client.v2.model.list_kind_catalog_response
8257+
:members:
8258+
:show-inheritance:
8259+
82188260
datadog\_api\_client.v2.model.list\_pipelines\_response module
82198261
--------------------------------------------------------------
82208262

@@ -17098,6 +17140,20 @@ datadog\_api\_client.v2.model.upsert\_catalog\_entity\_response\_included\_item
1709817140
:members:
1709917141
:show-inheritance:
1710017142

17143+
datadog\_api\_client.v2.model.upsert\_catalog\_kind\_request module
17144+
-------------------------------------------------------------------
17145+
17146+
.. automodule:: datadog_api_client.v2.model.upsert_catalog_kind_request
17147+
:members:
17148+
:show-inheritance:
17149+
17150+
datadog\_api\_client.v2.model.upsert\_catalog\_kind\_response module
17151+
--------------------------------------------------------------------
17152+
17153+
.. automodule:: datadog_api_client.v2.model.upsert_catalog_kind_response
17154+
:members:
17155+
:show-inheritance:
17156+
1710117157
datadog\_api\_client.v2.model.urgency module
1710217158
--------------------------------------------
1710317159

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
"""
2+
Delete a single kind returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.software_catalog_api import SoftwareCatalogApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = SoftwareCatalogApi(api_client)
11+
api_instance.delete_catalog_kind(
12+
kind_id="my-job",
13+
)
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
"""
2+
Get a list of entity kinds returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.software_catalog_api import SoftwareCatalogApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = SoftwareCatalogApi(api_client)
11+
response = api_instance.list_catalog_kind()
12+
13+
print(response)
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
"""
2+
Get a list of entity kinds returns "OK" response with pagination
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.software_catalog_api import SoftwareCatalogApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = SoftwareCatalogApi(api_client)
11+
items = api_instance.list_catalog_kind_with_pagination()
12+
for item in items:
13+
print(item)

0 commit comments

Comments
 (0)