Update response for retention filters API (#1602)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-04-22 11:29:46.702337",
-            "spec_repo_commit": "0f37d2e6"
+            "regenerated": "2024-04-22 13:22:17.885412",
+            "spec_repo_commit": "c2c10f21"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-04-22 11:29:46.720414",
-            "spec_repo_commit": "0f37d2e6"
+            "regenerated": "2024-04-22 13:22:17.904162",
+            "spec_repo_commit": "c2c10f21"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -16174,12 +16174,18 @@ components:
       required:
       - data
       type: object
-    RetentionFilterResponse:
+    RetentionFilterCreateResponse:
       description: The retention filters definition.
       properties:
         data:
           $ref: '#/components/schemas/RetentionFilter'
       type: object
+    RetentionFilterResponse:
+      description: The retention filters definition.
+      properties:
+        data:
+          $ref: '#/components/schemas/RetentionFilterAll'
+      type: object
     RetentionFilterType:
       default: spans-sampling-processor
       description: The type of retention filter. The value should always be spans-sampling-processor.
@@ -23321,7 +23327,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/RetentionFilterResponse'
+                $ref: '#/components/schemas/RetentionFilterCreateResponse'
           description: OK
         '400':
           $ref: '#/components/responses/BadRequestResponse'

examples/v2/apm-retention-filters/CreateApmRetentionFilter.ts

@@ -26,7 +26,7 @@ const params: v2.APMRetentionFiltersApiCreateApmRetentionFilterRequest = {
 
 apiInstance
   .createApmRetentionFilter(params)
-  .then((data: v2.RetentionFilterResponse) => {
+  .then((data: v2.RetentionFilterCreateResponse) => {
     console.log(
       "API called successfully. Returned data: " + JSON.stringify(data)
     );

features/support/scenarios_model_mapping.ts

@@ -2547,7 +2547,7 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
             "type": "RetentionFilterCreateRequest",
             "format": "",
             },
-        "operationResponseType": "RetentionFilterResponse",
+        "operationResponseType": "RetentionFilterCreateResponse",
     },
     "v2.ReorderApmRetentionFilters": {
         "body": {

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

@@ -19,6 +19,7 @@ import { ApiException } from "../../datadog-api-client-common/exception";
 import { APIErrorResponse } from "../models/APIErrorResponse";
 import { ReorderRetentionFiltersRequest } from "../models/ReorderRetentionFiltersRequest";
 import { RetentionFilterCreateRequest } from "../models/RetentionFilterCreateRequest";
+import { RetentionFilterCreateResponse } from "../models/RetentionFilterCreateResponse";
 import { RetentionFilterResponse } from "../models/RetentionFilterResponse";
 import { RetentionFiltersResponse } from "../models/RetentionFiltersResponse";
 import { RetentionFilterUpdateRequest } from "../models/RetentionFilterUpdateRequest";
@@ -260,15 +261,15 @@ export class APMRetentionFiltersApiResponseProcessor {
    */
   public async createApmRetentionFilter(
     response: ResponseContext
-  ): Promise<RetentionFilterResponse> {
+  ): Promise<RetentionFilterCreateResponse> {
     const contentType = ObjectSerializer.normalizeMediaType(
       response.headers["content-type"]
     );
     if (response.httpStatusCode === 200) {
-      const body: RetentionFilterResponse = ObjectSerializer.deserialize(
+      const body: RetentionFilterCreateResponse = ObjectSerializer.deserialize(
         ObjectSerializer.parse(await response.body.text(), contentType),
-        "RetentionFilterResponse"
-      ) as RetentionFilterResponse;
+        "RetentionFilterCreateResponse"
+      ) as RetentionFilterCreateResponse;
       return body;
     }
     if (
@@ -299,11 +300,11 @@ export class APMRetentionFiltersApiResponseProcessor {
 
     // Work around for missing responses in specification, e.g. for petstore.yaml
     if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
-      const body: RetentionFilterResponse = ObjectSerializer.deserialize(
+      const body: RetentionFilterCreateResponse = ObjectSerializer.deserialize(
         ObjectSerializer.parse(await response.body.text(), contentType),
-        "RetentionFilterResponse",
+        "RetentionFilterCreateResponse",
         ""
-      ) as RetentionFilterResponse;
+      ) as RetentionFilterCreateResponse;
       return body;
     }
 
@@ -686,7 +687,7 @@ export class APMRetentionFiltersApi {
   public createApmRetentionFilter(
     param: APMRetentionFiltersApiCreateApmRetentionFilterRequest,
     options?: Configuration
-  ): Promise<RetentionFilterResponse> {
+  ): Promise<RetentionFilterCreateResponse> {
     const requestContextPromise = this.requestFactory.createApmRetentionFilter(
       param.body,
       options

packages/datadog-api-client-v2/index.ts

@@ -1477,6 +1477,7 @@ export { RetentionFilterAttributes } from "./models/RetentionFilterAttributes";
 export { RetentionFilterCreateAttributes } from "./models/RetentionFilterCreateAttributes";
 export { RetentionFilterCreateData } from "./models/RetentionFilterCreateData";
 export { RetentionFilterCreateRequest } from "./models/RetentionFilterCreateRequest";
+export { RetentionFilterCreateResponse } from "./models/RetentionFilterCreateResponse";
 export { RetentionFilterResponse } from "./models/RetentionFilterResponse";
 export { RetentionFiltersResponse } from "./models/RetentionFiltersResponse";
 export { RetentionFilterType } from "./models/RetentionFilterType";

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

@@ -790,6 +790,7 @@ import { RetentionFilterAttributes } from "./RetentionFilterAttributes";
 import { RetentionFilterCreateAttributes } from "./RetentionFilterCreateAttributes";
 import { RetentionFilterCreateData } from "./RetentionFilterCreateData";
 import { RetentionFilterCreateRequest } from "./RetentionFilterCreateRequest";
+import { RetentionFilterCreateResponse } from "./RetentionFilterCreateResponse";
 import { RetentionFilterResponse } from "./RetentionFilterResponse";
 import { RetentionFilterUpdateAttributes } from "./RetentionFilterUpdateAttributes";
 import { RetentionFilterUpdateData } from "./RetentionFilterUpdateData";
@@ -2584,6 +2585,7 @@ const typeMap: { [index: string]: any } = {
   RetentionFilterCreateAttributes: RetentionFilterCreateAttributes,
   RetentionFilterCreateData: RetentionFilterCreateData,
   RetentionFilterCreateRequest: RetentionFilterCreateRequest,
+  RetentionFilterCreateResponse: RetentionFilterCreateResponse,
   RetentionFilterResponse: RetentionFilterResponse,
   RetentionFilterUpdateAttributes: RetentionFilterUpdateAttributes,
   RetentionFilterUpdateData: RetentionFilterUpdateData,

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

@@ -0,0 +1,53 @@
+/**
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2020-Present Datadog, Inc.
+ */
+import { RetentionFilter } from "./RetentionFilter";
+
+import { AttributeTypeMap } from "../../datadog-api-client-common/util";
+
+/**
+ * The retention filters definition.
+ */
+export class RetentionFilterCreateResponse {
+  /**
+   * The definition of the retention filter.
+   */
+  "data"?: RetentionFilter;
+
+  /**
+   * A container for additional, undeclared properties.
+   * This is a holder for any undeclared properties as specified with
+   * the 'additionalProperties' keyword in the OAS document.
+   */
+  "additionalProperties"?: { [key: string]: any };
+
+  /**
+   * @ignore
+   */
+  "_unparsed"?: boolean;
+
+  /**
+   * @ignore
+   */
+  static readonly attributeTypeMap: AttributeTypeMap = {
+    data: {
+      baseName: "data",
+      type: "RetentionFilter",
+    },
+    additionalProperties: {
+      baseName: "additionalProperties",
+      type: "any",
+    },
+  };
+
+  /**
+   * @ignore
+   */
+  static getAttributeTypeMap(): AttributeTypeMap {
+    return RetentionFilterCreateResponse.attributeTypeMap;
+  }
+
+  public constructor() {}
+}

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

@@ -3,7 +3,7 @@
  * This product includes software developed at Datadog (https://www.datadoghq.com/).
  * Copyright 2020-Present Datadog, Inc.
  */
-import { RetentionFilter } from "./RetentionFilter";
+import { RetentionFilterAll } from "./RetentionFilterAll";
 
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
 
@@ -14,7 +14,7 @@ export class RetentionFilterResponse {
   /**
    * The definition of the retention filter.
    */
-  "data"?: RetentionFilter;
+  "data"?: RetentionFilterAll;
 
   /**
    * A container for additional, undeclared properties.
@@ -34,7 +34,7 @@ export class RetentionFilterResponse {
   static readonly attributeTypeMap: AttributeTypeMap = {
     data: {
       baseName: "data",
-      type: "RetentionFilter",
+      type: "RetentionFilterAll",
     },
     additionalProperties: {
       baseName: "additionalProperties",