Ensure limit 0 searches return 400 (#296)

* Ensure limit 0 searches return 400 * Update changelog
stac-utils · Nov 24, 2021 · cad5e5c · cad5e5c
1 parent 3219b65
commit cad5e5c
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 2 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -10,6 +10,7 @@
 
 ### Fixed
 
+* The minimum `limit` value for searches is now 1 ([#296](https://github.com/stac-utils/stac-fastapi/pull/296))
 * Links stored with Collections and Items (e.g. license links) are now returned with those STAC objects ([#282](https://github.com/stac-utils/stac-fastapi/pull/282))
 
 ## [2.2.0]

diff --git a/stac_fastapi/pgstac/stac_fastapi/pgstac/types/search.py b/stac_fastapi/pgstac/stac_fastapi/pgstac/types/search.py
@@ -100,7 +100,7 @@ class PgstacSearch(Search):
     token: Optional[str] = None
     datetime: Optional[str] = None
     sortby: Any
-    limit: Optional[conint(ge=0, le=10000)] = 10
+    limit: Optional[conint(gt=0, le=10000)] = 10
 
     @root_validator(pre=True)
     def validate_query_fields(cls, values: Dict) -> Dict:

diff --git a/stac_fastapi/pgstac/tests/api/test_api.py b/stac_fastapi/pgstac/tests/api/test_api.py
@@ -81,6 +81,13 @@ async def test_app_query_extension_limit_1(
     assert len(resp_json["features"]) == 1
 
 
+@pytest.mark.asyncio
+async def test_app_query_extension_limit_eq0(app_client):
+    params = {"limit": 0}
+    resp = await app_client.post("/search", json=params)
+    assert resp.status_code == 400
+
+
 @pytest.mark.asyncio
 async def test_app_query_extension_limit_lt0(
     load_test_data, app_client, load_test_collection

diff --git a/stac_fastapi/sqlalchemy/stac_fastapi/sqlalchemy/types/search.py b/stac_fastapi/sqlalchemy/stac_fastapi/sqlalchemy/types/search.py
@@ -145,7 +145,7 @@ class SQLAlchemySTACSearch(Search):
     # Override query extension with supported operators
     query: Optional[Dict[Queryables, Dict[Operator, Any]]]
     token: Optional[str] = None
-    limit: Optional[conint(ge=0, le=10000)] = 10
+    limit: Optional[conint(gt=0, le=10000)] = 10
 
     @root_validator(pre=True)
     def validate_query_fields(cls, values: Dict) -> Dict:

diff --git a/stac_fastapi/sqlalchemy/tests/api/test_api.py b/stac_fastapi/sqlalchemy/tests/api/test_api.py
@@ -102,6 +102,12 @@ def test_app_query_extension_gte(load_test_data, app_client, postgres_transactio
     assert len(resp_json["features"]) == 1
 
 
+def test_app_query_extension_limit_eq0(app_client):
+    params = {"limit": 0}
+    resp = app_client.post("/search", json=params)
+    assert resp.status_code == 400
+
+
 def test_app_query_extension_limit_lt0(
     load_test_data, app_client, postgres_transactions
 ):