Merge pull request #241 from checkly/tnolet/update-api-docs

tnolet · web-flow · commit 9c69ebf2305f · 2026-03-27T16:08:21.000+01:00
feat: adds updates API docs [ship]
diff --git a/api-reference/error-groups/update-an-error-group.mdx b/api-reference/error-groups/update-an-error-group.mdx
@@ -1,4 +1,4 @@
 ---
 openapi: patch /v1/error-groups/{id}
 title: Update an error group
----
+---
diff --git a/api-reference/rocky-ai/generate-a-root-cause-analysis-for-a-test-session-error-group.mdx b/api-reference/rocky-ai/generate-a-root-cause-analysis-for-a-test-session-error-group.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /v1/root-cause-analyses/test-session-error-groups/{errorGroupId}
+---
diff --git a/api-reference/test-session-error-groups/list-all-test-session-error-groups-for-a-project.mdx b/api-reference/test-session-error-groups/list-all-test-session-error-groups-for-a-project.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/test-session-error-groups/projects/{projectId}
+---
diff --git a/api-reference/test-session-error-groups/list-all-test-session-error-groups.mdx b/api-reference/test-session-error-groups/list-all-test-session-error-groups.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/test-session-error-groups/
+---
diff --git a/api-reference/test-session-error-groups/retrieve-a-test-session-error-group.mdx b/api-reference/test-session-error-groups/retrieve-a-test-session-error-group.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /v1/test-session-error-groups/{id}
+---
diff --git a/api-reference/test-session-error-groups/update-a-test-session-error-group.mdx b/api-reference/test-session-error-groups/update-a-test-session-error-group.mdx
@@ -0,0 +1,4 @@
+---
+openapi: patch /v1/test-session-error-groups/{id}
+title: Update an error group
+---
diff --git a/docs.json b/docs.json
@@ -841,7 +841,8 @@
                 "group": "Rocky AI",
                 "pages": [
                   "api-reference/rocky-ai/retrieve-one-root-cause-analysis",
-                  "api-reference/rocky-ai/generate-a-root-cause-analysis-for-an-error-group"
+                  "api-reference/rocky-ai/generate-a-root-cause-analysis-for-an-error-group",
+                  "api-reference/rocky-ai/generate-a-root-cause-analysis-for-a-test-session-error-group"
                 ]
               },
               {
@@ -918,6 +919,15 @@
                   "api-reference/status-pages/get-all-subscriptions-for-a-specific-status-page",
                   "api-reference/status-pages/delete-a-subscription-belonging-to-a-specific-status-page"
                 ]
+              },
+              {
+                "group": "Test Session Error Groups",
+                "pages": [
+                  "api-reference/test-session-error-groups/list-all-test-session-error-groups",
+                  "api-reference/test-session-error-groups/list-all-test-session-error-groups-for-a-project",
+                  "api-reference/test-session-error-groups/retrieve-a-test-session-error-group",
+                  "api-reference/test-session-error-groups/update-a-test-session-error-group"
+                ]
               }
             ]
           }

-Original file line number
+Diff line change
@@ @@ -1,4 +1,4 @@ @@
 ---
 openapi: patch /v1/error-groups/{id}
 title: Update an error group
 ----
 +---
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+---`
	`2`	`+openapi: post /v1/root-cause-analyses/test-session-error-groups/{errorGroupId}`
	`3`	`+---`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+---`
	`2`	`+openapi: get /v1/test-session-error-groups/projects/{projectId}`
	`3`	`+---`
Original file line number	Diff line number	Diff line change
`@@ -841,7 +841,8 @@`
`841`	`841`	`"group": "Rocky AI",`
`842`	`842`	`"pages": [`
`843`	`843`	`"api-reference/rocky-ai/retrieve-one-root-cause-analysis",`
`844`		`- "api-reference/rocky-ai/generate-a-root-cause-analysis-for-an-error-group"`
	`844`	`+ "api-reference/rocky-ai/generate-a-root-cause-analysis-for-an-error-group",`
	`845`	`+ "api-reference/rocky-ai/generate-a-root-cause-analysis-for-a-test-session-error-group"`
`845`	`846`	`]`
`846`	`847`	`},`
`847`	`848`	`{`
`@@ -918,6 +919,15 @@`
`918`	`919`	`"api-reference/status-pages/get-all-subscriptions-for-a-specific-status-page",`
`919`	`920`	`"api-reference/status-pages/delete-a-subscription-belonging-to-a-specific-status-page"`
`920`	`921`	`]`
	`922`	`+ },`
	`923`	`+ {`
	`924`	`+ "group": "Test Session Error Groups",`
	`925`	`+ "pages": [`
	`926`	`+ "api-reference/test-session-error-groups/list-all-test-session-error-groups",`
	`927`	`+ "api-reference/test-session-error-groups/list-all-test-session-error-groups-for-a-project",`
	`928`	`+ "api-reference/test-session-error-groups/retrieve-a-test-session-error-group",`
	`929`	`+ "api-reference/test-session-error-groups/update-a-test-session-error-group"`
	`930`	`+ ]`
`921`	`931`	`}`
`922`	`932`	`]`
`923`	`933`	`}`