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.

Sign up for GitHub

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

Fix collections links #632

Merged
merged 1 commit into from
Jan 30, 2025
Merged

Fix collections links #632

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions docs/build-for-developers/cli-collections.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,15 @@ Get started with the Collections API with `openfn collections --help`
You'll need a Personal Access Token (PAT) to access a collection. You'll also
need to ensure a collection has been created before you can read or write to
it - see
[Managing Collections](http://localhost:3000/documentation/build/collections#managing-collections)
[Managing Collections](/documentation/build/collections#managing-collections)

:::info Trying to use Collections in a CLI workflow?

These docs explain how to use the `openfn collections` CLI command.

If you're running an expression or workflow through the CLI, you need to use the
collections adaptor - check out the
[Collections Adaptor Docs](http://localhost:3000/adaptors/collections#cli-usage)
for detauls
[Collections Adaptor Docs](/adaptors/collections#cli-usage) for detauls

:::

Expand Down Expand Up @@ -154,7 +153,8 @@ openfn collections get my-collection \* -o /tmp/my_collection.json --pretty
```

It's important to understand that the output works a bit differently if you're
getting one specific item with a single key or getting many items with a key-pattern.
getting one specific item with a single key or getting many items with a
key-pattern.

A single key always returns its value "raw" or "verbatim", without the key
attached. So for a key `item-1` which holds a JSON object as a value, then this:
Expand Down