Update SearchFlakyTests endpoint documentation (#3929)

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

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

.generator/schemas/v2/openapi.yaml

@@ -26664,9 +26664,18 @@ components:
             Includes state transitions like new -> quarantined -> fixed, along with the associated commit SHA when available.
           example:
             - commit_sha: abc123def456
+              policy_id: ftm_policy.quarantine.failure_rate
+              policy_meta:
+                config:
+                  failure_rate: 0.1
+                  required_runs: 100
+                failure_rate: 0.25
+                total_runs: 200
               status: quarantined
               timestamp: 1704067200000
             - commit_sha: ""
+              policy_id: unknown
+              policy_meta:
               status: new
               timestamp: 1703980800000
           items:
@@ -26736,6 +26745,11 @@ components:
           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
+        policy_id:
+          $ref: "#/components/schemas/FlakyTestHistoryPolicyId"
+        policy_meta:
+          $ref: "#/components/schemas/FlakyTestHistoryPolicyMeta"
+          nullable: true
         status:
           description: The test status at this point in history.
           example: quarantined
@@ -26750,6 +26764,131 @@ components:
         - commit_sha
         - timestamp
       type: object
+    FlakyTestHistoryPolicyId:
+      description: The policy that triggered this status change.
+      enum:
+        - ftm_policy.manual
+        - ftm_policy.fixed
+        - ftm_policy.disable.failure_rate
+        - ftm_policy.disable.branch_flake
+        - ftm_policy.disable.days_active
+        - ftm_policy.quarantine.failure_rate
+        - ftm_policy.quarantine.branch_flake
+        - ftm_policy.quarantine.days_active
+        - unknown
+      example: ftm_policy.quarantine.failure_rate
+      nullable: false
+      type: string
+      x-enum-varnames:
+        - MANUAL
+        - FIXED
+        - DISABLE_FAILURE_RATE
+        - DISABLE_BRANCH_FLAKE
+        - DISABLE_DAYS_ACTIVE
+        - QUARANTINE_FAILURE_RATE
+        - QUARANTINE_BRANCH_FLAKE
+        - QUARANTINE_DAYS_ACTIVE
+        - UNKNOWN
+    FlakyTestHistoryPolicyMeta:
+      description: Metadata about the policy that triggered this status change.
+      properties:
+        branches:
+          description: Branches where the test was flaky at the time of the status change.
+          example: ["main", "develop"]
+          items:
+            type: string
+          nullable: true
+          type: array
+        config:
+          $ref: "#/components/schemas/FlakyTestHistoryPolicyMetaConfig"
+          nullable: true
+        days_active:
+          description: The number of days the test has been active at the time of the status change.
+          example: 15
+          format: int32
+          maximum: 2147483647
+          nullable: true
+          type: integer
+        days_without_flake:
+          description: The number of days since the test last exhibited flakiness.
+          example: 30
+          format: int32
+          maximum: 2147483647
+          nullable: true
+          type: integer
+        failure_rate:
+          description: The failure rate of the test at the time of the status change.
+          example: 0.25
+          format: double
+          maximum: 1
+          minimum: 0
+          nullable: true
+          type: number
+        state:
+          description: The previous state of the test.
+          example: quarantined
+          nullable: true
+          type: string
+        total_runs:
+          description: The total number of test runs at the time of the status change.
+          example: 200
+          format: int32
+          maximum: 2147483647
+          nullable: true
+          type: integer
+      type: object
+    FlakyTestHistoryPolicyMetaConfig:
+      description: Configuration parameters of the policy that triggered this status change.
+      properties:
+        branches:
+          description: The branches considered by the policy.
+          example: ["main"]
+          items:
+            type: string
+          nullable: true
+          type: array
+        days_active:
+          description: The number of days a test must have been active for the policy to trigger.
+          example: 30
+          format: int32
+          maximum: 2147483647
+          nullable: true
+          type: integer
+        failure_rate:
+          description: The failure rate threshold for the policy to trigger.
+          example: 0.7
+          format: double
+          maximum: 1
+          minimum: 0
+          nullable: true
+          type: number
+        forget_branches:
+          description: Branches excluded from the policy evaluation.
+          example: ["release"]
+          items:
+            type: string
+          nullable: true
+          type: array
+        required_runs:
+          description: The minimum number of test runs required for the policy to trigger.
+          example: 100
+          format: int32
+          maximum: 2147483647
+          nullable: true
+          type: integer
+        state:
+          description: The target state the policy transitions the test from.
+          example: quarantined
+          nullable: true
+          type: string
+        test_services:
+          description: Test services excluded from the policy evaluation.
+          example: ["my-service"]
+          items:
+            type: string
+          nullable: true
+          type: array
+      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 CI Visibility.
       properties:
@@ -26829,6 +26968,14 @@ components:
     FlakyTestsSearchFilter:
       description: Search filter settings.
       properties:
+        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
         query:
           default: "*"
           description: |-
@@ -26874,14 +27021,6 @@ 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:

api/datadogV2/model_flaky_test_history.go

@@ -14,6 +14,10 @@ import (
 type FlakyTestHistory struct {
 	// The commit SHA associated with this status change. Will be an empty string if the commit SHA is not available.
 	CommitSha string `json:"commit_sha"`
+	// The policy that triggered this status change.
+	PolicyId *FlakyTestHistoryPolicyId `json:"policy_id,omitempty"`
+	// Metadata about the policy that triggered this status change.
+	PolicyMeta *FlakyTestHistoryPolicyMeta `json:"policy_meta,omitempty"`
 	// The test status at this point in history.
 	Status string `json:"status"`
 	// Unix timestamp in milliseconds when this status change occurred.
@@ -66,6 +70,62 @@ func (o *FlakyTestHistory) SetCommitSha(v string) {
 	o.CommitSha = v
 }
 
+// GetPolicyId returns the PolicyId field value if set, zero value otherwise.
+func (o *FlakyTestHistory) GetPolicyId() FlakyTestHistoryPolicyId {
+	if o == nil || o.PolicyId == nil {
+		var ret FlakyTestHistoryPolicyId
+		return ret
+	}
+	return *o.PolicyId
+}
+
+// GetPolicyIdOk returns a tuple with the PolicyId field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *FlakyTestHistory) GetPolicyIdOk() (*FlakyTestHistoryPolicyId, bool) {
+	if o == nil || o.PolicyId == nil {
+		return nil, false
+	}
+	return o.PolicyId, true
+}
+
+// HasPolicyId returns a boolean if a field has been set.
+func (o *FlakyTestHistory) HasPolicyId() bool {
+	return o != nil && o.PolicyId != nil
+}
+
+// SetPolicyId gets a reference to the given FlakyTestHistoryPolicyId and assigns it to the PolicyId field.
+func (o *FlakyTestHistory) SetPolicyId(v FlakyTestHistoryPolicyId) {
+	o.PolicyId = &v
+}
+
+// GetPolicyMeta returns the PolicyMeta field value if set, zero value otherwise.
+func (o *FlakyTestHistory) GetPolicyMeta() FlakyTestHistoryPolicyMeta {
+	if o == nil || o.PolicyMeta == nil {
+		var ret FlakyTestHistoryPolicyMeta
+		return ret
+	}
+	return *o.PolicyMeta
+}
+
+// GetPolicyMetaOk returns a tuple with the PolicyMeta field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *FlakyTestHistory) GetPolicyMetaOk() (*FlakyTestHistoryPolicyMeta, bool) {
+	if o == nil || o.PolicyMeta == nil {
+		return nil, false
+	}
+	return o.PolicyMeta, true
+}
+
+// HasPolicyMeta returns a boolean if a field has been set.
+func (o *FlakyTestHistory) HasPolicyMeta() bool {
+	return o != nil && o.PolicyMeta != nil
+}
+
+// SetPolicyMeta gets a reference to the given FlakyTestHistoryPolicyMeta and assigns it to the PolicyMeta field.
+func (o *FlakyTestHistory) SetPolicyMeta(v FlakyTestHistoryPolicyMeta) {
+	o.PolicyMeta = &v
+}
+
 // GetStatus returns the Status field value.
 func (o *FlakyTestHistory) GetStatus() string {
 	if o == nil {
@@ -119,6 +179,12 @@ func (o FlakyTestHistory) MarshalJSON() ([]byte, error) {
 		return datadog.Marshal(o.UnparsedObject)
 	}
 	toSerialize["commit_sha"] = o.CommitSha
+	if o.PolicyId != nil {
+		toSerialize["policy_id"] = o.PolicyId
+	}
+	if o.PolicyMeta != nil {
+		toSerialize["policy_meta"] = o.PolicyMeta
+	}
 	toSerialize["status"] = o.Status
 	toSerialize["timestamp"] = o.Timestamp
 
@@ -131,9 +197,11 @@ func (o FlakyTestHistory) MarshalJSON() ([]byte, error) {
 // UnmarshalJSON deserializes the given payload.
 func (o *FlakyTestHistory) UnmarshalJSON(bytes []byte) (err error) {
 	all := struct {
-		CommitSha *string `json:"commit_sha"`
-		Status    *string `json:"status"`
-		Timestamp *int64  `json:"timestamp"`
+		CommitSha  *string                     `json:"commit_sha"`
+		PolicyId   *FlakyTestHistoryPolicyId   `json:"policy_id,omitempty"`
+		PolicyMeta *FlakyTestHistoryPolicyMeta `json:"policy_meta,omitempty"`
+		Status     *string                     `json:"status"`
+		Timestamp  *int64                      `json:"timestamp"`
 	}{}
 	if err = datadog.Unmarshal(bytes, &all); err != nil {
 		return datadog.Unmarshal(bytes, &o.UnparsedObject)
@@ -149,17 +217,32 @@ func (o *FlakyTestHistory) UnmarshalJSON(bytes []byte) (err error) {
 	}
 	additionalProperties := make(map[string]interface{})
 	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
-		datadog.DeleteKeys(additionalProperties, &[]string{"commit_sha", "status", "timestamp"})
+		datadog.DeleteKeys(additionalProperties, &[]string{"commit_sha", "policy_id", "policy_meta", "status", "timestamp"})
 	} else {
 		return err
 	}
+
+	hasInvalidField := false
 	o.CommitSha = *all.CommitSha
+	if all.PolicyId != nil && !all.PolicyId.IsValid() {
+		hasInvalidField = true
+	} else {
+		o.PolicyId = all.PolicyId
+	}
+	if all.PolicyMeta != nil && all.PolicyMeta.UnparsedObject != nil && o.UnparsedObject == nil {
+		hasInvalidField = true
+	}
+	o.PolicyMeta = all.PolicyMeta
 	o.Status = *all.Status
 	o.Timestamp = *all.Timestamp
 
 	if len(additionalProperties) > 0 {
 		o.AdditionalProperties = additionalProperties
 	}
 
+	if hasInvalidField {
+		return datadog.Unmarshal(bytes, &o.UnparsedObject)
+	}
+
 	return nil
 }