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

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.

api/datadog/configuration.go

@@ -819,6 +819,7 @@ func NewConfiguration() *Configuration {
 			"v2.ListIncidentTeams":                       false,
 			"v2.UpdateIncidentTeam":                      false,
 			"v2.SearchFlakyTests":                        false,
+			"v2.UpdateFlakyTests":                        false,
 		},
 		RetryConfiguration: RetryConfiguration{
 			EnableRetry:       false,

api/datadogV2/api_test_optimization.go

@@ -203,6 +203,95 @@ func (a *TestOptimizationApi) SearchFlakyTestsWithPagination(ctx _context.Contex
 	return items, cancel
 }
 
+// UpdateFlakyTests Update flaky test states.
+// Update the state of multiple flaky tests in Flaky Test Management.
+func (a *TestOptimizationApi) UpdateFlakyTests(ctx _context.Context, body UpdateFlakyTestsRequest) (UpdateFlakyTestsResponse, *_nethttp.Response, error) {
+	var (
+		localVarHTTPMethod  = _nethttp.MethodPatch
+		localVarPostBody    interface{}
+		localVarReturnValue UpdateFlakyTestsResponse
+	)
+
+	operationId := "v2.UpdateFlakyTests"
+	isOperationEnabled := a.Client.Cfg.IsUnstableOperationEnabled(operationId)
+	if !isOperationEnabled {
+		return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: _fmt.Sprintf("Unstable operation '%s' is disabled", operationId)}
+	}
+	if isOperationEnabled && a.Client.Cfg.Debug {
+		_log.Printf("WARNING: Using unstable operation '%s'", operationId)
+	}
+
+	localBasePath, err := a.Client.Cfg.ServerURLWithContext(ctx, "v2.TestOptimizationApi.UpdateFlakyTests")
+	if err != nil {
+		return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: err.Error()}
+	}
+
+	localVarPath := localBasePath + "/api/v2/test/flaky-test-management/tests"
+
+	localVarHeaderParams := make(map[string]string)
+	localVarQueryParams := _neturl.Values{}
+	localVarFormParams := _neturl.Values{}
+	localVarHeaderParams["Content-Type"] = "application/json"
+	localVarHeaderParams["Accept"] = "application/json"
+
+	// body params
+	localVarPostBody = &body
+	if a.Client.Cfg.DelegatedTokenConfig != nil {
+		err = datadog.UseDelegatedTokenAuth(ctx, &localVarHeaderParams, a.Client.Cfg.DelegatedTokenConfig)
+		if err != nil {
+			return localVarReturnValue, nil, err
+		}
+	} else {
+		datadog.SetAuthKeys(
+			ctx,
+			&localVarHeaderParams,
+			[2]string{"apiKeyAuth", "DD-API-KEY"},
+			[2]string{"appKeyAuth", "DD-APPLICATION-KEY"},
+		)
+	}
+	req, err := a.Client.PrepareRequest(ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, nil)
+	if err != nil {
+		return localVarReturnValue, nil, err
+	}
+
+	localVarHTTPResponse, err := a.Client.CallAPI(req)
+	if err != nil || localVarHTTPResponse == nil {
+		return localVarReturnValue, localVarHTTPResponse, err
+	}
+
+	localVarBody, err := datadog.ReadBody(localVarHTTPResponse)
+	if err != nil {
+		return localVarReturnValue, localVarHTTPResponse, err
+	}
+
+	if localVarHTTPResponse.StatusCode >= 300 {
+		newErr := datadog.GenericOpenAPIError{
+			ErrorBody:    localVarBody,
+			ErrorMessage: localVarHTTPResponse.Status,
+		}
+		if localVarHTTPResponse.StatusCode == 400 || localVarHTTPResponse.StatusCode == 403 || localVarHTTPResponse.StatusCode == 429 {
+			var v APIErrorResponse
+			err = a.Client.Decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
+			if err != nil {
+				return localVarReturnValue, localVarHTTPResponse, newErr
+			}
+			newErr.ErrorModel = v
+		}
+		return localVarReturnValue, localVarHTTPResponse, newErr
+	}
+
+	err = a.Client.Decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
+	if err != nil {
+		newErr := datadog.GenericOpenAPIError{
+			ErrorBody:    localVarBody,
+			ErrorMessage: err.Error(),
+		}
+		return localVarReturnValue, localVarHTTPResponse, newErr
+	}
+
+	return localVarReturnValue, localVarHTTPResponse, nil
+}
+
 // NewTestOptimizationApi Returns NewTestOptimizationApi.
 func NewTestOptimizationApi(client *datadog.APIClient) *TestOptimizationApi {
 	return &TestOptimizationApi{

api/datadogV2/doc.go

@@ -738,6 +738,7 @@
 //   - [TeamsApi.UpdateTeamNotificationRule]
 //   - [TeamsApi.UpdateTeamPermissionSetting]
 //   - [TestOptimizationApi.SearchFlakyTests]
+//   - [TestOptimizationApi.UpdateFlakyTests]
 //   - [UsageMeteringApi.GetActiveBillingDimensions]
 //   - [UsageMeteringApi.GetBillingDimensionMapping]
 //   - [UsageMeteringApi.GetCostByOrg]