Skip to content

revise limit semantics #335

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.

Sign up for GitHub

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

Merged
philvarner merged 2 commits into from
Oct 11, 2022
Merged

revise limit semantics #335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d90ceb
revise limit semantics
philvarner Oct 6, 2022
d87119b
Apply suggestions from code review
Oct 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- [Query](https://github.com/stac-api-extensions/query)
- [Children](https://github.com/stac-api-extensions/children)

### Fixed

- Item Search `limit` parameter semantics now align with OAFeat. The server must not return more Items than the limit and a limit value higher than advertised in the
service description must return a 400 Bad Request status code.

## [v1.0.0-rc.1] - 2022-03-17

### Added
Expand Down
8 changes: 4 additions & 4 deletions item-search/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,13 +105,13 @@ See [examples](examples.md) for some example requests.

**limit** The limit parameter follows the same semantics of the OAFeat Item resource limit parameter. The value is
a suggestion to the server as to the maximum number of Item objects the
client would prefer in the response. The OpenAPI specification defines the default and maximum values
client would prefer in the response. The server may return fewer Item objects, but
must not return more. The OpenAPI specification defines the default and maximum values
for this parameter. The base specifications define these with a default of 10 and a maximum of 10000, but implementers
may choose other values to advertise through their `service-desc` endpoint. If the limit parameter value is greater
than the advertised maximum limit, the server must return the maximum possible number of items (ideally, the number
as the advertised maximum limit), rather than responding with an error.
than the advertised maximum limit, the server must return a 400 Bad Request status code.

Only one of either **intersects** or **bbox** may be specified. If both are specified, a 400 Bad Request response
Only one of either **intersects** or **bbox** may be specified. If both are specified, a 400 Bad Request status code
must be returned.

**datetime** The datetime parameter use the same allowed values as the
Expand Down