make the API item limit configurable #1543
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
robbkidd
force-pushed
the
robb/make-api-item-limit-configurable
branch
from
c345342
to
19c4125
Compare
Use API_ITEM_LIMIT environment variable to set the upper limit on the number of items to return for API requests to a Supermarket instance. Defaults to the previously hard-coded value of 100 if the env var is not present. Also, the cookbook internal to the omnibus package has the same default set in the section of the attributes that get set as env vars. Signed-off-by: Robb Kidd <rkidd@chef.io>
robbkidd
force-pushed
the
robb/make-api-item-limit-configurable
branch
from
19c4125
to
53d1afa
Compare
robbkidd
commented
Feb 15, 2017
| @@ -46,7 +46,7 @@ def error(body, status = 400) | |||
| # | |||
| def init_params | |||
| @start = params.fetch(:start, 0).to_i | |||
| @items = [params.fetch(:items, 10).to_i, 100].min | |||
| @items = [params.fetch(:items, 10).to_i, item_limit].min | |||
There was a problem hiding this comment.
There's a part of me that thinks that the API should respond with a 4xx error when an API request has an item value greater than the limit. Then the requestor would get a clear "no soup for you" message instead of wondering why their request did not return their desired number of items.
There was a problem hiding this comment.
agreed but can happen after we release. Can you open an issue for that before this gets released?
There was a problem hiding this comment.
Opened #1544 to return an error when an item count is requested greater than the item limit.
nathenharvey
approved these changes
Feb 15, 2017
|
Submitting to the pipeline for a build to test further. |
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.
Use
API_ITEM_LIMITenvironment variable to set the upper limit on the number of items to return for API requests to a Supermarket instance.Defaults to the previously hard-coded value of 100 if the env var is not present. Also, the cookbook internal to the omnibus package has the same default set in the section of the attributes that get set as env vars.
Closes #1542