fix: Support limit flag for Box Search #323
Merged
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
Closes: SDK-2171 Fixes: #322
mwwoda
reviewed
May 2, 2022
| @@ -148,11 +148,12 @@ class SearchCommand extends BoxCommand { | |||
|
|
|||
| let results = await this.client.search.query(args.query || null, options); | |||
|
|
|||
| // Hard limit the search results to avoid slamming the API | |||
| // Limit the search results according to the --limit flag value (if specified) or RESULTS_LIMIT value | |||
| const itemsLimit = flags.limit || RESULTS_LIMIT; | |||
There was a problem hiding this comment.
Don't you also need to modify line 30 where options.limit is set to use flags.limit instead of the hardcoded RESULTS_LIMIT?
There was a problem hiding this comment.
Actually no. We don't want to use limit parameter the same as API understands that. For API limit means number of items per page, but CLI makes pagination for us. So in our case limit means total number of items returned by CLI. You can also read this thread: https://box.slack.com/archives/C6KSD7C91/p1651243355904129
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.
Closes: SDK-2171
Fixes: #322