Add UpdateFlakyTestState endpoint to Flaky Test Management API (#3349)

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

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

.generator/schemas/v2/openapi.yaml

@@ -61408,6 +61408,136 @@ components:
       - name
       - options
       type: object
+    UpdateFlakyTestsRequest:
+      description: Request to update the state of multiple flaky tests.
+      properties:
+        data:
+          $ref: '#/components/schemas/UpdateFlakyTestsRequestData'
+      required:
+      - data
+      type: object
+    UpdateFlakyTestsRequestAttributes:
+      description: Attributes for updating flaky test states.
+      properties:
+        tests:
+          description: List of flaky tests to update.
+          items:
+            $ref: '#/components/schemas/UpdateFlakyTestsRequestTest'
+          type: array
+      required:
+      - tests
+      type: object
+    UpdateFlakyTestsRequestData:
+      description: The JSON:API data for updating flaky test states.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/UpdateFlakyTestsRequestAttributes'
+        type:
+          $ref: '#/components/schemas/UpdateFlakyTestsRequestDataType'
+      required:
+      - type
+      - attributes
+      type: object
+    UpdateFlakyTestsRequestDataType:
+      description: The definition of `UpdateFlakyTestsRequestDataType` object.
+      enum:
+      - update_flaky_test_state_request
+      example: update_flaky_test_state_request
+      type: string
+      x-enum-varnames:
+      - UPDATE_FLAKY_TEST_STATE_REQUEST
+    UpdateFlakyTestsRequestTest:
+      description: Details of what tests to update and their new attributes.
+      properties:
+        id:
+          description: The ID of the flaky test. This is the same ID returned by the
+            Search flaky tests endpoint and corresponds to the test_fingerprint_fqn
+            field in test run events.
+          example: 4eb1887a8adb1847
+          type: string
+        new_state:
+          $ref: '#/components/schemas/UpdateFlakyTestsRequestTestNewState'
+      required:
+      - id
+      - new_state
+      type: object
+    UpdateFlakyTestsRequestTestNewState:
+      description: The new state to set for the flaky test.
+      enum:
+      - active
+      - quarantined
+      - disabled
+      - fixed
+      example: active
+      type: string
+      x-enum-varnames:
+      - ACTIVE
+      - QUARANTINED
+      - DISABLED
+      - FIXED
+    UpdateFlakyTestsResponse:
+      description: Response object for updating flaky test states.
+      properties:
+        data:
+          $ref: '#/components/schemas/UpdateFlakyTestsResponseData'
+      type: object
+    UpdateFlakyTestsResponseAttributes:
+      description: Attributes for the update flaky test state response.
+      properties:
+        has_errors:
+          description: '`True` if any errors occurred during the update operations.
+            `False` if all tests succeeded to be updated.'
+          example: true
+          type: boolean
+        results:
+          description: Results of the update operation for each test.
+          items:
+            $ref: '#/components/schemas/UpdateFlakyTestsResponseResult'
+          type: array
+      required:
+      - has_errors
+      - results
+      type: object
+    UpdateFlakyTestsResponseData:
+      description: Summary of the update operations. Tells whether a test succeeded
+        or failed to be updated.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/UpdateFlakyTestsResponseAttributes'
+        id:
+          description: The ID of the response.
+          type: string
+        type:
+          $ref: '#/components/schemas/UpdateFlakyTestsResponseDataType'
+      type: object
+    UpdateFlakyTestsResponseDataType:
+      description: The definition of `UpdateFlakyTestsResponseDataType` object.
+      enum:
+      - update_flaky_test_state_response
+      type: string
+      x-enum-varnames:
+      - UPDATE_FLAKY_TEST_STATE_RESPONSE
+    UpdateFlakyTestsResponseResult:
+      description: Result of updating a single flaky test state.
+      properties:
+        error:
+          description: Error message if the update failed.
+          type: string
+        id:
+          description: The ID of the flaky test from the request. This is the same
+            ID returned by the Search flaky tests endpoint and corresponds to the
+            test_fingerprint_fqn field in test run events.
+          example: 4eb1887a8adb1847
+          type: string
+        success:
+          description: '`True` if the update was successful, `False` if there were
+            any errors.'
+          example: false
+          type: boolean
+      required:
+      - id
+      - success
+      type: object
     UpdateOnCallNotificationRuleRequest:
       description: A top-level wrapper for updating a notification rule for a user
       example:
@@ -63757,6 +63887,8 @@ components:
             teams_read: Read Teams data. A User with this permission can view Team
               names, metadata, and which Users are on each Team.
             test_optimization_read: View Test Optimization.
+            test_optimization_write: Update flaky tests from Flaky Tests Management
+              of Test Optimization.
             timeseries_query: Query Timeseries data.
             usage_read: View your organization's usage and usage attribution.
             user_access_invite: Invite other users to your organization.
@@ -94990,6 +95122,44 @@ paths:
         - incident_settings_write
       x-unstable: '**Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/).'
   /api/v2/test/flaky-test-management/tests:
+    patch:
+      description: Update the state of multiple flaky tests in Flaky Test Management.
+      operationId: UpdateFlakyTests
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UpdateFlakyTestsRequest'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UpdateFlakyTestsResponse'
+          description: OK
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - test_optimization_write
+      summary: Update flaky test states
+      tags:
+      - Test Optimization
+      x-codegen-request-body-name: body
+      x-permission:
+        operator: OR
+        permissions:
+        - test_optimization_write
+      x-unstable: '**Note**: This endpoint is in preview and may be subject to change.
+
+        If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
     post:
       description: List endpoint returning flaky tests from Flaky Test Management.
         Results are paginated.

examples/v2/test-optimization/UpdateFlakyTests.ts

@@ -0,0 +1,34 @@
+/**
+ * Update flaky test states returns "OK" response
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+configuration.unstableOperations["v2.updateFlakyTests"] = true;
+const apiInstance = new v2.TestOptimizationApi(configuration);
+
+const params: v2.TestOptimizationApiUpdateFlakyTestsRequest = {
+  body: {
+    data: {
+      attributes: {
+        tests: [
+          {
+            id: "4eb1887a8adb1847",
+            newState: "active",
+          },
+        ],
+      },
+      type: "update_flaky_test_state_request",
+    },
+  },
+};
+
+apiInstance
+  .updateFlakyTests(params)
+  .then((data: v2.UpdateFlakyTestsResponse) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

features/support/scenarios_model_mapping.ts

@@ -10106,6 +10106,13 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
             },
         "operationResponseType": "FlakyTestsSearchResponse",
     },
+    "v2.UpdateFlakyTests": {
+        "body": {
+            "type": "UpdateFlakyTestsRequest",
+            "format": "",
+            },
+        "operationResponseType": "UpdateFlakyTestsResponse",
+    },
     "v2.SendInvitations": {
         "body": {
             "type": "UserInvitationsRequest",

features/v2/test_optimization.feature

@@ -8,35 +8,59 @@ Feature: Test Optimization
     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"}}
+    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"}}
     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"}}
+    Given operation "SearchFlakyTests" enabled
+    And new "SearchFlakyTests" request
+    And 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"}}
+    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"}}
     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"}}
+    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/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"}}
+    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"}}
     When the request with pagination is sent
     Then the response status is 200 OK
+
+  @generated @skip @team:DataDog/ci-app-backend
+  Scenario: Update flaky test states returns "Bad Request" response
+    Given operation "UpdateFlakyTests" enabled
+    And new "UpdateFlakyTests" request
+    And body with value {"data": {"attributes": {"tests": [{"id": "4eb1887a8adb1847", "new_state": "active"}]}, "type": "update_flaky_test_state_request"}}
+    When the request is sent
+    Then the response status is 400 Bad Request
+
+  @generated @skip @team:DataDog/ci-app-backend
+  Scenario: Update flaky test states returns "OK" response
+    Given operation "UpdateFlakyTests" enabled
+    And new "UpdateFlakyTests" request
+    And body with value {"data": {"attributes": {"tests": [{"id": "4eb1887a8adb1847", "new_state": "active"}]}, "type": "update_flaky_test_state_request"}}
+    When the request is sent
+    Then the response status is 200 OK

features/v2/undo.json

@@ -5161,6 +5161,12 @@
       "type": "idempotent"
     }
   },
+  "UpdateFlakyTests": {
+    "tag": "Test Optimization",
+    "undo": {
+      "type": "unsafe"
+    }
+  },
   "SearchFlakyTests": {
     "tag": "Test Optimization",
     "undo": {

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

@@ -388,6 +388,7 @@ export function createConfiguration(
       "v2.listIncidentTeams": false,
       "v2.updateIncidentTeam": false,
       "v2.searchFlakyTests": false,
+      "v2.updateFlakyTests": false,
     }
   );
   configuration.httpApi.zstdCompressorCallback = conf.zstdCompressorCallback;