Skip to content

Documenting the new Flaky Test Management API endpoint for public beta #3136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 1, 2025
Merged

Documenting the new Flaky Test Management API endpoint for public beta #3136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
419 changes: 419 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

54 changes: 54 additions & 0 deletions examples/v2/test-optimization/SearchFlakyTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
// Search flaky tests returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.TestOptimizationApi;
import com.datadog.api.client.v2.api.TestOptimizationApi.SearchFlakyTestsOptionalParameters;
import com.datadog.api.client.v2.model.FlakyTestsSearchFilter;
import com.datadog.api.client.v2.model.FlakyTestsSearchPageOptions;
import com.datadog.api.client.v2.model.FlakyTestsSearchRequest;
import com.datadog.api.client.v2.model.FlakyTestsSearchRequestAttributes;
import com.datadog.api.client.v2.model.FlakyTestsSearchRequestData;
import com.datadog.api.client.v2.model.FlakyTestsSearchRequestDataType;
import com.datadog.api.client.v2.model.FlakyTestsSearchResponse;
import com.datadog.api.client.v2.model.FlakyTestsSearchSort;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.searchFlakyTests", true);
TestOptimizationApi apiInstance = new TestOptimizationApi(defaultClient);

FlakyTestsSearchRequest body =
new FlakyTestsSearchRequest()
.data(
new FlakyTestsSearchRequestData()
.attributes(
new FlakyTestsSearchRequestAttributes()
.filter(
new FlakyTestsSearchFilter()
.query(
"""
flaky_test_state:active @git.repository.id_v2:"github.com/datadog/shopist"
"""))
.page(
new FlakyTestsSearchPageOptions()
.cursor(
"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==")
.limit(25L))
.sort(FlakyTestsSearchSort.FAILURE_RATE_ASCENDING))
.type(FlakyTestsSearchRequestDataType.SEARCH_FLAKY_TESTS_REQUEST));

try {
FlakyTestsSearchResponse result =
apiInstance.searchFlakyTests(new SearchFlakyTestsOptionalParameters().body(body));
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling TestOptimizationApi#searchFlakyTests");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
57 changes: 57 additions & 0 deletions examples/v2/test-optimization/SearchFlakyTests_1224086727.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
// Search flaky tests returns "OK" response with pagination

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.PaginationIterable;
import com.datadog.api.client.v2.api.TestOptimizationApi;
import com.datadog.api.client.v2.api.TestOptimizationApi.SearchFlakyTestsOptionalParameters;
import com.datadog.api.client.v2.model.FlakyTest;
import com.datadog.api.client.v2.model.FlakyTestsSearchFilter;
import com.datadog.api.client.v2.model.FlakyTestsSearchPageOptions;
import com.datadog.api.client.v2.model.FlakyTestsSearchRequest;
import com.datadog.api.client.v2.model.FlakyTestsSearchRequestAttributes;
import com.datadog.api.client.v2.model.FlakyTestsSearchRequestData;
import com.datadog.api.client.v2.model.FlakyTestsSearchRequestDataType;
import com.datadog.api.client.v2.model.FlakyTestsSearchSort;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.searchFlakyTests", true);
TestOptimizationApi apiInstance = new TestOptimizationApi(defaultClient);

FlakyTestsSearchRequest body =
new FlakyTestsSearchRequest()
.data(
new FlakyTestsSearchRequestData()
.attributes(
new FlakyTestsSearchRequestAttributes()
.filter(
new FlakyTestsSearchFilter()
.query(
"""
flaky_test_state:active @git.repository.id_v2:"github.com/datadog/shopist"
"""))
.page(
new FlakyTestsSearchPageOptions()
.cursor(
"eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==")
.limit(25L))
.sort(FlakyTestsSearchSort.FAILURE_RATE_ASCENDING))
.type(FlakyTestsSearchRequestDataType.SEARCH_FLAKY_TESTS_REQUEST));

try {
PaginationIterable<FlakyTest> iterable =
apiInstance.searchFlakyTestsWithPagination(
new SearchFlakyTestsOptionalParameters().body(body));

for (FlakyTest item : iterable) {
System.out.println(item);
}
} catch (RuntimeException e) {
System.err.println(
"Exception when calling TestOptimizationApi#searchFlakyTestsWithPagination");
System.err.println("Reason: " + e.getMessage());
e.printStackTrace();
}
}
}
53 changes: 53 additions & 0 deletions examples/v2/test-optimization/SearchFlakyTests_2665223746.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
// Search flaky tests returns "OK" response with filtered query

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.PaginationIterable;
import com.datadog.api.client.v2.api.TestOptimizationApi;
import com.datadog.api.client.v2.api.TestOptimizationApi.SearchFlakyTestsOptionalParameters;
import com.datadog.api.client.v2.model.FlakyTest;
import com.datadog.api.client.v2.model.FlakyTestsSearchFilter;
import com.datadog.api.client.v2.model.FlakyTestsSearchPageOptions;
import com.datadog.api.client.v2.model.FlakyTestsSearchRequest;
import com.datadog.api.client.v2.model.FlakyTestsSearchRequestAttributes;
import com.datadog.api.client.v2.model.FlakyTestsSearchRequestData;
import com.datadog.api.client.v2.model.FlakyTestsSearchRequestDataType;
import com.datadog.api.client.v2.model.FlakyTestsSearchSort;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.searchFlakyTests", true);
TestOptimizationApi apiInstance = new TestOptimizationApi(defaultClient);

FlakyTestsSearchRequest body =
new FlakyTestsSearchRequest()
.data(
new FlakyTestsSearchRequestData()
.attributes(
new FlakyTestsSearchRequestAttributes()
.filter(
new FlakyTestsSearchFilter()
.query(
"""
flaky_test_state:active @git.repository.id_v2:"github.com/datadog/cart-tracking"
"""))
.page(new FlakyTestsSearchPageOptions().limit(10L))
.sort(FlakyTestsSearchSort.LAST_FLAKED_DESCENDING))
.type(FlakyTestsSearchRequestDataType.SEARCH_FLAKY_TESTS_REQUEST));

try {
PaginationIterable<FlakyTest> iterable =
apiInstance.searchFlakyTestsWithPagination(
new SearchFlakyTestsOptionalParameters().body(body));

for (FlakyTest item : iterable) {
System.out.println(item);
}
} catch (RuntimeException e) {
System.err.println(
"Exception when calling TestOptimizationApi#searchFlakyTestsWithPagination");
System.err.println("Reason: " + e.getMessage());
e.printStackTrace();
}
}
}
1 change: 1 addition & 0 deletions src/main/java/com/datadog/api/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -792,6 +792,7 @@ public class ApiClient {
put("v2.getIncidentTeam", false);
put("v2.listIncidentTeams", false);
put("v2.updateIncidentTeam", false);
put("v2.searchFlakyTests", false);
}
};
protected static final java.util.logging.Logger logger =
Expand Down
Loading