Marks the paths as unstable since the API is in private beta (#1954)

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-12-13 14:48:35.249300",
-            "spec_repo_commit": "5392df51"
+            "regenerated": "2024-12-13 15:30:15.065009",
+            "spec_repo_commit": "e7a707af"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-12-13 14:48:35.268742",
-            "spec_repo_commit": "5392df51"
+            "regenerated": "2024-12-13 15:30:15.088671",
+            "spec_repo_commit": "e7a707af"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -31356,6 +31356,9 @@ paths:
         permissions:
         - rum_delete_data
         - logs_delete_data
+      x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
+
+        contact [Datadog support](https://docs.datadoghq.com/help/).'
   /api/v2/deletion/requests:
     get:
       description: Gets a list of data deletion requests based on several filter parameters.
@@ -31431,6 +31434,9 @@ paths:
         permissions:
         - rum_delete_data
         - logs_delete_data
+      x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
+
+        contact [Datadog support](https://docs.datadoghq.com/help/).'
   /api/v2/deletion/requests/{id}/cancel:
     put:
       description: Cancels a data deletion request by providing its ID.
@@ -31473,6 +31479,9 @@ paths:
         permissions:
         - rum_delete_data
         - logs_delete_data
+      x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback,
+
+        contact [Datadog support](https://docs.datadoghq.com/help/).'
   /api/v2/domain_allowlist:
     get:
       description: Get the domain allowlist for an organization.

examples/v2/data-deletion/CancelDataDeletionRequest.ts

@@ -5,6 +5,7 @@
 import { client, v2 } from "@datadog/datadog-api-client";
 
 const configuration = client.createConfiguration();
+configuration.unstableOperations["v2.cancelDataDeletionRequest"] = true;
 const apiInstance = new v2.DataDeletionApi(configuration);
 
 // there is a valid "deletion_request" in the system

examples/v2/data-deletion/CreateDataDeletionRequest.ts

@@ -5,6 +5,7 @@
 import { client, v2 } from "@datadog/datadog-api-client";
 
 const configuration = client.createConfiguration();
+configuration.unstableOperations["v2.createDataDeletionRequest"] = true;
 const apiInstance = new v2.DataDeletionApi(configuration);
 
 const params: v2.DataDeletionApiCreateDataDeletionRequestRequest = {

examples/v2/data-deletion/GetDataDeletionRequests.ts

@@ -5,6 +5,7 @@
 import { client, v2 } from "@datadog/datadog-api-client";
 
 const configuration = client.createConfiguration();
+configuration.unstableOperations["v2.getDataDeletionRequests"] = true;
 const apiInstance = new v2.DataDeletionApi(configuration);
 
 apiInstance

features/v2/data_deletion.feature

@@ -11,14 +11,16 @@ Feature: Data Deletion
 
   @replay-only @team:DataDog/supportability-engineering
   Scenario: Cancels a data deletion request returns "Bad Request" response
-    Given new "CancelDataDeletionRequest" request
+    Given operation "CancelDataDeletionRequest" enabled
+    And new "CancelDataDeletionRequest" request
     And request contains "id" parameter with value "id-1"
     When the request is sent
     Then the response status is 400 Bad Request
 
   @team:DataDog/supportability-engineering
   Scenario: Cancels a data deletion request returns "OK" response
-    Given there is a valid "deletion_request" in the system
+    Given operation "CancelDataDeletionRequest" enabled
+    And there is a valid "deletion_request" in the system
     And new "CancelDataDeletionRequest" request
     And request contains "id" parameter from "deletion_request.data.id"
     When the request is sent
@@ -30,22 +32,25 @@ Feature: Data Deletion
 
   @replay-only @team:DataDog/supportability-engineering
   Scenario: Cancels a data deletion request returns "Precondition failed error" response
-    Given new "CancelDataDeletionRequest" request
+    Given operation "CancelDataDeletionRequest" enabled
+    And new "CancelDataDeletionRequest" request
     And request contains "id" parameter with value "-1"
     When the request is sent
     Then the response status is 412 Precondition failed error
 
   @generated @skip @team:DataDog/supportability-engineering
   Scenario: Creates a data deletion request returns "Bad Request" response
-    Given new "CreateDataDeletionRequest" request
+    Given operation "CreateDataDeletionRequest" enabled
+    And new "CreateDataDeletionRequest" request
     And request contains "product" parameter from "REPLACE.ME"
     And body with value {"data": {"attributes": {"from": 1672527600000, "indexes": ["test-index", "test-index-2"], "query": {"host": "abc", "service": "xyz"}, "to": 1704063600000}}}
     When the request is sent
     Then the response status is 400 Bad Request
 
   @team:DataDog/supportability-engineering
   Scenario: Creates a data deletion request returns "OK" response
-    Given new "CreateDataDeletionRequest" request
+    Given operation "CreateDataDeletionRequest" enabled
+    And new "CreateDataDeletionRequest" request
     And request contains "product" parameter with value "logs"
     And body with value {"data": {"attributes": {"from": 1672527600000, "indexes": ["test-index", "test-index-2"], "query": {"host": "abc", "service": "xyz"}, "to": 1704063600000}}}
     When the request is sent
@@ -56,21 +61,24 @@ Feature: Data Deletion
 
   @replay-only @team:DataDog/supportability-engineering
   Scenario: Creates a data deletion request returns "Precondition failed error" response
-    Given new "CreateDataDeletionRequest" request
+    Given operation "CreateDataDeletionRequest" enabled
+    And new "CreateDataDeletionRequest" request
     And request contains "product" parameter with value "logs"
     And body with value {"data": {"attributes": {"from": 1672527600000, "indexes": ["test-index", "test-index-2"], "query": {}, "to": 1704063600000}}}
     When the request is sent
     Then the response status is 412 Precondition failed error
 
   @generated @skip @team:DataDog/supportability-engineering
   Scenario: Gets a list of data deletion requests returns "Bad Request" response
-    Given new "GetDataDeletionRequests" request
+    Given operation "GetDataDeletionRequests" enabled
+    And new "GetDataDeletionRequests" request
     When the request is sent
     Then the response status is 400 Bad Request
 
   @team:DataDog/supportability-engineering
   Scenario: Gets a list of data deletion requests returns "OK" response
-    Given there is a valid "deletion_request" in the system
+    Given operation "GetDataDeletionRequests" enabled
+    And there is a valid "deletion_request" in the system
     And new "GetDataDeletionRequests" request
     When the request is sent
     Then the response status is 200 OK

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

@@ -230,6 +230,9 @@ export function createConfiguration(
       "v2.getActiveBillingDimensions": false,
       "v2.getBillingDimensionMapping": false,
       "v2.getMonthlyCostAttribution": false,
+      "v2.cancelDataDeletionRequest": false,
+      "v2.createDataDeletionRequest": false,
+      "v2.getDataDeletionRequests": false,
       "v2.createDORADeployment": false,
       "v2.createDORAIncident": false,
       "v2.createIncident": false,

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

@@ -29,6 +29,13 @@ export class DataDeletionApiRequestFactory extends BaseAPIRequestFactory {
   ): Promise<RequestContext> {
     const _config = _options || this.configuration;
 
+    logger.warn("Using unstable operation 'cancelDataDeletionRequest'");
+    if (!_config.unstableOperations["v2.cancelDataDeletionRequest"]) {
+      throw new Error(
+        "Unstable operation 'cancelDataDeletionRequest' is disabled"
+      );
+    }
+
     // verify required parameter 'id' is not null or undefined
     if (id === null || id === undefined) {
       throw new RequiredError("id", "cancelDataDeletionRequest");
@@ -63,6 +70,13 @@ export class DataDeletionApiRequestFactory extends BaseAPIRequestFactory {
   ): Promise<RequestContext> {
     const _config = _options || this.configuration;
 
+    logger.warn("Using unstable operation 'createDataDeletionRequest'");
+    if (!_config.unstableOperations["v2.createDataDeletionRequest"]) {
+      throw new Error(
+        "Unstable operation 'createDataDeletionRequest' is disabled"
+      );
+    }
+
     // verify required parameter 'product' is not null or undefined
     if (product === null || product === undefined) {
       throw new RequiredError("product", "createDataDeletionRequest");
@@ -116,6 +130,13 @@ export class DataDeletionApiRequestFactory extends BaseAPIRequestFactory {
   ): Promise<RequestContext> {
     const _config = _options || this.configuration;
 
+    logger.warn("Using unstable operation 'getDataDeletionRequests'");
+    if (!_config.unstableOperations["v2.getDataDeletionRequests"]) {
+      throw new Error(
+        "Unstable operation 'getDataDeletionRequests' is disabled"
+      );
+    }
+
     // Path Params
     const localVarPath = "/api/v2/deletion/requests";