[REST API] Incorporate changes related to REST API docs (#900)

2023-11-03 00:42:55 -07:00
parent 8dd5cb9602
commit fa3ca1d08a
23 changed files with 323 additions and 49 deletions
--- a/docs/rest-api/check-status.mdx
+++ b/docs/rest-api/check-status.mdx
@@ -0,0 +1,20 @@
+---
+openapi: get /ping
+---
+
+<RequestExample>
+
+```bash Request
+  curl --request GET \
+    --url http://localhost:8080/ping
+```
+
+</RequestExample>
+
+<ResponseExample>
+
+```json Response
+{ "ping": "pong" }
+```
+
+</ResponseExample>