Skip to content

Commit d16d10c

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit d057f518 of spec repo
1 parent ce42b5d commit d16d10c

21 files changed

+1253
-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-01 18:50:09.495821",
8-
"spec_repo_commit": "7eb88f6a"
7+
"regenerated": "2025-05-01 19:52:04.727667",
8+
"spec_repo_commit": "d057f518"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-05-01 18:50:09.512639",
13-
"spec_repo_commit": "7eb88f6a"
12+
"regenerated": "2025-05-01 19:52:04.743575",
13+
"spec_repo_commit": "d057f518"
1414
}
1515
}
1616
}

‎.generator/schemas/v2/openapi.yaml

Lines changed: 217 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -335,6 +335,7 @@ components:
335335
type: string
336336
FilterByRef:
337337
description: Filter entities by reference
338+
example: service:shopping-cart
338339
explode: true
339340
in: query
340341
name: filter[ref]
@@ -349,6 +350,32 @@ components:
349350
required: false
350351
schema:
351352
$ref: '#/components/schemas/RelationType'
353+
FilterRelationByFromRef:
354+
description: Filter relations by the reference of the first entity in the relation.
355+
example: service:shopping-cart
356+
explode: true
357+
in: query
358+
name: filter[from_ref]
359+
required: false
360+
schema:
361+
type: string
362+
FilterRelationByToRef:
363+
description: Filter relations by the reference of the second entity in the relation.
364+
example: service:shopping-cart
365+
explode: true
366+
in: query
367+
name: filter[to_ref]
368+
required: false
369+
schema:
370+
type: string
371+
FilterRelationByType:
372+
description: Filter relations by type.
373+
explode: true
374+
in: query
375+
name: filter[type]
376+
required: false
377+
schema:
378+
$ref: '#/components/schemas/RelationType'
352379
GCPSTSServiceAccountID:
353380
description: Your GCP STS enabled service account's unique ID.
354381
in: path
@@ -659,6 +686,14 @@ components:
659686
required: true
660687
schema:
661688
type: string
689+
RelationInclude:
690+
description: Include relationship data.
691+
explode: true
692+
in: query
693+
name: include
694+
required: false
695+
schema:
696+
$ref: '#/components/schemas/RelationIncludeType'
662697
ReportID:
663698
description: The ID of the report job.
664699
in: path
@@ -19217,6 +19252,38 @@ components:
1921719252
meta:
1921819253
$ref: '#/components/schemas/PowerpacksResponseMeta'
1921919254
type: object
19255+
ListRelationCatalogResponse:
19256+
description: List entity relation response.
19257+
properties:
19258+
data:
19259+
$ref: '#/components/schemas/RelationResponseData'
19260+
included:
19261+
$ref: '#/components/schemas/ListRelationCatalogResponseIncluded'
19262+
links:
19263+
$ref: '#/components/schemas/ListRelationCatalogResponseLinks'
19264+
meta:
19265+
$ref: '#/components/schemas/RelationResponseMeta'
19266+
type: object
19267+
ListRelationCatalogResponseIncluded:
19268+
description: List relation response included entities.
19269+
items:
19270+
$ref: '#/components/schemas/EntityData'
19271+
type: array
19272+
ListRelationCatalogResponseLinks:
19273+
description: List relation response links.
19274+
properties:
19275+
next:
19276+
description: Next link.
19277+
example: /api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=2
19278+
type: string
19279+
previous:
19280+
description: Previous link.
19281+
type: string
19282+
self:
19283+
description: Current link.
19284+
example: /api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=0
19285+
type: string
19286+
type: object
1922019287
ListRulesResponse:
1922119288
description: Scorecard rules response.
1922219289
properties:
@@ -28519,6 +28586,114 @@ components:
2851928586
x-enum-varnames:
2852028587
- ANY
2852128588
- ALL
28589+
RelationAttributes:
28590+
description: Relation attributes.
28591+
properties:
28592+
from:
28593+
$ref: '#/components/schemas/RelationEntity'
28594+
to:
28595+
$ref: '#/components/schemas/RelationEntity'
28596+
type:
28597+
$ref: '#/components/schemas/RelationType'
28598+
type: object
28599+
RelationEntity:
28600+
description: Relation entity reference.
28601+
properties:
28602+
kind:
28603+
description: Entity kind.
28604+
type: string
28605+
name:
28606+
description: Entity name.
28607+
type: string
28608+
namespace:
28609+
description: Entity namespace.
28610+
type: string
28611+
type: object
28612+
RelationIncludeType:
28613+
description: Supported include types for relations.
28614+
enum:
28615+
- entity
28616+
- schema
28617+
type: string
28618+
x-enum-varnames:
28619+
- ENTITY
28620+
- SCHEMA
28621+
RelationMeta:
28622+
description: Relation metadata.
28623+
properties:
28624+
createdAt:
28625+
description: Relation creation time.
28626+
format: date-time
28627+
type: string
28628+
definedBy:
28629+
description: Relation defined by.
28630+
type: string
28631+
modifiedAt:
28632+
description: Relation modification time.
28633+
format: date-time
28634+
type: string
28635+
source:
28636+
description: Relation source.
28637+
type: string
28638+
type: object
28639+
RelationRelationships:
28640+
description: Relation relationships.
28641+
properties:
28642+
fromEntity:
28643+
$ref: '#/components/schemas/RelationToEntity'
28644+
toEntity:
28645+
$ref: '#/components/schemas/RelationToEntity'
28646+
type: object
28647+
RelationResponse:
28648+
description: Relation response data.
28649+
properties:
28650+
attributes:
28651+
$ref: '#/components/schemas/RelationAttributes'
28652+
id:
28653+
description: Relation ID.
28654+
type: string
28655+
meta:
28656+
$ref: '#/components/schemas/RelationMeta'
28657+
relationships:
28658+
$ref: '#/components/schemas/RelationRelationships'
28659+
subtype:
28660+
description: Relation subtype.
28661+
type: string
28662+
type:
28663+
$ref: '#/components/schemas/RelationResponseType'
28664+
type: object
28665+
RelationResponseData:
28666+
description: Array of relation responses
28667+
items:
28668+
$ref: '#/components/schemas/RelationResponse'
28669+
type: array
28670+
RelationResponseMeta:
28671+
description: Relation response metadata.
28672+
properties:
28673+
count:
28674+
description: Total relations count.
28675+
format: int64
28676+
type: integer
28677+
includeCount:
28678+
description: Total included data count.
28679+
format: int64
28680+
type: integer
28681+
type: object
28682+
RelationResponseType:
28683+
description: Relation type.
28684+
enum:
28685+
- relation
28686+
type: string
28687+
x-enum-varnames:
28688+
- RELATION
28689+
RelationToEntity:
28690+
description: Relation to entity.
28691+
properties:
28692+
data:
28693+
$ref: '#/components/schemas/RelationshipItem'
28694+
meta:
28695+
$ref: '#/components/schemas/EntityMeta'
28696+
type: object
2852228697
RelationType:
2852328698
description: Supported relation types.
2852428699
enum:
@@ -42584,6 +42759,48 @@ paths:
4258442759
summary: Delete a single entity
4258542760
tags:
4258642761
- Software Catalog
42762+
/api/v2/catalog/relation:
42763+
get:
42764+
description: Get a list of entity relations from Software Catalog.
42765+
operationId: ListCatalogRelation
42766+
parameters:
42767+
- $ref: '#/components/parameters/PageOffset'
42768+
- description: Maximum number of relations in the response.
42769+
example: 100
42770+
in: query
42771+
name: page[limit]
42772+
required: false
42773+
schema:
42774+
default: 100
42775+
format: int64
42776+
type: integer
42777+
- $ref: '#/components/parameters/FilterRelationByType'
42778+
- $ref: '#/components/parameters/FilterRelationByFromRef'
42779+
- $ref: '#/components/parameters/FilterRelationByToRef'
42780+
- $ref: '#/components/parameters/RelationInclude'
42781+
responses:
42782+
'200':
42783+
content:
42784+
application/json:
42785+
schema:
42786+
$ref: '#/components/schemas/ListRelationCatalogResponse'
42787+
description: OK
42788+
'403':
42789+
$ref: '#/components/responses/ForbiddenResponse'
42790+
'429':
42791+
$ref: '#/components/responses/TooManyRequestsResponse'
42792+
security:
42793+
- apiKeyAuth: []
42794+
appKeyAuth: []
42795+
- AuthZ:
42796+
- apm_service_catalog_read
42797+
summary: Get a list of entity relations
42798+
tags:
42799+
- Software Catalog
42800+
x-pagination:
42801+
limitParam: page[limit]
42802+
pageOffsetParam: page[offset]
42803+
resultsPath: data
4258742804
/api/v2/ci/pipeline:
4258842805
post:
4258942806
description: 'Send your pipeline event to your Datadog platform over HTTP. For

‎examples/v2/software-catalog/ListCatalogRelation.ts

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
/**
2+
* Get a list of entity relations returns "OK" response
3+
*/
4+
5+
import { client, v2 } from "@datadog/datadog-api-client";
6+
7+
const configuration = client.createConfiguration();
8+
const apiInstance = new v2.SoftwareCatalogApi(configuration);
9+
10+
apiInstance
11+
.listCatalogRelation()
12+
.then((data: v2.ListRelationCatalogResponse) => {
13+
console.log(
14+
"API called successfully. Returned data: " + JSON.stringify(data)
15+
);
16+
})
17+
.catch((error: any) => console.error(error));

‎examples/v2/software-catalog/ListCatalogRelation_1311054087.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
/**
2+
* Get a list of entity relations returns "OK" response with pagination
3+
*/
4+
5+
import { client, v2 } from "@datadog/datadog-api-client";
6+
7+
const configuration = client.createConfiguration();
8+
const apiInstance = new v2.SoftwareCatalogApi(configuration);
9+
10+
(async () => {
11+
try {
12+
for await (const item of apiInstance.listCatalogRelationWithPagination()) {
13+
console.log(item);
14+
}
15+
} catch (error) {
16+
console.error(error);
17+
}
18+
})();

‎features/support/scenarios_model_mapping.ts

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3097,6 +3097,33 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
30973097
},
30983098
"operationResponseType": "void",
30993099
},
3100+
"v2.ListCatalogRelation": {
3101+
"pageOffset": {
3102+
"type": "number",
3103+
"format": "int64",
3104+
},
3105+
"pageLimit": {
3106+
"type": "number",
3107+
"format": "int64",
3108+
},
3109+
"filterType": {
3110+
"type": "RelationType",
3111+
"format": "",
3112+
},
3113+
"filterFromRef": {
3114+
"type": "string",
3115+
"format": "",
3116+
},
3117+
"filterToRef": {
3118+
"type": "string",
3119+
"format": "",
3120+
},
3121+
"include": {
3122+
"type": "RelationIncludeType",
3123+
"format": "",
3124+
},
3125+
"operationResponseType": "ListRelationCatalogResponse",
3126+
},
31003127
"v2.CreateCIAppPipelineEvent": {
31013128
"body": {
31023129
"type": "CIAppCreatePipelineEventRequest",

‎features/v2/software_catalog.feature

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,15 @@ Feature: Software Catalog
7878
Given new "ListCatalogEntity" request
7979
When the request with pagination is sent
8080
Then the response status is 200 OK
81+
82+
@generated @skip @team:DataDog/service-catalog
83+
Scenario: Get a list of entity relations returns "OK" response
84+
Given new "ListCatalogRelation" request
85+
When the request is sent
86+
Then the response status is 200 OK
87+
88+
@generated @skip @team:DataDog/service-catalog @with-pagination
89+
Scenario: Get a list of entity relations returns "OK" response with pagination
90+
Given new "ListCatalogRelation" request
91+
When the request with pagination is sent
92+
Then the response status is 200 OK

‎features/v2/undo.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -471,6 +471,12 @@
471471
"type": "idempotent"
472472
}
473473
},
474+
"ListCatalogRelation": {
475+
"tag": "Software Catalog",
476+
"undo": {
477+
"type": "safe"
478+
}
479+
},
474480
"CreateCIAppPipelineEvent": {
475481
"tag": "CI Visibility Pipelines",
476482
"undo": {

0 commit comments

Comments
 (0)