[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/get-all-apps.mdx
+++ b/docs/rest-api/get-all-apps.mdx
@@ -0,0 +1,33 @@
+---
+openapi: get /apps
+---
+
+<RequestExample>
+
+```bash Request
+curl --request GET \
+  --url http://localhost:8080/apps
+```
+
+</RequestExample>
+
+<ResponseExample>
+
+```json Response
+{
+  "results": [
+    {
+      "config": "config1.yaml",
+      "id": 1,
+      "app_id": "app1"
+    },
+    {
+      "config": "config2.yaml",
+      "id": 2,
+      "app_id": "app2"
+    }
+  ]
+}
+```
+
+</ResponseExample>