Skip to content

Commit 48e3b2e

Browse files
Yuri ZmytrakovYuri Zmytrakov
authored andcommitted
fix: the default and max allowed returned values for collections and items
Ensure collections and items endpoints use their respective default and maximum limit values.
1 parent 7065798 commit 48e3b2e

File tree

4 files changed

+42
-33
lines changed

4 files changed

+42
-33
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,10 @@ You can customize additional settings in your `.env` file:
299299
| `ENABLE_COLLECTIONS_SEARCH` | Enable collection search extensions (sort, fields, free text search, structured filtering, and datetime filtering) on the core `/collections` endpoint. | `true` | Optional |
300300
| `ENABLE_COLLECTIONS_SEARCH_ROUTE` | Enable the custom `/collections-search` endpoint (both GET and POST methods). When disabled, the custom endpoint will not be available, but collection search extensions will still be available on the core `/collections` endpoint if `ENABLE_COLLECTIONS_SEARCH` is true. | `false` | Optional |
301301
| `ENABLE_TRANSACTIONS_EXTENSIONS` | Enables or disables the Transactions and Bulk Transactions API extensions. This is useful for deployments where mutating the catalog via the API should be prevented. If set to `true`, the POST `/collections` route for search will be unavailable in the API. | `true` | Optional |
302-
| `STAC_ITEM_LIMIT` | Sets the environment variable for result limiting to SFEOS for the number of returned items and STAC collections. | `10` | Optional |
302+
| `STAC_GLOBAL_COLLECTION_MAX_LIMIT` | Configures the maximum number of STAC collections that can be returned in a single search request. | `300` | Optional |
303+
| `STAC_DEFAULT_COLLECTION_LIMIT` | Configures the default number of STAC collections returned when no limit parameter is specified in the request. | `100` | Optional |
304+
| `STAC_GLOBAL_ITEM_MAX_LIMIT` | Configures the maximum number of STAC items that can be returned in a single search request. | `100` | Optional |
305+
| `STAC_DEFAULT_ITEM_LIMIT` | Configures the default number of STAC items returned when no limit parameter is specified in the request. | `10` | Optional |
303306
| `STAC_INDEX_ASSETS` | Controls if Assets are indexed when added to Elasticsearch/Opensearch. This allows asset fields to be included in search queries. | `false` | Optional |
304307
| `ENV_MAX_LIMIT` | Configures the environment variable in SFEOS to override the default `MAX_LIMIT`, which controls the limit parameter for returned items and STAC collections. | `10,000` | Optional |
305308
| `USE_DATETIME` | Configures the datetime search behavior in SFEOS. When enabled, searches both datetime field and falls back to start_datetime/end_datetime range for items with null datetime. When disabled, searches only by start_datetime/end_datetime range. | `true` | Optional |

stac_fastapi/core/stac_fastapi/core/core.py

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -270,33 +270,27 @@ async def all_collections(
270270
base_url = str(request.base_url)
271271

272272
# Get the global limit from environment variable
273-
global_limit = None
274-
env_limit = os.getenv("STAC_ITEM_LIMIT")
275-
if env_limit:
276-
try:
277-
global_limit = int(env_limit)
278-
except ValueError:
279-
# Handle invalid integer in environment variable
280-
pass
281-
282-
# Apply global limit if it exists
283-
if global_limit is not None:
284-
# If a limit was provided, use the smaller of the two
285-
if limit is not None:
286-
limit = min(limit, global_limit)
287-
else:
288-
limit = global_limit
273+
global_max_limit = int(os.getenv("STAC_GLOBAL_COLLECTION_MAX_LIMIT", 300))
274+
default_limit = int(os.getenv("STAC_DEFAULT_COLLECTION_LIMIT", 100))
275+
query_limit = request.query_params.get("limit")
276+
277+
body_limit = None
278+
try:
279+
if request.method == "POST" and request.body():
280+
body_data = await request.json()
281+
body_limit = body_data.get("limit")
282+
except Exception:
283+
pass
284+
285+
if body_limit is not None:
286+
limit = int(body_limit)
287+
elif query_limit:
288+
limit = int(query_limit)
289289
else:
290-
# No global limit, use provided limit or default
291-
if limit is None:
292-
query_limit = request.query_params.get("limit")
293-
if query_limit:
294-
try:
295-
limit = int(query_limit)
296-
except ValueError:
297-
limit = 10
298-
else:
299-
limit = 10
290+
limit = default_limit
291+
292+
if global_max_limit > 0:
293+
limit = min(limit, global_max_limit)
300294

301295
token = request.query_params.get("token")
302296

@@ -562,7 +556,7 @@ async def item_collection(
562556
request (Request): FastAPI Request object.
563557
bbox (Optional[BBox]): Optional bounding box filter.
564558
datetime (Optional[str]): Optional datetime or interval filter.
565-
limit (Optional[int]): Optional page size. Defaults to env ``STAC_ITEM_LIMIT`` when unset.
559+
limit (Optional[int]): Optional page size. Defaults to env `STAC_DEFAULT_ITEM_LIMIT` when unset.
566560
sortby (Optional[str]): Optional sort specification. Accepts repeated values
567561
like ``sortby=-properties.datetime`` or ``sortby=+id``. Bare fields (e.g. ``sortby=id``)
568562
imply ascending order.
@@ -660,7 +654,17 @@ async def get_search(
660654
Raises:
661655
HTTPException: If any error occurs while searching the catalog.
662656
"""
663-
limit = int(request.query_params.get("limit", os.getenv("STAC_ITEM_LIMIT", 10)))
657+
global_max_limit = int(os.getenv("STAC_GLOBAL_ITEM_MAX_LIMIT", 100))
658+
default_limit = int(os.getenv("STAC_DEFAULT_ITEM_LIMIT", 10))
659+
660+
query_limit = request.query_params.get("limit")
661+
if query_limit:
662+
limit = int(query_limit)
663+
else:
664+
limit = default_limit
665+
666+
if global_max_limit > 0:
667+
limit = min(limit, global_max_limit)
664668

665669
base_args = {
666670
"collections": collections,

stac_fastapi/tests/api/test_api.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1475,9 +1475,11 @@ def create_items(date_prefix: str, start_day: int, count: int) -> dict:
14751475

14761476

14771477
@pytest.mark.asyncio
1478-
async def test_collections_limit_env_variable(app_client, txn_client, load_test_data):
1478+
async def test_collections_limit_env_variable(
1479+
app_client, txn_client, load_test_data, monkeypatch
1480+
):
14791481
limit = "5"
1480-
os.environ["STAC_ITEM_LIMIT"] = limit
1482+
os.environ["STAC_DEFAULT_COLLECTION_LIMIT"] = limit
14811483
item = load_test_data("test_collection.json")
14821484

14831485
for i in range(10):
@@ -1497,7 +1499,7 @@ async def test_search_collection_limit_env_variable(
14971499
app_client, txn_client, load_test_data
14981500
):
14991501
limit = "5"
1500-
os.environ["STAC_ITEM_LIMIT"] = limit
1502+
os.environ["STAC_DEFAULT_ITEM_LIMIT"] = limit
15011503

15021504
test_collection = load_test_data("test_collection.json")
15031505
test_collection_id = "test-collection-search-limit"

stac_fastapi/tests/api/test_api_item_collection.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ async def test_item_collection_limit_env_variable(
1414
app_client, txn_client, load_test_data
1515
):
1616
limit = "5"
17-
os.environ["STAC_ITEM_LIMIT"] = limit
17+
os.environ["STAC_DEFAULT_ITEM_LIMIT"] = limit
1818

1919
test_collection = load_test_data("test_collection.json")
2020
test_collection_id = "test-collection-items-limit"

0 commit comments

Comments
 (0)