diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index e8790871ff0c..ca5c6409195b 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -36980,7 +36980,11 @@ components: attributes: $ref: "#/components/schemas/FlakyTestAttributes" id: - description: Test's ID. This ID is the hash of the test's Fully Qualified Name and Git repository ID. On the Test Runs UI it is the same as the `test_fingerprint_fqn` tag. + description: |- + Test's ID. This ID is the hash of the test's Fully Qualified Name and Git repository ID. It is the + value of the `@test.fingerprint_fqn` facet on test events, which you can search on in the Test + Optimization Explorer to locate a specific test. To filter search results by this ID, use the + `fingerprint_fqn` search key. type: string type: $ref: "#/components/schemas/FlakyTestType" @@ -37362,6 +37366,9 @@ components: - `@git.branch` - `@test.codeowners` - `env` + - `fingerprint_fqn` + + Use `fingerprint_fqn` to filter by a test's stable Fingerprint FQN (the same value as the test's `id`). example: 'flaky_test_state:active @git.repository.id_v2:"github.com/datadog/shopist"' type: string type: object @@ -106672,7 +106679,11 @@ components: 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. + description: |- + The ID of the flaky test. This is the same ID returned by the Search flaky tests endpoint and is the + value of the `@test.fingerprint_fqn` facet on test events. You can find it by searching on + `@test.fingerprint_fqn` in the Test Optimization Explorer, or by filtering the Search flaky tests + endpoint with the `fingerprint_fqn` key. example: 4eb1887a8adb1847 type: string new_state: @@ -106742,7 +106753,10 @@ components: 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. + description: |- + The ID of the flaky test from the request. This is the value of the `@test.fingerprint_fqn` facet + on test events, the same ID accepted by the update request and returned by the Search flaky tests + endpoint. example: 4eb1887a8adb1847 type: string success: diff --git a/lib/datadog_api_client/v2/models/flaky_test.rb b/lib/datadog_api_client/v2/models/flaky_test.rb index ca3c7a8f9018..c4dd8e9de9af 100644 --- a/lib/datadog_api_client/v2/models/flaky_test.rb +++ b/lib/datadog_api_client/v2/models/flaky_test.rb @@ -24,7 +24,10 @@ class FlakyTest # Attributes of a flaky test. attr_accessor :attributes - # Test's ID. This ID is the hash of the test's Fully Qualified Name and Git repository ID. On the Test Runs UI it is the same as the `test_fingerprint_fqn` tag. + # Test's ID. This ID is the hash of the test's Fully Qualified Name and Git repository ID. It is the + # value of the `@test.fingerprint_fqn` facet on test events, which you can search on in the Test + # Optimization Explorer to locate a specific test. To filter search results by this ID, use the + # `fingerprint_fqn` search key. attr_accessor :id # The type of the flaky test from Flaky Test Management. diff --git a/lib/datadog_api_client/v2/models/flaky_tests_search_filter.rb b/lib/datadog_api_client/v2/models/flaky_tests_search_filter.rb index 64751326ec53..704199050a7c 100644 --- a/lib/datadog_api_client/v2/models/flaky_tests_search_filter.rb +++ b/lib/datadog_api_client/v2/models/flaky_tests_search_filter.rb @@ -37,6 +37,9 @@ class FlakyTestsSearchFilter # - `@git.branch` # - `@test.codeowners` # - `env` + # - `fingerprint_fqn` + # + # Use `fingerprint_fqn` to filter by a test's stable Fingerprint FQN (the same value as the test's `id`). attr_accessor :query attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/update_flaky_tests_request_test.rb b/lib/datadog_api_client/v2/models/update_flaky_tests_request_test.rb index 28a667b05246..05152375a76d 100644 --- a/lib/datadog_api_client/v2/models/update_flaky_tests_request_test.rb +++ b/lib/datadog_api_client/v2/models/update_flaky_tests_request_test.rb @@ -21,7 +21,10 @@ module DatadogAPIClient::V2 class UpdateFlakyTestsRequestTest include BaseGenericModel - # 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. + # The ID of the flaky test. This is the same ID returned by the Search flaky tests endpoint and is the + # value of the `@test.fingerprint_fqn` facet on test events. You can find it by searching on + # `@test.fingerprint_fqn` in the Test Optimization Explorer, or by filtering the Search flaky tests + # endpoint with the `fingerprint_fqn` key. attr_reader :id # The new state to set for the flaky test. diff --git a/lib/datadog_api_client/v2/models/update_flaky_tests_response_result.rb b/lib/datadog_api_client/v2/models/update_flaky_tests_response_result.rb index 3dab004db158..0d0c86eaa0b7 100644 --- a/lib/datadog_api_client/v2/models/update_flaky_tests_response_result.rb +++ b/lib/datadog_api_client/v2/models/update_flaky_tests_response_result.rb @@ -24,7 +24,9 @@ class UpdateFlakyTestsResponseResult # Error message if the update failed. attr_accessor :error - # 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. + # The ID of the flaky test from the request. This is the value of the `@test.fingerprint_fqn` facet + # on test events, the same ID accepted by the update request and returned by the Search flaky tests + # endpoint. attr_reader :id # `True` if the update was successful, `False` if there were any errors.