Merge branch 'main' of https://github.com/stac-utils/stac-fastapi into HEAD

Author: vincentsarago

CHANGES.md

@@ -6,6 +6,11 @@
 
 - avoid future deprecation for pydantic.Field and use `json_schema_extra` instead of `openapi_examples`
 - use `orjson` based JSONResponse when available
+- changed from `AssertionError` to `HTTPException` for **bbox** parsing exceptions
+
+### Added
+
+- add response model for `/_mgmt/health` endpoint
 
 ## [5.2.0] - 2025-04-18
 

stac_fastapi/api/stac_fastapi/api/app.py

@@ -21,6 +21,7 @@
     CollectionUri,
     EmptyRequest,
     GeoJSONResponse,
+    HealthCheck,
     ItemCollectionUri,
     ItemUri,
     JSONResponse,
@@ -397,12 +398,15 @@ async def ping():
         mgmt_router.add_api_route(
             name="Health",
             path="/_mgmt/health",
-            response_model=Dict,
+            response_model=(
+                HealthCheck if self.settings.enable_response_models else None
+            ),
             responses={
                 200: {
                     "content": {
                         MimeTypes.json.value: {},
                     },
+                    "model": HealthCheck,
                 },
             },
             response_class=self.response_class,

stac_fastapi/api/stac_fastapi/api/models.py

@@ -1,6 +1,6 @@
 """Api request/response models."""
 
-from typing import List, Optional, Type, Union
+from typing import List, Literal, Optional, Type, Union
 
 import attr
 from fastapi import Path, Query
@@ -135,3 +135,9 @@ class JSONSchemaResponse(JSONResponse):
     """JSON with custom, vendor content-type."""
 
     media_type = "application/schema+json"
+
+
+class HealthCheck(BaseModel, extra="allow"):
+    """health check response model."""
+
+    status: Literal["UP", "DOWN"]

stac_fastapi/api/tests/test_models.py

@@ -43,7 +43,10 @@ def test_create_get_request_model():
     model = request_model(bbox="0,0,0,1,1,1")
     assert model.bbox == (0.0, 0.0, 0.0, 1.0, 1.0, 1.0)
 
-    with pytest.raises(AssertionError):
+    with pytest.raises(HTTPException):
+        request_model(bbox="a,b")
+
+    with pytest.raises(HTTPException):
         request_model(bbox="0,0,0,1,1")
 
     model = request_model(

stac_fastapi/types/stac_fastapi/types/search.py

@@ -5,7 +5,7 @@
 from typing import Dict, List, Optional, Union
 
 import attr
-from fastapi import Query
+from fastapi import HTTPException, Query
 from pydantic import Field, PositiveInt
 from pydantic.functional_validators import AfterValidator
 from stac_pydantic.api import Search
@@ -34,8 +34,16 @@ def str2list(x: str) -> Optional[List[str]]:
 def str2bbox(x: str) -> Optional[BBox]:
     """Convert string to BBox based on , delimiter."""
     if x:
-        t = tuple(float(v) for v in x.split(","))
-        assert len(t) in [4, 6], f"BBox '{x}' must have 4 or 6 values."
+        try:
+            t = tuple(float(v) for v in x.split(","))
+        except ValueError:
+            raise HTTPException(status_code=400, detail=f"invalid bbox: {x}")
+
+        if len(t) not in (4, 6):
+            raise HTTPException(
+                status_code=400, detail=f"BBox '{x}' must have 4 or 6 values."
+            )
+
         return t
 
     return None