Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document catalogs API and CLI command #328

Merged
merged 2 commits into from
Jul 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions spiceaidocs/docs/api/http/catalogs.md
Original file line number Diff line number Diff line change
@@ -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"
}
]
```
23 changes: 23 additions & 0 deletions spiceaidocs/docs/cli/reference/catalogs.md
Original file line number Diff line number Diff line change
@@ -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 spiceai
```
1 change: 1 addition & 0 deletions spiceaidocs/docs/cli/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down