Document v1/catalogs API

spiceai · Jul 15, 2024 · b43bfd1 · b43bfd1
1 parent fd4929f
commit b43bfd1
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 1 deletion.
diff --git a/spiceaidocs/docs/api/http/catalogs.md b/spiceaidocs/docs/api/http/catalogs.md
@@ -0,0 +1,26 @@
+---
+title: 'GET /v1/catalogs'
+sidebar_label: 'GET /v1/catalogs'
+description: 'Fetch catalogs'
+sidebar_position: 5
+---
+
+Returns the list of configured [catalogs](/components/catalogs)
+
+Example:
+
+```bash
+curl --request GET \
+  --url http://localhost:3000/v1/catalogs
+```
+
+Response:
+
+```json
+[
+  {
+    "from": "spice.ai",
+    "name": "spiceai"
+  },
+]
+```
diff --git a/spiceaidocs/docs/cli/reference/catalogs.md b/spiceaidocs/docs/cli/reference/catalogs.md
@@ -19,5 +19,5 @@ spice catalogs
 >>> spice catalogs
 
 FROM    NAME     
-spice.ai spice.ai 
+spice.ai spiceai 
 ```