mirrors/etcd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix documentation of List method of kubernetes interface

Browse Source 
It wrongly asked the API user to use the last key of previous response
when they should append "\x00" to exclude the last key from the contents
of the next requested page.

Signed-off-by: Aleksander Mistewicz <amistewicz@google.com>
This commit is contained in:
Aleksander Mistewicz
2025-01-27 10:34:44 +01:00
parent 2895b19f53
commit 62bbf2866b
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
client/v3/kubernetes/interface.go
View File

@ -36,8 +36,9 @@ type Interface interface {
// If opts.Revision is non-zero, the key-value pairs are retrieved at the specified revision. // If opts.Revision is non-zero, the key-value pairs are retrieved at the specified revision.
// If the required revision has been compacted, the request will fail with ErrCompacted. // If the required revision has been compacted, the request will fail with ErrCompacted.
// If opts.Limit is greater than zero, the number of returned key-value pairs is bounded by the limit. // If opts.Limit is greater than zero, the number of returned key-value pairs is bounded by the limit.
// If opts.Continue is not empty, the listing will start from the key immediately after the one specified by Continue. // If opts.Continue is not empty, the listing will start from the key
// The Continue value should be the last key returned in a previous paginated ListResponse. // specified by it. When paginating, the Continue value should be set
// to the last observed key with "\x00" appended to it.
List(ctx context.Context, prefix string, opts ListOptions) (ListResponse, error) List(ctx context.Context, prefix string, opts ListOptions) (ListResponse, error)
// Count returns the number of keys with the specified prefix. // Count returns the number of keys with the specified prefix.
@ -74,8 +75,9 @@ type ListOptions struct {
// 0 means no limitation. // 0 means no limitation.
Limit int64 Limit int64
// Continue is a key from which to resume the List operation, excluding the given key. // Continue is a key from which to resume the List operation.
// It should be set to the last key from a previous ListResponse when paginating. // It should be set to the last key from a previous ListResponse
// with "\x00" appended to it when paginating.
Continue string Continue string
} }