Skip to content

Commit 09f6613

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add componentOf field to Service, Queue, and Datastore V3 Software Catalog definitions (#2122)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent fd0581b commit 09f6613

File tree

7 files changed

+46
-6
lines changed

7 files changed

+46
-6
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-04-02 19:55:31.957447",
8-
"spec_repo_commit": "1cc45c45"
7+
"regenerated": "2025-04-02 20:49:29.894380",
8+
"spec_repo_commit": "9ea284b5"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-04-02 19:55:31.973220",
13-
"spec_repo_commit": "1cc45c45"
12+
"regenerated": "2025-04-02 20:49:29.913373",
13+
"spec_repo_commit": "9ea284b5"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12431,6 +12431,11 @@ components:
1243112431
additionalProperties: false
1243212432
description: The definition of Entity V3 Datastore Spec object.
1243312433
properties:
12434+
componentOf:
12435+
description: A list of components the datastore is a part of
12436+
items:
12437+
type: string
12438+
type: array
1243412439
lifecycle:
1243512440
description: The lifecycle state of the datastore.
1243612441
minLength: 1
@@ -12629,6 +12634,11 @@ components:
1262912634
additionalProperties: false
1263012635
description: The definition of Entity V3 Queue Spec object.
1263112636
properties:
12637+
componentOf:
12638+
description: A list of components the queue is a part of
12639+
items:
12640+
type: string
12641+
type: array
1263212642
lifecycle:
1263312643
description: The lifecycle state of the queue.
1263412644
minLength: 1
@@ -12694,6 +12704,11 @@ components:
1269412704
additionalProperties: false
1269512705
description: The definition of Entity V3 Service Spec object.
1269612706
properties:
12707+
componentOf:
12708+
description: A list of components the service is a part of
12709+
items:
12710+
type: string
12711+
type: array
1269712712
dependsOn:
1269812713
description: A list of components the service depends on.
1269912714
items:

examples/v2/software-catalog/UpsertCatalogEntity.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ const params: v2.SoftwareCatalogApiUpsertCatalogEntityRequest = {
6161
tags: ["this:tag", "that:tag"],
6262
},
6363
spec: {
64+
componentOf: [],
6465
dependsOn: [],
6566
languages: [],
6667
},

features/v2/software_catalog.feature

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ Feature: Software Catalog
1010
@generated @skip @team:DataDog/service-catalog
1111
Scenario: Create or update entities returns "ACCEPTED" response
1212
Given new "UpsertCatalogEntity" request
13-
And body with value {"apiVersion": "v3", "datadog": {"codeLocations": [{"paths": []}], "events": [{}], "logs": [{}], "performanceData": {"tags": []}, "pipelines": {"fingerprints": []}}, "integrations": {"opsgenie": {"serviceURL": "https://www.opsgenie.com/service/shopping-cart"}, "pagerduty": {"serviceURL": "https://www.pagerduty.com/service-directory/Pshopping-cart"}}, "kind": "service", "metadata": {"additionalOwners": [{"name": ""}], "contacts": [{"contact": "https://slack/", "type": "slack"}], "id": "4b163705-23c0-4573-b2fb-f6cea2163fcb", "inheritFrom": "application:default/myapp", "links": [{"name": "mylink", "type": "link", "url": "https://mylink"}], "name": "myService", "namespace": "default", "tags": ["this:tag", "that:tag"]}, "spec": {"dependsOn": [], "languages": []}}
13+
And body with value {"apiVersion": "v3", "datadog": {"codeLocations": [{"paths": []}], "events": [{}], "logs": [{}], "performanceData": {"tags": []}, "pipelines": {"fingerprints": []}}, "integrations": {"opsgenie": {"serviceURL": "https://www.opsgenie.com/service/shopping-cart"}, "pagerduty": {"serviceURL": "https://www.pagerduty.com/service-directory/Pshopping-cart"}}, "kind": "service", "metadata": {"additionalOwners": [{"name": ""}], "contacts": [{"contact": "https://slack/", "type": "slack"}], "id": "4b163705-23c0-4573-b2fb-f6cea2163fcb", "inheritFrom": "application:default/myapp", "links": [{"name": "mylink", "type": "link", "url": "https://mylink"}], "name": "myService", "namespace": "default", "tags": ["this:tag", "that:tag"]}, "spec": {"componentOf": [], "dependsOn": [], "languages": []}}
1414
When the request is sent
1515
Then the response status is 202 ACCEPTED
1616

1717
@generated @skip @team:DataDog/service-catalog
1818
Scenario: Create or update entities returns "Bad Request" response
1919
Given new "UpsertCatalogEntity" request
20-
And body with value {"apiVersion": "v3", "datadog": {"codeLocations": [{"paths": []}], "events": [{}], "logs": [{}], "performanceData": {"tags": []}, "pipelines": {"fingerprints": []}}, "integrations": {"opsgenie": {"serviceURL": "https://www.opsgenie.com/service/shopping-cart"}, "pagerduty": {"serviceURL": "https://www.pagerduty.com/service-directory/Pshopping-cart"}}, "kind": "service", "metadata": {"additionalOwners": [{"name": ""}], "contacts": [{"contact": "https://slack/", "type": "slack"}], "id": "4b163705-23c0-4573-b2fb-f6cea2163fcb", "inheritFrom": "application:default/myapp", "links": [{"name": "mylink", "type": "link", "url": "https://mylink"}], "name": "myService", "namespace": "default", "tags": ["this:tag", "that:tag"]}, "spec": {"dependsOn": [], "languages": []}}
20+
And body with value {"apiVersion": "v3", "datadog": {"codeLocations": [{"paths": []}], "events": [{}], "logs": [{}], "performanceData": {"tags": []}, "pipelines": {"fingerprints": []}}, "integrations": {"opsgenie": {"serviceURL": "https://www.opsgenie.com/service/shopping-cart"}, "pagerduty": {"serviceURL": "https://www.pagerduty.com/service-directory/Pshopping-cart"}}, "kind": "service", "metadata": {"additionalOwners": [{"name": ""}], "contacts": [{"contact": "https://slack/", "type": "slack"}], "id": "4b163705-23c0-4573-b2fb-f6cea2163fcb", "inheritFrom": "application:default/myapp", "links": [{"name": "mylink", "type": "link", "url": "https://mylink"}], "name": "myService", "namespace": "default", "tags": ["this:tag", "that:tag"]}, "spec": {"componentOf": [], "dependsOn": [], "languages": []}}
2121
When the request is sent
2222
Then the response status is 400 Bad Request
2323

packages/datadog-api-client-v2/models/EntityV3DatastoreSpec.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";
1010
* The definition of Entity V3 Datastore Spec object.
1111
*/
1212
export class EntityV3DatastoreSpec {
13+
/**
14+
* A list of components the datastore is a part of
15+
*/
16+
"componentOf"?: Array<string>;
1317
/**
1418
* The lifecycle state of the datastore.
1519
*/
@@ -32,6 +36,10 @@ export class EntityV3DatastoreSpec {
3236
* @ignore
3337
*/
3438
static readonly attributeTypeMap: AttributeTypeMap = {
39+
componentOf: {
40+
baseName: "componentOf",
41+
type: "Array<string>",
42+
},
3543
lifecycle: {
3644
baseName: "lifecycle",
3745
type: "string",

packages/datadog-api-client-v2/models/EntityV3QueueSpec.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";
1010
* The definition of Entity V3 Queue Spec object.
1111
*/
1212
export class EntityV3QueueSpec {
13+
/**
14+
* A list of components the queue is a part of
15+
*/
16+
"componentOf"?: Array<string>;
1317
/**
1418
* The lifecycle state of the queue.
1519
*/
@@ -32,6 +36,10 @@ export class EntityV3QueueSpec {
3236
* @ignore
3337
*/
3438
static readonly attributeTypeMap: AttributeTypeMap = {
39+
componentOf: {
40+
baseName: "componentOf",
41+
type: "Array<string>",
42+
},
3543
lifecycle: {
3644
baseName: "lifecycle",
3745
type: "string",

packages/datadog-api-client-v2/models/EntityV3ServiceSpec.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";
1010
* The definition of Entity V3 Service Spec object.
1111
*/
1212
export class EntityV3ServiceSpec {
13+
/**
14+
* A list of components the service is a part of
15+
*/
16+
"componentOf"?: Array<string>;
1317
/**
1418
* A list of components the service depends on.
1519
*/
@@ -40,6 +44,10 @@ export class EntityV3ServiceSpec {
4044
* @ignore
4145
*/
4246
static readonly attributeTypeMap: AttributeTypeMap = {
47+
componentOf: {
48+
baseName: "componentOf",
49+
type: "Array<string>",
50+
},
4351
dependsOn: {
4452
baseName: "dependsOn",
4553
type: "Array<string>",

0 commit comments

Comments
 (0)