From fd4929fe31c42f145af75ec66d7a7512bd415309 Mon Sep 17 00:00:00 2001 From: sgrebnov Date: Mon, 15 Jul 2024 16:22:58 -0700 Subject: [PATCH 1/2] Document `catalogs` cli command --- spiceaidocs/docs/cli/reference/catalogs.md | 23 ++++++++++++++++++++++ spiceaidocs/docs/cli/reference/index.md | 1 + 2 files changed, 24 insertions(+) create mode 100644 spiceaidocs/docs/cli/reference/catalogs.md diff --git a/spiceaidocs/docs/cli/reference/catalogs.md b/spiceaidocs/docs/cli/reference/catalogs.md new file mode 100644 index 00000000..962e3d4b --- /dev/null +++ b/spiceaidocs/docs/cli/reference/catalogs.md @@ -0,0 +1,23 @@ +--- +title: "catalogs" +sidebar_label: "catalogs" +pagination_prev: null +pagination_next: null +--- + +Lists [catalogs](/components/catalogs) loaded by the Spice runtime + +### Usage + +```shell +spice catalogs +``` + +### Example + +```shell +>>> spice catalogs + +FROM NAME +spice.ai spice.ai +``` diff --git a/spiceaidocs/docs/cli/reference/index.md b/spiceaidocs/docs/cli/reference/index.md index 23a21760..1bb215d9 100644 --- a/spiceaidocs/docs/cli/reference/index.md +++ b/spiceaidocs/docs/cli/reference/index.md @@ -18,6 +18,7 @@ spice [command] [--help] | Command | Description | | -------------------------------------------------- | --------------------------------------------------------------------| | [add](/cli/reference/add) | Add Pod - adds a pod to the project | +| [catalogs](/cli/reference/catalogs) | List [catalogs](/components/catalogs) loaded by the Spice runtime | | [completion](/cli/reference/completion) | Generate the autocompletion script for the specified shell | | [dataset](/cli/reference/dataset) | Dataset operations | | [datasets](/cli/reference/datasets) | Lists datasets loaded by the Spice runtime | From 865d66ff07ddb7a260d5f48aefe63e5f1cc76917 Mon Sep 17 00:00:00 2001 From: sgrebnov Date: Mon, 15 Jul 2024 16:29:04 -0700 Subject: [PATCH 2/2] Document v1/catalogs API --- spiceaidocs/docs/api/http/catalogs.md | 26 ++++++++++++++++++++++ spiceaidocs/docs/cli/reference/catalogs.md | 2 +- spiceaidocs/docs/cli/reference/index.md | 2 +- 3 files changed, 28 insertions(+), 2 deletions(-) create mode 100644 spiceaidocs/docs/api/http/catalogs.md diff --git a/spiceaidocs/docs/api/http/catalogs.md b/spiceaidocs/docs/api/http/catalogs.md new file mode 100644 index 00000000..b7063cff --- /dev/null +++ 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 index 962e3d4b..c303661f 100644 --- 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 ``` diff --git a/spiceaidocs/docs/cli/reference/index.md b/spiceaidocs/docs/cli/reference/index.md index 1bb215d9..27aa286b 100644 --- a/spiceaidocs/docs/cli/reference/index.md +++ b/spiceaidocs/docs/cli/reference/index.md @@ -18,7 +18,7 @@ spice [command] [--help] | Command | Description | | -------------------------------------------------- | --------------------------------------------------------------------| | [add](/cli/reference/add) | Add Pod - adds a pod to the project | -| [catalogs](/cli/reference/catalogs) | List [catalogs](/components/catalogs) loaded by the Spice runtime | +| [catalogs](/cli/reference/catalogs) | List [catalogs](/components/catalogs) loaded by the Spice runtime | | [completion](/cli/reference/completion) | Generate the autocompletion script for the specified shell | | [dataset](/cli/reference/dataset) | Dataset operations | | [datasets](/cli/reference/datasets) | Lists datasets loaded by the Spice runtime |