Skip to content

Commit 3cd6873

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit f88cc028 of spec repo
1 parent 17d1de4 commit 3cd6873

20 files changed

+1571
-4
lines changed

‎.apigentools-info

+4-4
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-02 04:31:13.587503",
8-
"spec_repo_commit": "272cce39"
7+
"regenerated": "2025-05-02 16:32:07.534233",
8+
"spec_repo_commit": "f88cc028"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-05-02 04:31:13.603582",
13-
"spec_repo_commit": "272cce39"
12+
"regenerated": "2025-05-02 16:32:07.549905",
13+
"spec_repo_commit": "f88cc028"
1414
}
1515
}
1616
}

‎.generator/schemas/v2/openapi.yaml

+217
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
@@ -19254,6 +19289,38 @@ components:
1925419289
meta:
1925519290
$ref: '#/components/schemas/PowerpacksResponseMeta'
1925619291
type: object
19292+
ListRelationCatalogResponse:
19293+
description: List entity relation response.
19294+
properties:
19295+
data:
19296+
$ref: '#/components/schemas/RelationResponseData'
19297+
included:
19298+
$ref: '#/components/schemas/ListRelationCatalogResponseIncluded'
19299+
links:
19300+
$ref: '#/components/schemas/ListRelationCatalogResponseLinks'
19301+
meta:
19302+
$ref: '#/components/schemas/RelationResponseMeta'
19303+
type: object
19304+
ListRelationCatalogResponseIncluded:
19305+
description: List relation response included entities.
19306+
items:
19307+
$ref: '#/components/schemas/EntityData'
19308+
type: array
19309+
ListRelationCatalogResponseLinks:
19310+
description: List relation response links.
19311+
properties:
19312+
next:
19313+
description: Next link.
19314+
example: /api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=2
19315+
type: string
19316+
previous:
19317+
description: Previous link.
19318+
type: string
19319+
self:
19320+
description: Current link.
19321+
example: /api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=0
19322+
type: string
19323+
type: object
1925719324
ListRulesResponse:
1925819325
description: Scorecard rules response.
1925919326
properties:
@@ -28556,6 +28623,114 @@ components:
2855628623
x-enum-varnames:
2855728624
- ANY
2855828625
- ALL
28626+
RelationAttributes:
28627+
description: Relation attributes.
28628+
properties:
28629+
from:
28630+
$ref: '#/components/schemas/RelationEntity'
28631+
to:
28632+
$ref: '#/components/schemas/RelationEntity'
28633+
type:
28634+
$ref: '#/components/schemas/RelationType'
28635+
type: object
28636+
RelationEntity:
28637+
description: Relation entity reference.
28638+
properties:
28639+
kind:
28640+
description: Entity kind.
28641+
type: string
28642+
name:
28643+
description: Entity name.
28644+
type: string
28645+
namespace:
28646+
description: Entity namespace.
28647+
type: string
28648+
type: object
28649+
RelationIncludeType:
28650+
description: Supported include types for relations.
28651+
enum:
28652+
- entity
28653+
- schema
28654+
type: string
28655+
x-enum-varnames:
28656+
- ENTITY
28657+
- SCHEMA
28658+
RelationMeta:
28659+
description: Relation metadata.
28660+
properties:
28661+
createdAt:
28662+
description: Relation creation time.
28663+
format: date-time
28664+
type: string
28665+
definedBy:
28666+
description: Relation defined by.
28667+
type: string
28668+
modifiedAt:
28669+
description: Relation modification time.
28670+
format: date-time
28671+
type: string
28672+
source:
28673+
description: Relation source.
28674+
type: string
28675+
type: object
28676+
RelationRelationships:
28677+
description: Relation relationships.
28678+
properties:
28679+
fromEntity:
28680+
$ref: '#/components/schemas/RelationToEntity'
28681+
toEntity:
28682+
$ref: '#/components/schemas/RelationToEntity'
28683+
type: object
28684+
RelationResponse:
28685+
description: Relation response data.
28686+
properties:
28687+
attributes:
28688+
$ref: '#/components/schemas/RelationAttributes'
28689+
id:
28690+
description: Relation ID.
28691+
type: string
28692+
meta:
28693+
$ref: '#/components/schemas/RelationMeta'
28694+
relationships:
28695+
$ref: '#/components/schemas/RelationRelationships'
28696+
subtype:
28697+
description: Relation subtype.
28698+
type: string
28699+
type:
28700+
$ref: '#/components/schemas/RelationResponseType'
28701+
type: object
28702+
RelationResponseData:
28703+
description: Array of relation responses
28704+
items:
28705+
$ref: '#/components/schemas/RelationResponse'
28706+
type: array
28707+
RelationResponseMeta:
28708+
description: Relation response metadata.
28709+
properties:
28710+
count:
28711+
description: Total relations count.
28712+
format: int64
28713+
type: integer
28714+
includeCount:
28715+
description: Total included data count.
28716+
format: int64
28717+
type: integer
28718+
type: object
28719+
RelationResponseType:
28720+
description: Relation type.
28721+
enum:
28722+
- relation
28723+
type: string
28724+
x-enum-varnames:
28725+
- RELATION
28726+
RelationToEntity:
28727+
description: Relation to entity.
28728+
properties:
28729+
data:
28730+
$ref: '#/components/schemas/RelationshipItem'
28731+
meta:
28732+
$ref: '#/components/schemas/EntityMeta'
28733+
type: object
2855928734
RelationType:
2856028735
description: Supported relation types.
2856128736
enum:
@@ -42634,6 +42809,48 @@ paths:
4263442809
summary: Delete a single entity
4263542810
tags:
4263642811
- Software Catalog
42812+
/api/v2/catalog/relation:
42813+
get:
42814+
description: Get a list of entity relations from Software Catalog.
42815+
operationId: ListCatalogRelation
42816+
parameters:
42817+
- $ref: '#/components/parameters/PageOffset'
42818+
- description: Maximum number of relations in the response.
42819+
example: 100
42820+
in: query
42821+
name: page[limit]
42822+
required: false
42823+
schema:
42824+
default: 100
42825+
format: int64
42826+
type: integer
42827+
- $ref: '#/components/parameters/FilterRelationByType'
42828+
- $ref: '#/components/parameters/FilterRelationByFromRef'
42829+
- $ref: '#/components/parameters/FilterRelationByToRef'
42830+
- $ref: '#/components/parameters/RelationInclude'
42831+
responses:
42832+
'200':
42833+
content:
42834+
application/json:
42835+
schema:
42836+
$ref: '#/components/schemas/ListRelationCatalogResponse'
42837+
description: OK
42838+
'403':
42839+
$ref: '#/components/responses/ForbiddenResponse'
42840+
'429':
42841+
$ref: '#/components/responses/TooManyRequestsResponse'
42842+
security:
42843+
- apiKeyAuth: []
42844+
appKeyAuth: []
42845+
- AuthZ:
42846+
- apm_service_catalog_read
42847+
summary: Get a list of entity relations
42848+
tags:
42849+
- Software Catalog
42850+
x-pagination:
42851+
limitParam: page[limit]
42852+
pageOffsetParam: page[offset]
42853+
resultsPath: data
4263742854
/api/v2/ci/pipeline:
4263842855
post:
4263942856
description: 'Send your pipeline event to your Datadog platform over HTTP. For

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

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Get a list of entity relations returns "OK" response
2+
3+
require "datadog_api_client"
4+
api_instance = DatadogAPIClient::V2::SoftwareCatalogAPI.new
5+
p api_instance.list_catalog_relation()

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

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Get a list of entity relations returns "OK" response with pagination
2+
3+
require "datadog_api_client"
4+
api_instance = DatadogAPIClient::V2::SoftwareCatalogAPI.new
5+
api_instance.list_catalog_relation_with_pagination() { |item| puts item }

‎features/scenarios_model_mapping.rb

+8
Original file line numberDiff line numberDiff line change
@@ -1106,6 +1106,14 @@
11061106
"v2.DeleteCatalogEntity" => {
11071107
"entity_id" => "String",
11081108
},
1109+
"v2.ListCatalogRelation" => {
1110+
"page_offset" => "Integer",
1111+
"page_limit" => "Integer",
1112+
"filter_type" => "RelationType",
1113+
"filter_from_ref" => "String",
1114+
"filter_to_ref" => "String",
1115+
"include" => "RelationIncludeType",
1116+
},
11091117
"v2.CreateCIAppPipelineEvent" => {
11101118
"body" => "CIAppCreatePipelineEventRequest",
11111119
},

‎features/v2/software_catalog.feature

+12
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+
@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+
@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

+6
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": {

‎lib/datadog_api_client/inflector.rb

+11
Original file line numberDiff line numberDiff line change
@@ -2072,6 +2072,8 @@ def overrides
20722072
"v2.list_pipelines_response" => "ListPipelinesResponse",
20732073
"v2.list_pipelines_response_meta" => "ListPipelinesResponseMeta",
20742074
"v2.list_powerpacks_response" => "ListPowerpacksResponse",
2075+
"v2.list_relation_catalog_response" => "ListRelationCatalogResponse",
2076+
"v2.list_relation_catalog_response_links" => "ListRelationCatalogResponseLinks",
20752077
"v2.list_rules_response" => "ListRulesResponse",
20762078
"v2.list_rules_response_data_item" => "ListRulesResponseDataItem",
20772079
"v2.list_rules_response_links" => "ListRulesResponseLinks",
@@ -2624,6 +2626,14 @@ def overrides
26242626
"v2.query_sort_order" => "QuerySortOrder",
26252627
"v2.readiness_gate" => "ReadinessGate",
26262628
"v2.readiness_gate_threshold_type" => "ReadinessGateThresholdType",
2629+
"v2.relation_attributes" => "RelationAttributes",
2630+
"v2.relation_entity" => "RelationEntity",
2631+
"v2.relation_include_type" => "RelationIncludeType",
2632+
"v2.relation_meta" => "RelationMeta",
2633+
"v2.relation_relationships" => "RelationRelationships",
2634+
"v2.relation_response" => "RelationResponse",
2635+
"v2.relation_response_meta" => "RelationResponseMeta",
2636+
"v2.relation_response_type" => "RelationResponseType",
26272637
"v2.relationship_item" => "RelationshipItem",
26282638
"v2.relationship_to_incident_attachment" => "RelationshipToIncidentAttachment",
26292639
"v2.relationship_to_incident_attachment_data" => "RelationshipToIncidentAttachmentData",
@@ -2666,6 +2676,7 @@ def overrides
26662676
"v2.relationship_to_user_team_team_data" => "RelationshipToUserTeamTeamData",
26672677
"v2.relationship_to_user_team_user" => "RelationshipToUserTeamUser",
26682678
"v2.relationship_to_user_team_user_data" => "RelationshipToUserTeamUserData",
2679+
"v2.relation_to_entity" => "RelationToEntity",
26692680
"v2.relation_type" => "RelationType",
26702681
"v2.remediation" => "Remediation",
26712682
"v2.reorder_retention_filters_request" => "ReorderRetentionFiltersRequest",

0 commit comments

Comments
 (0)