Skip to content

Commit

Permalink
Converting the recommended limit to an implementers note
Browse files Browse the repository at this point in the history
Signed-off-by: Brandon Mitchell <[email protected]>
  • Loading branch information
sudo-bmitch committed Mar 30, 2024
1 parent 2243be7 commit 654a2fd
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -548,10 +548,13 @@ The tags MUST be in lexical order.

When using the `last` query parameter, the `n` parameter is OPTIONAL.

The registry SHOULD support at least `n=1000` tags in a single response.
The client SHOULD avoid requesting more than `n=1000` tags in a single request.
If the registry is unable to return all tags requested by the client, the registry MUST return a `413 Content Too Large` with `TAG_LIMIT_EXCEEDED` error <sup>[code-15](#error-codes)</sup> and include the header `OCI-Tag-Limit: <limit>`, where `<limit>` is the maximum tags per request supported by the registry.

*Implementers note:*
Most registries support at least 1000 tags per request, but limits have been seen as low as 50 tags per request.
To maximize the tags per page, a request without setting `n` can be used, which should either return the full list of tags, or an error with the `OCI-Tag-Limit` header indicating the limit.
When available, clients should prefer the `Link` header over using the `last` parameter for pagination.

##### Listing Referrers

*Note: this feature was added in distibution-spec 1.1.
Expand Down

0 comments on commit 654a2fd

Please sign in to comment.