diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index e8790871ff..ca5c640919 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/src/datadog_api_client/v2/model/flaky_test.py b/src/datadog_api_client/v2/model/flaky_test.py index 26136bdf12..90466809d6 100644 --- a/src/datadog_api_client/v2/model/flaky_test.py +++ b/src/datadog_api_client/v2/model/flaky_test.py @@ -49,7 +49,10 @@ def __init__( :param attributes: Attributes of a flaky test. :type attributes: FlakyTestAttributes, optional - :param id: 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. + :param id: 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 id: str, optional :param type: The type of the flaky test from Flaky Test Management. diff --git a/src/datadog_api_client/v2/model/flaky_tests_search_filter.py b/src/datadog_api_client/v2/model/flaky_tests_search_filter.py index 0c1c64b516..dec5cdd10d 100644 --- a/src/datadog_api_client/v2/model/flaky_tests_search_filter.py +++ b/src/datadog_api_client/v2/model/flaky_tests_search_filter.py @@ -49,6 +49,9 @@ def __init__( * ``@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`` ). :type query: str, optional """ if include_history is not unset: diff --git a/src/datadog_api_client/v2/model/update_flaky_tests_request_test.py b/src/datadog_api_client/v2/model/update_flaky_tests_request_test.py index 9b65eb1eab..b32e52ed77 100644 --- a/src/datadog_api_client/v2/model/update_flaky_tests_request_test.py +++ b/src/datadog_api_client/v2/model/update_flaky_tests_request_test.py @@ -38,7 +38,10 @@ def __init__(self_, id: str, new_state: UpdateFlakyTestsRequestTestNewState, **k """ Details of what tests to update and their new attributes. - :param id: 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. + :param id: 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. :type id: str :param new_state: The new state to set for the flaky test. diff --git a/src/datadog_api_client/v2/model/update_flaky_tests_response_result.py b/src/datadog_api_client/v2/model/update_flaky_tests_response_result.py index 059c265316..1cfedda335 100644 --- a/src/datadog_api_client/v2/model/update_flaky_tests_response_result.py +++ b/src/datadog_api_client/v2/model/update_flaky_tests_response_result.py @@ -35,7 +35,9 @@ def __init__(self_, id: str, success: bool, error: Union[str, UnsetType] = unset :param error: Error message if the update failed. :type error: str, optional - :param id: 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. + :param id: 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. :type id: str :param success: ``True`` if the update was successful, ``False`` if there were any errors.