Skip to content

Commit

Permalink
docs: update doc for ReferrerListPageSize (#842)
Browse files Browse the repository at this point in the history
Resolves: #841
Signed-off-by: Lixia (Sylvia) Lei <[email protected]>
  • Loading branch information
Wwwsylvia authored Nov 8, 2024
1 parent 5602bbd commit bf570bc
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion registry/remote/repository.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit bf570bc

Please sign in to comment.