feat: add paging flags for list commands that support paging #297
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kangasta
commented
Apr 2, 2024
|
|
||
| func (pp *PageParameters) ConfigureFlags(fs *pflag.FlagSet) { | ||
| fs.IntVar(&pp.size, "size", 100, "Number of entries to receive at most.") | ||
| fs.IntVar(&pp.number, "page", 0, "Page number to calculate first item to receive. Page numbers start from `1`.") |
There was a problem hiding this comment.
These could also be --page-size and --page-number to be more descriptive, but those are quite verbose 🤔
There was a problem hiding this comment.
As they naturally are available only on list commands, these shorter ones seem fine to me.
There was a problem hiding this comment.
I was also thinking between --size and --limit. Go SDK uses size, but there that is used as field of Page struct. Maybe limit would clearer without that context 🤔
There was a problem hiding this comment.
Changed --size → --limit
kangasta
commented
Apr 2, 2024
villevsv-upcloud
approved these changes
Apr 3, 2024
|
|
||
| func (pp *PageParameters) ConfigureFlags(fs *pflag.FlagSet) { | ||
| fs.IntVar(&pp.size, "size", 100, "Number of entries to receive at most.") | ||
| fs.IntVar(&pp.number, "page", 0, "Page number to calculate first item to receive. Page numbers start from `1`.") |
There was a problem hiding this comment.
As they naturally are available only on list commands, these shorter ones seem fine to me.
This also increases the default page size from 10 to 100.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This also increases the default page size from 10 to 100.