Pin FastAPI to avoid OpenAPI docs rendering issues (#246)

* Reorder install order in docker build; remove tiles from extension

titiler depends on an earlier version of FastAPI and doesn't allow the
dockerized server to have the FastAPI version dictated by the
stac-fastapi setup.

* Pin fastapi in stac_fastapi.types; remove from other packages.

This pins fastapi to 0.67.* in stac_fastapi.types, and has all other
packages rely on that dependency to pull in the correct version. This
also adds a missing dependency on stac_fastapi.types in
stac_fastapi.api.

Fixes #242

* Remove tiler tests.

This breaks the dockerized tests as titiler isn't installed in the
docker image anymore. Based on the outcome of #245, these (and ideally
more robust tests) can be re-added, or the tiles extension will be
dropped completely.

* Add changelog entry

* Install types first in CI, as it's the base subpackage

* Remove stac_fastapi.extensions[tiles] from test install.

I do not know why, but installing the tiles extra re-installs
stac-fastapi.types in a way that breaks an import.

.github/workflows/cicd.yaml

@@ -47,17 +47,17 @@ jobs:
         run: |
           python -m pip install --upgrade pipenv wheel
 
-      - name: Install core api
-        run: |
-          pip install ./stac_fastapi/api[dev]
-
       - name: Install types
         run: |
           pip install ./stac_fastapi/types[dev]
 
+      - name: Install core api
+        run: |
+          pip install ./stac_fastapi/api[dev]
+
       - name: Install Extensions
         run: |
-          pip install ./stac_fastapi/extensions[dev,tiles]
+          pip install ./stac_fastapi/extensions[dev]
 
       - name: Install sqlalchemy stac-fastapi
         run: |

CHANGES.md

@@ -10,6 +10,8 @@
 
 ### Fixed
 
+* Pin FastAPI to 0.67 to avoid issues with rendering OpenAPI documentation ([#246](https://github.com/stac-utils/stac-fastapi/pull/246))
+
 ## [2.1.0]
 
 ### Added

Dockerfile

@@ -17,8 +17,8 @@ COPY . /app
 ENV PATH=$PATH:/install/bin
 
 RUN mkdir -p /install && \
-    pip install -e ./stac_fastapi/api[dev] && \
     pip install -e ./stac_fastapi/types[dev] && \
-    pip install -e ./stac_fastapi/extensions[dev,tiles] && \
+    pip install -e ./stac_fastapi/api[dev] && \
+    pip install -e ./stac_fastapi/extensions[dev] && \
     pip install -e ./stac_fastapi/sqlalchemy[dev,server] && \
     pip install -e ./stac_fastapi/pgstac[dev,server]

stac_fastapi/api/setup.py

@@ -6,11 +6,11 @@
     desc = f.read()
 
 install_requires = [
-    "fastapi",
     "attrs",
     "pydantic[dotenv]",
     "stac_pydantic==2.0.*",
     "brotli_asgi",
+    "stac-fastapi.types",
 ]
 
 extra_reqs = {

stac_fastapi/extensions/setup.py

@@ -6,7 +6,6 @@
     desc = f.read()
 
 install_requires = [
-    "fastapi",
     "attrs",
     "pydantic[dotenv]",
     "stac_pydantic==2.0.*",

stac_fastapi/pgstac/setup.py

@@ -6,7 +6,6 @@
     desc = f.read()
 
 install_requires = [
-    "fastapi",
     "attrs",
     "orjson",
     "pydantic[dotenv]",

stac_fastapi/sqlalchemy/setup.py

@@ -6,7 +6,6 @@
     desc = f.read()
 
 install_requires = [
-    "fastapi",
     "attrs",
     "pydantic[dotenv]",
     "stac_pydantic==2.0.*",

stac_fastapi/types/setup.py

@@ -6,7 +6,9 @@
     desc = f.read()
 
 install_requires = [
-    "fastapi",
+    # We need to pin fastapi for the openapi schema
+    # See https://github.com/stac-utils/stac-fastapi/issues/242
+    "fastapi==0.67.*",
     "attrs",
     "pydantic[dotenv]",
     "stac_pydantic==2.0.*",