Documenting the new Flaky Test Management API endpoint for public beta

config/_default/menus/api.en.yaml

@@ -10188,6 +10188,23 @@ menu:
           - ListTeams
         unstable: []
         order: 1
+    - name: Test Optimization
+      url: /api/latest/test-optimization/
+      identifier: test-optimization
+      generated: true
+    - name: Search flaky tests
+      url: '#search-flaky-tests'
+      identifier: test-optimization-search-flaky-tests
+      parent: test-optimization
+      generated: true
+      params:
+        versions:
+          - v2
+        operationids:
+          - SearchFlakyTests
+        unstable:
+          - v2
+        order: 1
     - name: Workflow Automation
       url: /api/latest/workflow-automation/
       identifier: workflow-automation

content/en/api/latest/test-optimization/_index.md

@@ -0,0 +1,3 @@
+---
+title: Test Optimization
+---

content/en/api/v2/test-optimization/_index.md

@@ -0,0 +1,4 @@
+---
+title: Test Optimization
+headless: true
+---

content/en/api/v2/test-optimization/request.SearchFlakyTests_2665223746.json

@@ -0,0 +1,14 @@
+{
+  "data": {
+    "attributes": {
+      "filter": {
+        "query": "flaky_test_state:active @git.repository.id_v2:\"github.com/datadog/shopist\""
+      },
+      "page": {
+        "limit": 2
+      },
+      "sort": "-last_flaked"
+    },
+    "type": "search_flaky_tests_request"
+  }
+}

content/en/api/v2/test-optimization/request.SearchFlakyTests_3039631009.json

@@ -0,0 +1,15 @@
+{
+  "data": {
+    "attributes": {
+      "filter": {
+        "query": "*"
+      },
+      "page": {
+        "cursor": "Q29udGludW91cyBUZXN0aW5nLltETyBOT1QgREVMRVRFXVtPTi1ERU1BTkQgRlVOQ1RJT05BTElUSUVTXVtPVkVSUklERV0gRXh0cmFWYXJpYWJsZXM=",
+        "limit": 2
+      },
+      "sort": "fqn"
+    },
+    "type": "search_flaky_tests_request"
+  }
+}

content/en/api/v2/test-optimization/request.SearchFlakyTests_3833010053.json

@@ -0,0 +1,14 @@
+{
+  "data": {
+    "attributes": {
+      "filter": {
+        "query": "*"
+      },
+      "page": {
+        "limit": 2
+      },
+      "sort": "fqn"
+    },
+    "type": "search_flaky_tests_request"
+  }
+}

data/api/v2/CodeExamples.json

@@ -1708,6 +1708,23 @@
       "description": "Update permission setting for team returns \"OK\" response"
     }
   ],
+  "SearchFlakyTests": [
+    {
+      "group": "test_optimization",
+      "suffix": "_3833010053",
+      "description": "Search flaky tests returns \"OK\" response with cursor pagination"
+    },
+    {
+      "group": "test_optimization",
+      "suffix": "_2665223746",
+      "description": "Search flaky tests returns \"OK\" response with filtered query"
+    },
+    {
+      "group": "test_optimization",
+      "suffix": "_3039631009",
+      "description": "Search flaky tests returns \"OK\" response with specific cursor"
+    }
+  ],
   "CreateUser": [
     {
       "group": "users",