From bf570bcc78b3aa1bad84401e3390cc79a03e426e Mon Sep 17 00:00:00 2001 From: "Lixia (Sylvia) Lei" Date: Fri, 8 Nov 2024 18:03:46 +0800 Subject: [PATCH] docs: update doc for ReferrerListPageSize (#842) Resolves: #841 Signed-off-by: Lixia (Sylvia) Lei --- registry/remote/repository.go | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/registry/remote/repository.go b/registry/remote/repository.go index 7c36dc1c..2d81b11b 100644 --- a/registry/remote/repository.go +++ b/registry/remote/repository.go @@ -118,7 +118,12 @@ type Repository struct { // ReferrerListPageSize specifies the page size when invoking the Referrers // API. // If zero, the page size is determined by the remote registry. - // Reference: https://github.com/opencontainers/distribution-spec/blob/v1.1.0/spec.md#listing-referrers + // + // NOTE: Pagination for the Referrers API is not defined in the distribution + // spec, so not all registries support it. ReferrerListPageSize may be + // ignored if pagination is unsupported by the remote registry. + // + // Reference: https://github.com/oras-project/oras-go/issues/841 ReferrerListPageSize int // MaxMetadataBytes specifies a limit on how many response bytes are allowed