stac-fastapi.api 3.0.0b3__tar.gz → 3.0.1__tar.gz

{stac_fastapi_api-3.0.0b3 → stac_fastapi_api-3.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: stac-fastapi.api
-Version: 3.0.0b3
+Version: 3.0.1
 Summary: An implementation of STAC API based on the FastAPI framework.
 Home-page: https://github.com/stac-utils/stac-fastapi
 Author: Arturo Engineering
@@ -19,7 +19,7 @@ Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: brotli_asgi
-Requires-Dist: stac-fastapi.types
+Requires-Dist: stac-fastapi.types~=3.0
 Provides-Extra: dev
 Requires-Dist: httpx; extra == "dev"
 Requires-Dist: pytest; extra == "dev"

{stac_fastapi_api-3.0.0b3 → stac_fastapi_api-3.0.1}/setup.py

@@ -7,7 +7,7 @@ with open("README.md") as f:
 
 install_requires = [
     "brotli_asgi",
-    "stac-fastapi.types",
+    "stac-fastapi.types~=3.0",
 ]
 
 extra_reqs = {

{stac_fastapi_api-3.0.0b3 → stac_fastapi_api-3.0.1}/stac_fastapi/api/config.py

@@ -12,7 +12,6 @@ class ApiExtensions(enum.Enum):
     Ref: https://github.com/stac-api-extensions
     """
 
-    context = "context"
     fields = "fields"
     filter = "filter"
     query = "query"

stac_fastapi_api-3.0.1/stac_fastapi/api/openapi.py

@@ -0,0 +1,37 @@
+"""openapi."""
+
+from fastapi import FastAPI
+from starlette.requests import Request
+from starlette.responses import JSONResponse, Response
+from starlette.routing import Route, request_response
+
+
+def update_openapi(app: FastAPI) -> FastAPI:
+    """Update OpenAPI response content-type.
+
+    This function modifies the openapi route to comply with the STAC API spec's required
+    content-type response header.
+    """
+    # Find the route for the openapi_url in the app
+    openapi_route: Route = next(
+        route for route in app.router.routes if route.path == app.openapi_url
+    )
+    # Store the old endpoint function so we can call it from the patched function
+    old_endpoint = openapi_route.endpoint
+
+    # 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)
+        # Update the content type header in place
+        response.headers["content-type"] = "application/vnd.oai.openapi+json;version=3.0"
+        # Return the updated response
+        return response
+
+    # When a Route is accessed the `handle` function calls `self.app`. Which is
+    # the endpoint function wrapped with `request_response`. So we need to wrap
+    # our patched function and replace the existing app with it.
+    openapi_route.app = request_response(patched_openapi_endpoint)
+
+    # return the patched app
+    return app

{stac_fastapi_api-3.0.0b3 → stac_fastapi_api-3.0.1}/stac_fastapi/api/routes.py

@@ -3,7 +3,6 @@
 import copy
 import functools
 import inspect
-import warnings
 from typing import Any, Callable, Dict, List, Optional, Type, TypedDict, Union
 
 from fastapi import Depends, params
@@ -38,19 +37,12 @@ def sync_to_async(func):
 def create_async_endpoint(
     func: Callable,
     request_model: Union[Type[APIRequest], Type[BaseModel], Dict],
-    response_class: Optional[Type[Response]] = None,
 ):
     """Wrap a function in a coroutine which may be used to create a FastAPI endpoint.
 
     Synchronous functions are executed asynchronously using a background thread.
     """
 
-    if response_class:
-        warnings.warn(
-            "`response_class` option is deprecated, please set the Response class directly in the endpoint.",  # noqa: E501
-            DeprecationWarning,
-        )
-
     if not inspect.iscoroutinefunction(func):
         func = sync_to_async(func)
 

stac_fastapi_api-3.0.1/stac_fastapi/api/version.py

@@ -0,0 +1,3 @@
+"""Library version."""
+
+__version__ = "3.0.1"

{stac_fastapi_api-3.0.0b3 → stac_fastapi_api-3.0.1}/stac_fastapi.api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: stac-fastapi.api
-Version: 3.0.0b3
+Version: 3.0.1
 Summary: An implementation of STAC API based on the FastAPI framework.
 Home-page: https://github.com/stac-utils/stac-fastapi
 Author: Arturo Engineering
@@ -19,7 +19,7 @@ Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: brotli_asgi
-Requires-Dist: stac-fastapi.types
+Requires-Dist: stac-fastapi.types~=3.0
 Provides-Extra: dev
 Requires-Dist: httpx; extra == "dev"
 Requires-Dist: pytest; extra == "dev"

{stac_fastapi_api-3.0.0b3 → stac_fastapi_api-3.0.1}/stac_fastapi.api.egg-info/requires.txt

@@ -1,5 +1,5 @@
 brotli_asgi
-stac-fastapi.types
+stac-fastapi.types~=3.0
 
 [benchmark]
 pytest-benchmark

stac_fastapi_api-3.0.0b3/stac_fastapi/api/openapi.py

@@ -1,87 +0,0 @@
-"""openapi."""
-
-import warnings
-
-from fastapi import FastAPI
-from fastapi.openapi.utils import get_openapi
-from starlette.requests import Request
-from starlette.responses import JSONResponse, Response
-from starlette.routing import Route, request_response
-
-from stac_fastapi.api.config import ApiExtensions
-from stac_fastapi.types.config import ApiSettings
-
-
-class VndOaiResponse(JSONResponse):
-    """JSON with custom, vendor content-type."""
-
-    media_type = "application/vnd.oai.openapi+json;version=3.0"
-
-    def __init__(self, *args, **kwargs):
-        """Init function with deprecation warning."""
-        warnings.warn(
-            "VndOaiResponse is deprecated and will be removed in v3.0",
-            DeprecationWarning,
-        )
-        super().__init__(*args, **kwargs)
-
-
-def update_openapi(app: FastAPI) -> FastAPI:
-    """Update OpenAPI response content-type.
-
-    This function modifies the openapi route to comply with the STAC API spec's required
-    content-type response header.
-    """
-    # Find the route for the openapi_url in the app
-    openapi_route: Route = next(
-        route for route in app.router.routes if route.path == app.openapi_url
-    )
-    # Store the old endpoint function so we can call it from the patched function
-    old_endpoint = openapi_route.endpoint
-
-    # 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)
-        # Update the content type header in place
-        response.headers["content-type"] = "application/vnd.oai.openapi+json;version=3.0"
-        # Return the updated response
-        return response
-
-    # When a Route is accessed the `handle` function calls `self.app`. Which is
-    # the endpoint function wrapped with `request_response`. So we need to wrap
-    # our patched function and replace the existing app with it.
-    openapi_route.app = request_response(patched_openapi_endpoint)
-
-    # return the patched app
-    return app
-
-
-def config_openapi(app: FastAPI, settings: ApiSettings):
-    """Config openapi."""
-    warnings.warn(
-        "config_openapi is deprecated and will be removed in v3.0",
-        DeprecationWarning,
-    )
-
-    def custom_openapi():
-        """Config openapi."""
-        if app.openapi_schema:
-            return app.openapi_schema
-
-        openapi_schema = get_openapi(
-            title="Arturo STAC API", version="0.1", routes=app.routes
-        )
-
-        if settings.api_extension_is_enabled(ApiExtensions.fields):
-            openapi_schema["paths"]["/search"]["get"]["responses"]["200"]["content"][
-                "application/json"
-            ]["schema"] = {"$ref": "#/components/schemas/ItemCollection"}
-            openapi_schema["paths"]["/search"]["post"]["responses"]["200"]["content"][
-                "application/json"
-            ]["schema"] = {"$ref": "#/components/schemas/ItemCollection"}
-
-        app.openapi_schema = openapi_schema
-        return app.openapi_schema
-
-    app.openapi = custom_openapi

stac_fastapi_api-3.0.0b3/stac_fastapi/api/version.py

@@ -1,2 +0,0 @@
-"""Library version."""
-__version__ = "3.0.0b3"