Merge pull request #227 from developmentseed/fix/tileset-rel

fix rel for tiling-scheme and openapi media-type

Author: vincentsarago

tests/routes/test_endpoints.py

@@ -63,7 +63,10 @@ def test_docs(app):
     """Test /api endpoint."""
     response = app.get("/api")
     assert response.status_code == 200
-    assert response.headers["content-type"] == "application/json"
+    assert (
+        response.headers["content-type"]
+        == "application/vnd.oai.openapi+json;version=3.0"
+    )
     body = response.json()
     assert body["openapi"]
 

tipg/factory.py

@@ -1254,7 +1254,7 @@ def links(self, request: Request) -> List[model.Link]:
                     "tilematrixsets",
                 ),
                 type=MediaType.json,
-                rel="data",
+                rel="http://www.opengis.net/def/rel/ogc/1.0/tiling-schemes",
             ),
             model.Link(
                 title="TileMatrixSet (Template URL)",
@@ -1315,8 +1315,6 @@ async def tilematrixsets(
                                     "tilematrixset",
                                     tileMatrixSetId=tms_id,
                                 ),
-                                rel="http://www.opengis.net/def/rel/ogc/1.0/tiling-schemes",
-                                type=MediaType.json,
                             )
                         ],
                     )
@@ -1435,7 +1433,7 @@ async def collection_tileset_list(
                                         "tilematrixset",
                                         tileMatrixSetId=tms,
                                     ),
-                                    "rel": "http://www.opengis.net/def/rel/ogc/1.0/tiling-schemes",
+                                    "rel": "http://www.opengis.net/def/rel/ogc/1.0/tiling-scheme",
                                     "type": "application/json",
                                     "title": f"Definition of '{tms}' tileMatrixSet",
                                 },
@@ -1546,7 +1544,7 @@ async def collection_tileset(
                         "tilematrixset",
                         tileMatrixSetId=tileMatrixSetId,
                     ),
-                    "rel": "http://www.opengis.net/def/rel/ogc/1.0/tiling-schemes",
+                    "rel": "http://www.opengis.net/def/rel/ogc/1.0/tiling-scheme",
                     "type": "application/json",
                     "title": f"Definition of '{tileMatrixSetId}' tileMatrixSet",
                 },

tipg/main.py

@@ -11,6 +11,7 @@
 from tipg.errors import DEFAULT_STATUS_CODES, add_exception_handlers
 from tipg.factory import Endpoints
 from tipg.middleware import CacheControlMiddleware, CatalogUpdateMiddleware
+from tipg.openapi import _update_openapi
 from tipg.settings import APISettings, CustomSQLSettings, DatabaseSettings
 
 from fastapi import FastAPI, Request
@@ -53,6 +54,9 @@ async def lifespan(app: FastAPI):
     root_path=settings.root_path,
 )
 
+# Fix OpenAPI response header for OGC Common compatibility
+_update_openapi(app)
+
 # custom template directory
 templates_location: List[Any] = (
     [jinja2.FileSystemLoader(settings.template_directory)]

tipg/model.py

@@ -250,7 +250,7 @@ class TileMatrixSetLink(BaseModel):
     """
 
     href: str
-    rel: str = "http://www.opengis.net/def/rel/ogc/1.0/tiling-schemes"
+    rel: str = "http://www.opengis.net/def/rel/ogc/1.0/tiling-scheme"
     type: MediaType = MediaType.json
 
     model_config = {"use_enum_values": True}

tipg/openapi.py

@@ -0,0 +1,64 @@
+"""TiPG openapi tools."""
+
+from fastapi import FastAPI
+
+from starlette.requests import Request
+from starlette.responses import 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.
+
+    Copied from https://github.com/stac-utils/stac-fastapi/blob/main/stac_fastapi/api/stac_fastapi/api/openapi.py
+
+    MIT License
+
+    Copyright (c) 2020 Arturo AI
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE.
+    """
+    # 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 = 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