Skip to content

Commit 25106c2

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Revert GetSBOM to x-unstable (#2048)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent f3172fe commit 25106c2

File tree

10 files changed

+32
-19
lines changed

10 files changed

+32
-19
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-02-12 18:33:45.250628",
8-
"spec_repo_commit": "6a4cfb82"
7+
"regenerated": "2025-02-14 15:03:44.521676",
8+
"spec_repo_commit": "a739b49f"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-02-12 18:33:45.266253",
13-
"spec_repo_commit": "6a4cfb82"
12+
"regenerated": "2025-02-14 15:03:44.537023",
13+
"spec_repo_commit": "a739b49f"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45225,6 +45225,9 @@ paths:
4522545225
summary: Get SBOM
4522645226
tags:
4522745227
- Security Monitoring
45228+
x-unstable: '**Note**: This endpoint is a private preview.
45229+
45230+
If you are interested in accessing this API, please [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).'
4522845231
/api/v2/security/signals/notification_rules:
4522945232
get:
4523045233
description: Returns the list of notification rules for security signals.
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2025-01-31T12:04:00.490Z"
1+
"2025-02-10T11:40:12.098Z"

cassettes/v2/Security-Monitoring_1187227211/Get-SBOM-returns-Not-found-asset-not-found-response_1830059764/recording.har

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@
3535
"url": "https://api.datadoghq.com/api/v2/security/sboms/Host?filter%5Basset_name%5D=unknown-host"
3636
},
3737
"response": {
38-
"bodySize": 112,
38+
"bodySize": 127,
3939
"content": {
4040
"mimeType": "application/vnd.api+json",
41-
"size": 112,
42-
"text": "{\"errors\":[{\"title\":\"Asset not found\",\"detail\":\"asset_type: 'Host' with asset_name: 'unknown-host' not found\"}]}"
41+
"size": 127,
42+
"text": "{\"errors\":[{\"status\":\"404\",\"title\":\"Asset not found\",\"detail\":\"asset_type: 'Host' with asset_name: 'unknown-host' not found\"}]}"
4343
},
4444
"cookies": [],
4545
"headers": [
@@ -54,8 +54,8 @@
5454
"status": 404,
5555
"statusText": "Not Found"
5656
},
57-
"startedDateTime": "2025-01-31T12:04:00.501Z",
58-
"time": 1317
57+
"startedDateTime": "2025-02-10T11:40:12.494Z",
58+
"time": 314
5959
}
6060
],
6161
"pages": [],
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2025-01-31T12:04:14.913Z"
1+
"2025-02-10T11:38:04.662Z"

cassettes/v2/Security-Monitoring_1187227211/Get-SBOM-returns-OK-response_169029814/recording.har

Lines changed: 5 additions & 5 deletions
Large diffs are not rendered by default.

examples/v2/security-monitoring/GetSBOM.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
import { client, v2 } from "@datadog/datadog-api-client";
66

77
const configuration = client.createConfiguration();
8+
configuration.unstableOperations["v2.getSBOM"] = true;
89
const apiInstance = new v2.SecurityMonitoringApi(configuration);
910

1011
const params: v2.SecurityMonitoringApiGetSBOMRequest = {

features/v2/security_monitoring.feature

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -457,23 +457,26 @@ Feature: Security Monitoring
457457

458458
@generated @skip @team:DataDog/asm-vm
459459
Scenario: Get SBOM returns "Bad request: The server cannot process the request due to invalid syntax in the request." response
460-
Given new "GetSBOM" request
460+
Given operation "GetSBOM" enabled
461+
And new "GetSBOM" request
461462
And request contains "asset_type" parameter from "REPLACE.ME"
462463
And request contains "filter[asset_name]" parameter from "REPLACE.ME"
463464
When the request is sent
464465
Then the response status is 400 Bad request: The server cannot process the request due to invalid syntax in the request.
465466

466467
@team:DataDog/asm-vm
467468
Scenario: Get SBOM returns "Not found: asset not found" response
468-
Given new "GetSBOM" request
469+
Given operation "GetSBOM" enabled
470+
And new "GetSBOM" request
469471
And request contains "asset_type" parameter with value "Host"
470472
And request contains "filter[asset_name]" parameter with value "unknown-host"
471473
When the request is sent
472474
Then the response status is 404 Not found: asset not found
473475

474476
@team:DataDog/asm-vm
475477
Scenario: Get SBOM returns "OK" response
476-
Given new "GetSBOM" request
478+
Given operation "GetSBOM" enabled
479+
And new "GetSBOM" request
477480
And request contains "asset_type" parameter with value "Repository"
478481
And request contains "filter[asset_name]" parameter with value "github.com/datadog/datadog-agent"
479482
When the request is sent

packages/datadog-api-client-common/configuration.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,7 @@ export function createConfiguration(
277277
"v2.getFinding": false,
278278
"v2.getHistoricalJob": false,
279279
"v2.getRuleVersionHistory": false,
280+
"v2.getSBOM": false,
280281
"v2.listFindings": false,
281282
"v2.listHistoricalJobs": false,
282283
"v2.muteFindings": false,

packages/datadog-api-client-v2/apis/SecurityMonitoringApi.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1021,6 +1021,11 @@ export class SecurityMonitoringApiRequestFactory extends BaseAPIRequestFactory {
10211021
): Promise<RequestContext> {
10221022
const _config = _options || this.configuration;
10231023

1024+
logger.warn("Using unstable operation 'getSBOM'");
1025+
if (!_config.unstableOperations["v2.getSBOM"]) {
1026+
throw new Error("Unstable operation 'getSBOM' is disabled");
1027+
}
1028+
10241029
// verify required parameter 'assetType' is not null or undefined
10251030
if (assetType === null || assetType === undefined) {
10261031
throw new RequiredError("assetType", "getSBOM");

0 commit comments

Comments
 (0)