Documenting the new Flaky Test Management API endpoint for public beta (#2787)

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

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

.generator/schemas/v2/openapi.yaml

@@ -0,0 +1,42 @@
+@endpoint(test-optimization) @endpoint(test-optimization-v2)
+Feature: Test Optimization
+  Search and manage flaky tests through Test Optimization. See the [Test
+  Optimization page](https://docs.datadoghq.com/tests/) for more
+  information.
+
+  Background:
+    Given a valid "apiKeyAuth" key in the system
+    And a valid "appKeyAuth" key in the system
+    And an instance of "TestOptimization" API
+    And operation "SearchFlakyTests" enabled
+    And new "SearchFlakyTests" request
+
+  @generated @skip @team:DataDog/ci-app-backend
+  Scenario: Search flaky tests returns "Bad Request" response
+    Given 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"}}
+    When the request is sent
+    Then the response status is 400 Bad Request
+
+  @skip @team:DataDog/ci-app-backend
+  Scenario: Search flaky tests returns "Bad Request" response with invalid limit
+    Given body with value {"data": {"attributes": {"filter": {"query": "*"}, "page": {"limit": 2000}, "sort": "fqn"}, "type": "search_flaky_tests_request"}}
+    When the request is sent
+    Then the response status is 400 Bad Request
+
+  @generated @skip @team:DataDog/ci-app-backend
+  Scenario: Search flaky tests returns "OK" response
+    Given 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"}}
+    When the request is sent
+    Then the response status is 200 OK
+
+  @replay-only @skip @skip-validation @team:DataDog/ci-app-backend @with-pagination
+  Scenario: Search flaky tests returns "OK" response with filtered query
+    Given body with value {"data": {"attributes": {"filter": {"query": "flaky_test_state:active @git.repository.id_v2:\"github.com/datadog/cart-tracking\""}, "page": {"limit": 10}, "sort": "-last_flaked"}, "type": "search_flaky_tests_request"}}
+    When the request with pagination is sent
+    Then the response status is 200 OK
+
+  @generated @skip @team:DataDog/ci-app-backend @with-pagination
+  Scenario: Search flaky tests returns "OK" response with pagination
+    Given 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"}}
+    When the request with pagination is sent
+    Then the response status is 200 OK

features/v2/test_optimization.feature

@@ -3978,6 +3978,12 @@
       "type": "idempotent"
     }
   },
+  "SearchFlakyTests": {
+    "tag": "Test Optimization",
+    "undo": {
+      "type": "safe"
+    }
+  },
   "GetUsageApplicationSecurityMonitoring": {
     "tag": "Usage Metering",
     "undo": {

features/v2/undo.json

@@ -432,6 +432,7 @@ apiInstance
 | Synthetics | @datadog/datadog-api-client-synthetics | [README.md](../../services/synthetics/README.md) |
 | Tags | @datadog/datadog-api-client-tags | [README.md](../../services/tags/README.md) |
 | Teams | @datadog/datadog-api-client-teams | [README.md](../../services/teams/README.md) |
+| Test Optimization | @datadog/datadog-api-client-test-optimization | [README.md](../../services/test-optimization/README.md) |
 | Usage Metering | @datadog/datadog-api-client-usage-metering | [README.md](../../services/usage-metering/README.md) |
 | Users | @datadog/datadog-api-client-users | [README.md](../../services/users/README.md) |
 | Webhooks Integration | @datadog/datadog-api-client-webhooks-integration | [README.md](../../services/webhooks-integration/README.md) |

packages/datadog-api-client/README.md

@@ -8429,6 +8429,13 @@ export const ScenariosModelMappings: { [key: string]: OperationMapping } = {
     },
     operationResponseType: "IncidentTeamResponse",
   },
+  "TestOptimizationApi.V2.SearchFlakyTests": {
+    body: {
+      type: "FlakyTestsSearchRequest",
+      format: "",
+    },
+    operationResponseType: "FlakyTestsSearchResponse",
+  },
   "UsersApi.V2.SendInvitations": {
     body: {
       type: "UserInvitationsRequest",

private/bdd_runner/src/support/scenarios_model_mapping.ts

@@ -0,0 +1 @@
+nodeLinker: node-modules

services/test_optimization/.yarnrc.yml

@@ -0,0 +1,44 @@
+# @datadog/datadog-api-client-test-optimization
+
+## Description
+
+Search and manage flaky tests through Test Optimization. See the [Test Optimization page](https://docs.datadoghq.com/tests/) for more information.
+
+## Navigation
+
+- [Installation](#installation)
+- [Getting Started](#getting-started)
+
+## Installation
+
+```sh
+# NPM
+npm install @datadog/datadog-api-client-test-optimization
+# Yarn
+yarn add @datadog/datadog-api-client-test-optimization
+```
+
+## Getting Started
+```ts
+import { createConfiguration } from "@datadog/datadog-api-client";
+import { TestOptimizationApiV2 } from "@datadog/datadog-api-client-test-optimization";
+import { v2 } from "@datadog/datadog-api-client-test-optimization";
+
+const configuration = createConfiguration();
+// Enable unstable operations
+const configurationOpts = {
+    unstableOperations: {
+        "TestOptimizationApi.v2.searchFlakyTests": true
+    }
+}
+
+const configuration = createConfiguration(configurationOpts);
+const apiInstance = new TestOptimizationApiV2(configuration);
+const params = {/* parameters */};
+
+apiInstance.searchFlakyTests(params).then((data) => {
+    console.log("API called successfully. Returned data: " + JSON.stringify(data));
+}).catch((error) => {
+    console.error("Error calling API: " + error);
+});
+```

services/test_optimization/README.md

@@ -0,0 +1,43 @@
+{
+  "name": "@datadog/datadog-api-client-test-optimization",
+  "description": "",
+  "author": "",
+  "keywords": [
+    "api",
+    "fetch",
+    "typescript"
+  ],
+  "license": "Apache-2.0",
+  "licenses": [
+    {
+      "type": "Apache-2.0",
+      "url": "http://www.apache.org/licenses/LICENSE-2.0"
+    }
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DataDog/datadog-api-client-typescript.git",
+    "directory": "services/test-optimization"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "main": "./dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "scripts": {
+    "prepack": "yarn workspace @datadog/datadog-api-client build && yarn build",
+    "build": "yarn generate-version-files && tsc",
+    "generate-version-files": "node -p \"'export const version = ' + JSON.stringify(require('./package.json').version)\" > src/version.ts"
+  },
+  "dependencies": {
+    "@datadog/datadog-api-client": "^2.0.0-beta.0"
+  },
+  "devDependencies": {
+    "typescript": "5.8.3"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "version": "0.0.1",
+  "packageManager": "[email protected]"
+}

services/test_optimization/package.json

@@ -0,0 +1,3 @@
+export * as v2 from "./v2";
+
+export { TestOptimizationApi as TestOptimizationApiV2 } from "./v2/TestOptimizationApi";