Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

in OAFeat Part 1, phrasing of the semantics of the limit parameter #640

Closed
philvarner opened this issue Oct 13, 2021 · 1 comment · Fixed by #663
Closed

in OAFeat Part 1, phrasing of the semantics of the limit parameter #640

philvarner opened this issue Oct 13, 2021 · 1 comment · Fixed by #663
Labels
Part 1: Core Issue related to Part 1 - Core

Comments

@philvarner
Copy link
Contributor

It would be good if the limit parameter were explicitly described as being allowed to be larger than the advertised maximum value without returning an error code.

In the OpenAPI spec, the limit param is described as:

The optional limit parameter limits the number of items that are presented in the response document.

In the text spec, this is said:

The `limit` parameter may be used to control the subset of the selected features that should be returned in the response, the page size.

One thing that is not clearly stated is what the behavior should be if the limit parameter is larger than the advertised or default maximum value. There is an example in the text:

If you ask for 50000, you might get up to 10000 (server-limited) and if there are more, a next link;

which indicates that larger values than maximum should not result in an error, but instead should treat the parameter as if it were the maximum, but it would be good to have this explicitly stated in the definition of the limit parameter.

@jampukka
Copy link
Contributor

Related to #368

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Part 1: Core Issue related to Part 1 - Core
Projects
Development

Successfully merging a pull request may close this issue.

3 participants