Skip to content

Commit 70b59e5

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Regenerate client from commit 6a0ddfd8 of spec repo (#2535)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 4bbc1ea commit 70b59e5

24 files changed

+2893
-4
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.6",
7-
"regenerated": "2025-05-23 14:41:15.579944",
8-
"spec_repo_commit": "a4ecd4cf"
7+
"regenerated": "2025-05-23 16:55:09.290879",
8+
"spec_repo_commit": "6a0ddfd8"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-05-23 14:41:15.720803",
13-
"spec_repo_commit": "a4ecd4cf"
12+
"regenerated": "2025-05-23 16:55:09.383837",
13+
"spec_repo_commit": "6a0ddfd8"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 217 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -351,6 +351,7 @@ components:
351351
type: string
352352
FilterByRef:
353353
description: Filter entities by reference
354+
example: service:shopping-cart
354355
explode: true
355356
in: query
356357
name: filter[ref]
@@ -365,6 +366,32 @@ components:
365366
required: false
366367
schema:
367368
$ref: '#/components/schemas/RelationType'
369+
FilterRelationByFromRef:
370+
description: Filter relations by the reference of the first entity in the relation.
371+
example: service:shopping-cart
372+
explode: true
373+
in: query
374+
name: filter[from_ref]
375+
required: false
376+
schema:
377+
type: string
378+
FilterRelationByToRef:
379+
description: Filter relations by the reference of the second entity in the relation.
380+
example: service:shopping-cart
381+
explode: true
382+
in: query
383+
name: filter[to_ref]
384+
required: false
385+
schema:
386+
type: string
387+
FilterRelationByType:
388+
description: Filter relations by type.
389+
explode: true
390+
in: query
391+
name: filter[type]
392+
required: false
393+
schema:
394+
$ref: '#/components/schemas/RelationType'
368395
GCPSTSServiceAccountID:
369396
description: Your GCP STS enabled service account's unique ID.
370397
in: path
@@ -675,6 +702,14 @@ components:
675702
required: true
676703
schema:
677704
type: string
705+
RelationInclude:
706+
description: Include relationship data.
707+
explode: true
708+
in: query
709+
name: include
710+
required: false
711+
schema:
712+
$ref: '#/components/schemas/RelationIncludeType'
678713
ReportID:
679714
description: The ID of the report job.
680715
in: path
@@ -19491,6 +19526,38 @@ components:
1949119526
meta:
1949219527
$ref: '#/components/schemas/PowerpacksResponseMeta'
1949319528
type: object
19529+
ListRelationCatalogResponse:
19530+
description: List entity relation response.
19531+
properties:
19532+
data:
19533+
$ref: '#/components/schemas/RelationResponseData'
19534+
included:
19535+
$ref: '#/components/schemas/ListRelationCatalogResponseIncluded'
19536+
links:
19537+
$ref: '#/components/schemas/ListRelationCatalogResponseLinks'
19538+
meta:
19539+
$ref: '#/components/schemas/RelationResponseMeta'
19540+
type: object
19541+
ListRelationCatalogResponseIncluded:
19542+
description: List relation response included entities.
19543+
items:
19544+
$ref: '#/components/schemas/EntityData'
19545+
type: array
19546+
ListRelationCatalogResponseLinks:
19547+
description: List relation response links.
19548+
properties:
19549+
next:
19550+
description: Next link.
19551+
example: /api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=2
19552+
type: string
19553+
previous:
19554+
description: Previous link.
19555+
type: string
19556+
self:
19557+
description: Current link.
19558+
example: /api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=0
19559+
type: string
19560+
type: object
1949419561
ListRulesResponse:
1949519562
description: Scorecard rules response.
1949619563
properties:
@@ -28773,6 +28840,114 @@ components:
2877328840
x-enum-varnames:
2877428841
- ANY
2877528842
- ALL
28843+
RelationAttributes:
28844+
description: Relation attributes.
28845+
properties:
28846+
from:
28847+
$ref: '#/components/schemas/RelationEntity'
28848+
to:
28849+
$ref: '#/components/schemas/RelationEntity'
28850+
type:
28851+
$ref: '#/components/schemas/RelationType'
28852+
type: object
28853+
RelationEntity:
28854+
description: Relation entity reference.
28855+
properties:
28856+
kind:
28857+
description: Entity kind.
28858+
type: string
28859+
name:
28860+
description: Entity name.
28861+
type: string
28862+
namespace:
28863+
description: Entity namespace.
28864+
type: string
28865+
type: object
28866+
RelationIncludeType:
28867+
description: Supported include types for relations.
28868+
enum:
28869+
- entity
28870+
- schema
28871+
type: string
28872+
x-enum-varnames:
28873+
- ENTITY
28874+
- SCHEMA
28875+
RelationMeta:
28876+
description: Relation metadata.
28877+
properties:
28878+
createdAt:
28879+
description: Relation creation time.
28880+
format: date-time
28881+
type: string
28882+
definedBy:
28883+
description: Relation defined by.
28884+
type: string
28885+
modifiedAt:
28886+
description: Relation modification time.
28887+
format: date-time
28888+
type: string
28889+
source:
28890+
description: Relation source.
28891+
type: string
28892+
type: object
28893+
RelationRelationships:
28894+
description: Relation relationships.
28895+
properties:
28896+
fromEntity:
28897+
$ref: '#/components/schemas/RelationToEntity'
28898+
toEntity:
28899+
$ref: '#/components/schemas/RelationToEntity'
28900+
type: object
28901+
RelationResponse:
28902+
description: Relation response data.
28903+
properties:
28904+
attributes:
28905+
$ref: '#/components/schemas/RelationAttributes'
28906+
id:
28907+
description: Relation ID.
28908+
type: string
28909+
meta:
28910+
$ref: '#/components/schemas/RelationMeta'
28911+
relationships:
28912+
$ref: '#/components/schemas/RelationRelationships'
28913+
subtype:
28914+
description: Relation subtype.
28915+
type: string
28916+
type:
28917+
$ref: '#/components/schemas/RelationResponseType'
28918+
type: object
28919+
RelationResponseData:
28920+
description: Array of relation responses
28921+
items:
28922+
$ref: '#/components/schemas/RelationResponse'
28923+
type: array
28924+
RelationResponseMeta:
28925+
description: Relation response metadata.
28926+
properties:
28927+
count:
28928+
description: Total relations count.
28929+
format: int64
28930+
type: integer
28931+
includeCount:
28932+
description: Total included data count.
28933+
format: int64
28934+
type: integer
28935+
type: object
28936+
RelationResponseType:
28937+
description: Relation type.
28938+
enum:
28939+
- relation
28940+
type: string
28941+
x-enum-varnames:
28942+
- RELATION
28943+
RelationToEntity:
28944+
description: Relation to entity.
28945+
properties:
28946+
data:
28947+
$ref: '#/components/schemas/RelationshipItem'
28948+
meta:
28949+
$ref: '#/components/schemas/EntityMeta'
28950+
type: object
2877628951
RelationType:
2877728952
description: Supported relation types.
2877828953
enum:
@@ -43187,6 +43362,48 @@ paths:
4318743362
summary: Delete a single entity
4318843363
tags:
4318943364
- Software Catalog
43365+
/api/v2/catalog/relation:
43366+
get:
43367+
description: Get a list of entity relations from Software Catalog.
43368+
operationId: ListCatalogRelation
43369+
parameters:
43370+
- $ref: '#/components/parameters/PageOffset'
43371+
- description: Maximum number of relations in the response.
43372+
example: 100
43373+
in: query
43374+
name: page[limit]
43375+
required: false
43376+
schema:
43377+
default: 100
43378+
format: int64
43379+
type: integer
43380+
- $ref: '#/components/parameters/FilterRelationByType'
43381+
- $ref: '#/components/parameters/FilterRelationByFromRef'
43382+
- $ref: '#/components/parameters/FilterRelationByToRef'
43383+
- $ref: '#/components/parameters/RelationInclude'
43384+
responses:
43385+
'200':
43386+
content:
43387+
application/json:
43388+
schema:
43389+
$ref: '#/components/schemas/ListRelationCatalogResponse'
43390+
description: OK
43391+
'403':
43392+
$ref: '#/components/responses/ForbiddenResponse'
43393+
'429':
43394+
$ref: '#/components/responses/TooManyRequestsResponse'
43395+
security:
43396+
- apiKeyAuth: []
43397+
appKeyAuth: []
43398+
- AuthZ:
43399+
- apm_service_catalog_read
43400+
summary: Get a list of entity relations
43401+
tags:
43402+
- Software Catalog
43403+
x-pagination:
43404+
limitParam: page[limit]
43405+
pageOffsetParam: page[offset]
43406+
resultsPath: data
4319043407
/api/v2/ci/pipeline:
4319143408
post:
4319243409
description: 'Send your pipeline event to your Datadog platform over HTTP. For

docs/datadog_api_client.v2.model.rst

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8152,6 +8152,20 @@ datadog\_api\_client.v2.model.list\_powerpacks\_response module
81528152
:members:
81538153
:show-inheritance:
81548154

8155+
datadog\_api\_client.v2.model.list\_relation\_catalog\_response module
8156+
----------------------------------------------------------------------
8157+
8158+
.. automodule:: datadog_api_client.v2.model.list_relation_catalog_response
8159+
:members:
8160+
:show-inheritance:
8161+
8162+
datadog\_api\_client.v2.model.list\_relation\_catalog\_response\_links module
8163+
-----------------------------------------------------------------------------
8164+
8165+
.. automodule:: datadog_api_client.v2.model.list_relation_catalog_response_links
8166+
:members:
8167+
:show-inheritance:
8168+
81558169
datadog\_api\_client.v2.model.list\_rules\_response module
81568170
----------------------------------------------------------
81578171

@@ -12051,6 +12065,69 @@ datadog\_api\_client.v2.model.readiness\_gate\_threshold\_type module
1205112065
:members:
1205212066
:show-inheritance:
1205312067

12068+
datadog\_api\_client.v2.model.relation\_attributes module
12069+
---------------------------------------------------------
12070+
12071+
.. automodule:: datadog_api_client.v2.model.relation_attributes
12072+
:members:
12073+
:show-inheritance:
12074+
12075+
datadog\_api\_client.v2.model.relation\_entity module
12076+
-----------------------------------------------------
12077+
12078+
.. automodule:: datadog_api_client.v2.model.relation_entity
12079+
:members:
12080+
:show-inheritance:
12081+
12082+
datadog\_api\_client.v2.model.relation\_include\_type module
12083+
------------------------------------------------------------
12084+
12085+
.. automodule:: datadog_api_client.v2.model.relation_include_type
12086+
:members:
12087+
:show-inheritance:
12088+
12089+
datadog\_api\_client.v2.model.relation\_meta module
12090+
---------------------------------------------------
12091+
12092+
.. automodule:: datadog_api_client.v2.model.relation_meta
12093+
:members:
12094+
:show-inheritance:
12095+
12096+
datadog\_api\_client.v2.model.relation\_relationships module
12097+
------------------------------------------------------------
12098+
12099+
.. automodule:: datadog_api_client.v2.model.relation_relationships
12100+
:members:
12101+
:show-inheritance:
12102+
12103+
datadog\_api\_client.v2.model.relation\_response module
12104+
-------------------------------------------------------
12105+
12106+
.. automodule:: datadog_api_client.v2.model.relation_response
12107+
:members:
12108+
:show-inheritance:
12109+
12110+
datadog\_api\_client.v2.model.relation\_response\_meta module
12111+
-------------------------------------------------------------
12112+
12113+
.. automodule:: datadog_api_client.v2.model.relation_response_meta
12114+
:members:
12115+
:show-inheritance:
12116+
12117+
datadog\_api\_client.v2.model.relation\_response\_type module
12118+
-------------------------------------------------------------
12119+
12120+
.. automodule:: datadog_api_client.v2.model.relation_response_type
12121+
:members:
12122+
:show-inheritance:
12123+
12124+
datadog\_api\_client.v2.model.relation\_to\_entity module
12125+
---------------------------------------------------------
12126+
12127+
.. automodule:: datadog_api_client.v2.model.relation_to_entity
12128+
:members:
12129+
:show-inheritance:
12130+
1205412131
datadog\_api\_client.v2.model.relation\_type module
1205512132
---------------------------------------------------
1205612133

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 relations 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_relation()
12+
13+
print(response)
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
"""
2+
Get a list of entity relations 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_relation_with_pagination(
12+
page_limit=20,
13+
)
14+
for item in items:
15+
print(item)

0 commit comments

Comments
 (0)