Skip to content

Commit

Permalink
Warn about truncation when listing collections (#1146)
Browse files Browse the repository at this point in the history
* Warn about truncation when listing collections

* typo
  • Loading branch information
Wauplin authored Nov 29, 2023
1 parent 648f999 commit 10f097e
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/hub/api.md
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

0 comments on commit 10f097e

Please sign in to comment.