[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-data.mdx
+++ b/docs/rest-api/get-data.mdx
@@ -0,0 +1,28 @@
+---
+openapi: get /{app_id}/data
+---
+
+<RequestExample>
+
+```bash Request
+curl --request GET \
+  --url http://localhost:8080/{app_id}/data
+```
+
+</RequestExample>
+
+<ResponseExample>
+
+```json Response
+{
+  "results": [
+    {
+      "data_type": "web_page",
+      "data_value": "https://www.forbes.com/profile/elon-musk/",
+      "metadata": "null"
+    }
+  ]
+}
+```
+
+</ResponseExample>