vbatts/registry
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Clarify pagination for catalog API endpoint

Browse source 
This change clarifies the way the catalog endpoint returns results
when pagination was not explicitly requested.

Signed-off-by: Patrick Devine <patrick.devine@docker.com>
This commit is contained in:
Patrick Devine 2015-12-02 17:26:52 -08:00
parent 329c353411
commit b084c77c70
2 changed files with 15 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/spec/api.md
View file

@ -822,7 +822,13 @@ the presence of a repository only guarantees that it is there but not that it
is _not_ there.
For registries with a large number of repositories, this response may be quite
large. If such a response is expected, one should use pagination.
large. If such a response is expected, one should use pagination. A registry
may also limit the amount of responses returned even if pagination was not
explicitly requested. In this case the `Link` header will be returned along
with the results, and subsequent results can be obtained by following the link
as if pagination had been initially requested.
For details of the `Link` header, please see the _Pagination_ section.
#### Pagination