Adding support for default environment variable to SFEOS for the number of returned items and STAC collections #419
Conversation
This file contains hidden or 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
added 2 commits
August 27, 2025 15:03
Add tests to verify the STAC_ITEM_LIMIT environment variable correctly limits returned items in all the following endpoints:
- Collections list (`/collections`)
- Search results (`/search`)
- Collection items (`/collections/{id}/items`)
Ensures the pagination and result limiting behaves as expected in the API.
This commit introduces the STAC_ITEM_LIMIT environment variable to control the maximum number of items
returned by key API endpoints:
- GET /collections - Limits collections returned
- GET /collections/{collection_id}/items - Limits items in a collection
- GET /search - Limits search results
jonhealy1
requested changes
Aug 28, 2025
CHANGELOG.md
Outdated
| @@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. | |||
|
|
|||
| ### Added | |||
|
|
|||
| - Added default environment variable `STAC_ITEM_LIMIT` to SFEOS for result limiting of returned items and STAC collections | |||
There was a problem hiding this comment.
Hi. This will need to be moved to the Unreleased section. It can be included in the next release. Also, can you add a link to the pull request number.
There was a problem hiding this comment.
@jonhealy1 I have moved the changelog comment from Added to Unreleased and added a reference to the pull request number.
|
Looks great |
YuriZmytrakov
force-pushed
the
CAT-1404
branch
from
2cf463c to
4a0a813
Compare
YuriZmytrakov
force-pushed
the
CAT-1404
branch
from
4a011f6 to
3f5c978
Compare
jonhealy1
approved these changes
Aug 28, 2025
Thank you for merging @jonhealy1 ! |
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.
Description:
At the moment, the default number of returned items and STAC collections is hardcoded as
10and can not be changed, except by addinglimitquery parameter to the URL. This update introduces theSTAC_ITEM_LIMITenvironment variable, allowing us to customize the default limit for returned items and STAC collections.PR Checklist:
pre-commit run --all-files)make test)