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

Warn about truncation when listing collections #1146

Merged
merged 2 commits into from
Nov 29, 2023
Merged

Warn about truncation when listing collections #1146

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2ec15d
Warn about truncation when listing collections
Wauplin Nov 29, 2023
2bb1b65
typo
Wauplin Nov 29, 2023
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
7 changes: 6 additions & 1 deletion docs/hub/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,9 +299,14 @@ List collections from the Hub, based on some criteria. The supported parameters

If no parameter is set, all collections are returned.

The returned result is paginated. To get all collections, you must follow the
The response is paginated. To get all collections, you must follow the [`Link` header](https://docs.github.com/en/rest/guides/using-pagination-in-the-rest-api?apiVersion=2022-11-28#link-header).

<Tip warning={true}>

When listing collections, the item list per collection is truncated to 4 items maximum. To retrieve all items from a collection, you need to make an additional call using its collection slug.

</Tip>

Payload:

```js
Expand Down
Loading