Regenerate client from commit 7923551 of spec repo (#3430)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

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

.generator/schemas/v2/openapi.yaml

@@ -24023,6 +24023,22 @@ components:
           type: string
         flaky_state:
           $ref: '#/components/schemas/FlakyTestAttributesFlakyState'
+        history:
+          description: 'Chronological history of status changes for this flaky test,
+            ordered from most recent to oldest.
+
+            Includes state transitions like new -> quarantined -> fixed, along with
+            the associated commit SHA when available.'
+          example:
+          - commit_sha: abc123def456
+            status: quarantined
+            timestamp: 1704067200000
+          - commit_sha: ''
+            status: new
+            timestamp: 1703980800000
+          items:
+            $ref: '#/components/schemas/FlakyTestHistory'
+          type: array
         last_flaked_branch:
           description: The branch name where the test exhibited flakiness for the
             last time.
@@ -24107,6 +24123,29 @@ components:
       - FIXED
       - QUARANTINED
       - DISABLED
+    FlakyTestHistory:
+      description: A single history entry representing a status change for a flaky
+        test.
+      properties:
+        commit_sha:
+          description: The commit SHA associated with this status change. Will be
+            an empty string if the commit SHA is not available.
+          example: abc123def456
+          type: string
+        status:
+          description: The test status at this point in history.
+          example: quarantined
+          type: string
+        timestamp:
+          description: Unix timestamp in milliseconds when this status change occurred.
+          example: 1704067200000
+          format: int64
+          type: integer
+      required:
+      - status
+      - commit_sha
+      - timestamp
+      type: object
     FlakyTestPipelineStats:
       description: CI pipeline related statistics for the flaky test. This information
         is only available if test runs are associated with CI pipeline events from
@@ -24253,6 +24292,17 @@ components:
       properties:
         filter:
           $ref: '#/components/schemas/FlakyTestsSearchFilter'
+        include_history:
+          default: false
+          description: 'Whether to include the status change history for each flaky
+            test in the response.
+
+            When set to true, each test will include a `history` array with chronological
+            status changes.
+
+            Defaults to false.'
+          example: true
+          type: boolean
         page:
           $ref: '#/components/schemas/FlakyTestsSearchPageOptions'
         sort:
@@ -101085,8 +101135,33 @@ paths:
 
         If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
     post:
-      description: List endpoint returning flaky tests from Flaky Test Management.
+      description: 'List endpoint returning flaky tests from Flaky Test Management.
         Results are paginated.
+
+
+        The response includes comprehensive test information including:
+
+        - Test identification and metadata (module, suite, name)
+
+        - Flaky state and categorization
+
+        - First and last flake occurrences (timestamp, branch, commit SHA)
+
+        - Test execution statistics from the last 7 days (failure rate)
+
+        - Pipeline impact metrics (failed pipelines count, total lost time)
+
+        - Complete status change history (optional, ordered from most recent to oldest)
+
+
+        Set `include_history` to `true` in the request to receive the status change
+        history for each test.
+
+        History is disabled by default for better performance.
+
+
+        Results support filtering by various facets including service, environment,
+        repository, branch, and test state.'
       operationId: SearchFlakyTests
       requestBody:
         content:

examples/v2/test-optimization/SearchFlakyTests.ts

@@ -15,6 +15,7 @@ const params: v2.TestOptimizationApiSearchFlakyTestsRequest = {
         filter: {
           query: `flaky_test_state:active @git.repository.id_v2:"github.com/datadog/shopist"`,
         },
+        includeHistory: true,
         page: {
           cursor:
             "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",

examples/v2/test-optimization/SearchFlakyTests_1224086727.ts

@@ -15,6 +15,7 @@ const params: v2.TestOptimizationApiSearchFlakyTestsRequest = {
         filter: {
           query: `flaky_test_state:active @git.repository.id_v2:"github.com/datadog/shopist"`,
         },
+        includeHistory: true,
         page: {
           cursor:
             "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==",

examples/v2/test-optimization/SearchFlakyTests_209064879.ts

@@ -0,0 +1,36 @@
+/**
+ * Search flaky tests returns "OK" response with history
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+configuration.unstableOperations["v2.searchFlakyTests"] = true;
+const apiInstance = new v2.TestOptimizationApi(configuration);
+
+const params: v2.TestOptimizationApiSearchFlakyTestsRequest = {
+  body: {
+    data: {
+      attributes: {
+        filter: {
+          query: `flaky_test_state:active @git.repository.id_v2:"github.com/datadog/shopist"`,
+        },
+        page: {
+          limit: 10,
+        },
+        sort: "fqn",
+        includeHistory: true,
+      },
+      type: "search_flaky_tests_request",
+    },
+  },
+};
+
+apiInstance
+  .searchFlakyTests(params)
+  .then((data: v2.FlakyTestsSearchResponse) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

features/v2/test_optimization.feature

@@ -13,7 +13,7 @@ Feature: Test Optimization
   Scenario: Search flaky tests returns "Bad Request" response
     Given operation "SearchFlakyTests" enabled
     And new "SearchFlakyTests" request
-    And body with value {"data": {"attributes": {"filter": {"query": "flaky_test_state:active @git.repository.id_v2:\"github.com/datadog/shopist\""}, "page": {"cursor": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "limit": 25}, "sort": "failure_rate"}, "type": "search_flaky_tests_request"}}
+    And body with value {"data": {"attributes": {"filter": {"query": "flaky_test_state:active @git.repository.id_v2:\"github.com/datadog/shopist\""}, "include_history": true, "page": {"cursor": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "limit": 25}, "sort": "failure_rate"}, "type": "search_flaky_tests_request"}}
     When the request is sent
     Then the response status is 400 Bad Request
 
@@ -29,7 +29,7 @@ Feature: Test Optimization
   Scenario: Search flaky tests returns "OK" response
     Given operation "SearchFlakyTests" enabled
     And new "SearchFlakyTests" request
-    And body with value {"data": {"attributes": {"filter": {"query": "flaky_test_state:active @git.repository.id_v2:\"github.com/datadog/shopist\""}, "page": {"cursor": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "limit": 25}, "sort": "failure_rate"}, "type": "search_flaky_tests_request"}}
+    And body with value {"data": {"attributes": {"filter": {"query": "flaky_test_state:active @git.repository.id_v2:\"github.com/datadog/shopist\""}, "include_history": true, "page": {"cursor": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "limit": 25}, "sort": "failure_rate"}, "type": "search_flaky_tests_request"}}
     When the request is sent
     Then the response status is 200 OK
 
@@ -41,11 +41,23 @@ Feature: Test Optimization
     When the request with pagination is sent
     Then the response status is 200 OK
 
+  @skip @team:DataDog/ci-app-backend
+  Scenario: Search flaky tests returns "OK" response with history
+    Given operation "SearchFlakyTests" enabled
+    And new "SearchFlakyTests" request
+    And body with value {"data": {"attributes": {"filter": {"query": "flaky_test_state:active @git.repository.id_v2:\"github.com/datadog/shopist\""}, "page": {"limit": 10}, "sort": "fqn", "include_history": true}, "type": "search_flaky_tests_request"}}
+    When the request is sent
+    Then the response status is 200 OK
+    And the response "data[0].attributes" has field "history"
+    And the response "data[0].attributes.history[0]" has field "status"
+    And the response "data[0].attributes.history[0]" has field "commit_sha"
+    And the response "data[0].attributes.history[0]" has field "timestamp"
+
   @generated @skip @team:DataDog/ci-app-backend @with-pagination
   Scenario: Search flaky tests returns "OK" response with pagination
     Given operation "SearchFlakyTests" enabled
     And new "SearchFlakyTests" request
-    And body with value {"data": {"attributes": {"filter": {"query": "flaky_test_state:active @git.repository.id_v2:\"github.com/datadog/shopist\""}, "page": {"cursor": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "limit": 25}, "sort": "failure_rate"}, "type": "search_flaky_tests_request"}}
+    And body with value {"data": {"attributes": {"filter": {"query": "flaky_test_state:active @git.repository.id_v2:\"github.com/datadog/shopist\""}, "include_history": true, "page": {"cursor": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "limit": 25}, "sort": "failure_rate"}, "type": "search_flaky_tests_request"}}
     When the request with pagination is sent
     Then the response status is 200 OK
 

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

@@ -276,6 +276,19 @@ export class TestOptimizationApi {
 
   /**
    * List endpoint returning flaky tests from Flaky Test Management. Results are paginated.
+   *
+   * The response includes comprehensive test information including:
+   * - Test identification and metadata (module, suite, name)
+   * - Flaky state and categorization
+   * - First and last flake occurrences (timestamp, branch, commit SHA)
+   * - Test execution statistics from the last 7 days (failure rate)
+   * - Pipeline impact metrics (failed pipelines count, total lost time)
+   * - Complete status change history (optional, ordered from most recent to oldest)
+   *
+   * Set `include_history` to `true` in the request to receive the status change history for each test.
+   * History is disabled by default for better performance.
+   *
+   * Results support filtering by various facets including service, environment, repository, branch, and test state.
    * @param param The request object
    */
   public searchFlakyTests(

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

@@ -2557,6 +2557,7 @@ export { FindingVulnerabilityType } from "./models/FindingVulnerabilityType";
 export { FlakyTest } from "./models/FlakyTest";
 export { FlakyTestAttributes } from "./models/FlakyTestAttributes";
 export { FlakyTestAttributesFlakyState } from "./models/FlakyTestAttributesFlakyState";
+export { FlakyTestHistory } from "./models/FlakyTestHistory";
 export { FlakyTestPipelineStats } from "./models/FlakyTestPipelineStats";
 export { FlakyTestRunMetadata } from "./models/FlakyTestRunMetadata";
 export { FlakyTestsPagination } from "./models/FlakyTestsPagination";

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

@@ -4,6 +4,7 @@
  * Copyright 2020-Present Datadog, Inc.
  */
 import { FlakyTestAttributesFlakyState } from "./FlakyTestAttributesFlakyState";
+import { FlakyTestHistory } from "./FlakyTestHistory";
 import { FlakyTestPipelineStats } from "./FlakyTestPipelineStats";
 import { FlakyTestRunMetadata } from "./FlakyTestRunMetadata";
 import { FlakyTestStats } from "./FlakyTestStats";
@@ -49,6 +50,11 @@ export class FlakyTestAttributes {
    * The current state of the flaky test.
    */
   "flakyState"?: FlakyTestAttributesFlakyState;
+  /**
+   * Chronological history of status changes for this flaky test, ordered from most recent to oldest.
+   * Includes state transitions like new -> quarantined -> fixed, along with the associated commit SHA when available.
+   */
+  "history"?: Array<FlakyTestHistory>;
   /**
    * The branch name where the test exhibited flakiness for the last time.
    */
@@ -147,6 +153,10 @@ export class FlakyTestAttributes {
       baseName: "flaky_state",
       type: "FlakyTestAttributesFlakyState",
     },
+    history: {
+      baseName: "history",
+      type: "Array<FlakyTestHistory>",
+    },
     lastFlakedBranch: {
       baseName: "last_flaked_branch",
       type: "string",

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

@@ -0,0 +1,72 @@
+/**
+ * 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 { AttributeTypeMap } from "../../datadog-api-client-common/util";
+
+/**
+ * A single history entry representing a status change for a flaky test.
+ */
+export class FlakyTestHistory {
+  /**
+   * The commit SHA associated with this status change. Will be an empty string if the commit SHA is not available.
+   */
+  "commitSha": string;
+  /**
+   * The test status at this point in history.
+   */
+  "status": string;
+  /**
+   * Unix timestamp in milliseconds when this status change occurred.
+   */
+  "timestamp": number;
+
+  /**
+   * 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 = {
+    commitSha: {
+      baseName: "commit_sha",
+      type: "string",
+      required: true,
+    },
+    status: {
+      baseName: "status",
+      type: "string",
+      required: true,
+    },
+    timestamp: {
+      baseName: "timestamp",
+      type: "number",
+      required: true,
+      format: "int64",
+    },
+    additionalProperties: {
+      baseName: "additionalProperties",
+      type: "{ [key: string]: any; }",
+    },
+  };
+
+  /**
+   * @ignore
+   */
+  static getAttributeTypeMap(): AttributeTypeMap {
+    return FlakyTestHistory.attributeTypeMap;
+  }
+
+  public constructor() {}
+}

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

@@ -17,6 +17,12 @@ export class FlakyTestsSearchRequestAttributes {
    * Search filter settings.
    */
   "filter"?: FlakyTestsSearchFilter;
+  /**
+   * Whether to include the status change history for each flaky test in the response.
+   * When set to true, each test will include a `history` array with chronological status changes.
+   * Defaults to false.
+   */
+  "includeHistory"?: boolean;
   /**
    * Pagination attributes for listing flaky tests.
    */
@@ -46,6 +52,10 @@ export class FlakyTestsSearchRequestAttributes {
       baseName: "filter",
       type: "FlakyTestsSearchFilter",
     },
+    includeHistory: {
+      baseName: "include_history",
+      type: "boolean",
+    },
     page: {
       baseName: "page",
       type: "FlakyTestsSearchPageOptions",