stac-fastapi.api 5.2.0__tar.gz → 5.2.1__tar.gz

{stac_fastapi_api-5.2.0 → stac_fastapi_api-5.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stac-fastapi.api
-Version: 5.2.0
+Version: 5.2.1
 Summary: An implementation of STAC API based on the FastAPI framework.
 Home-page: https://github.com/stac-utils/stac-fastapi
 Author: Arturo Engineering

{stac_fastapi_api-5.2.0 → stac_fastapi_api-5.2.1}/stac_fastapi/api/app.py

@@ -12,7 +12,7 @@ from stac_pydantic.api.collections import Collections
 from stac_pydantic.shared import MimeTypes
 from stac_pydantic.version import STAC_VERSION
 from starlette.middleware import Middleware
-from starlette.responses import JSONResponse, Response
+from starlette.responses import Response
 
 from stac_fastapi.api.errors import DEFAULT_STATUS_CODES, add_exception_handlers
 from stac_fastapi.api.middleware import CORSMiddleware, ProxyHeaderMiddleware
@@ -21,8 +21,10 @@ from stac_fastapi.api.models import (
     CollectionUri,
     EmptyRequest,
     GeoJSONResponse,
+    HealthCheck,
     ItemCollectionUri,
     ItemUri,
+    JSONResponse,
 )
 from stac_fastapi.api.openapi import update_openapi
 from stac_fastapi.api.routes import (
@@ -396,12 +398,15 @@ class StacApi:
         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-5.2.0 → stac_fastapi_api-5.2.1}/stac_fastapi/api/errors.py

@@ -8,8 +8,8 @@ from fastapi.encoders import jsonable_encoder
 from fastapi.exceptions import RequestValidationError, ResponseValidationError
 from starlette import status
 from starlette.requests import Request
-from starlette.responses import JSONResponse
 
+from stac_fastapi.api.models import JSONResponse
 from stac_fastapi.types.errors import (
     ConflictError,
     DatabaseError,

{stac_fastapi_api-5.2.0 → stac_fastapi_api-5.2.1}/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-5.2.0 → stac_fastapi_api-5.2.1}/stac_fastapi/api/openapi.py

@@ -2,7 +2,7 @@
 
 from fastapi import FastAPI
 from starlette.requests import Request
-from starlette.responses import JSONResponse, Response
+from starlette.responses import Response
 from starlette.routing import Route, request_response
 
 
@@ -22,7 +22,7 @@ def update_openapi(app: FastAPI) -> FastAPI:
     # Create a patched endpoint function that modifies the content type of the response
     async def patched_openapi_endpoint(req: Request) -> Response:
         # Get the response from the old endpoint function
-        response: JSONResponse = await old_endpoint(req)
+        response = await old_endpoint(req)
         # Update the content type header in place
         response.headers["content-type"] = "application/vnd.oai.openapi+json;version=3.0"
         # Return the updated response

{stac_fastapi_api-5.2.0 → stac_fastapi_api-5.2.1}/stac_fastapi/api/version.py

@@ -1,3 +1,3 @@
 """Library version."""
 
-__version__ = "5.2.0"
+__version__ = "5.2.1"

{stac_fastapi_api-5.2.0 → stac_fastapi_api-5.2.1}/stac_fastapi.api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stac-fastapi.api
-Version: 5.2.0
+Version: 5.2.1
 Summary: An implementation of STAC API based on the FastAPI framework.
 Home-page: https://github.com/stac-utils/stac-fastapi
 Author: Arturo Engineering

{stac_fastapi_api-5.2.0 → stac_fastapi_api-5.2.1}/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(