Pin FastAPI to avoid OpenAPI docs rendering issues #246
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
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
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.
vincentsarago
approved these changes
Aug 27, 2021
I do not know why, but installing the tiles extra re-installs stac-fastapi.types in a way that breaks an import.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issue(s): #242
Description:
This PR pins fastapi to
0.67.*, which is tested to work for rendering OpenAPI docs (where the recent0.68.*release does not).It also removes fastapi as a dependency from all subpackages besides
stac-fastapi.types, the base subpackage which all others depend, to allow a single package to determine the pinned version. It also adds stac-fastapi.types as a dependency to stac-fastapi.api, which was incorrectly missing. Lastly, it removes titiler from the docker image (viapip install stac_api.extensions[tiler]) as that forces titiler's pinned FastAPI version, which is 0.63. IMO in future work we should remove the tile extension as the recommended way to integrate titiler and stac-fastapi is to run independent services.This removes the single test against the tiles extension, as removing titiler from the docker image causes this test to fail
make test. Created #245 to track whether these should be re-added (and the dependency conflicts between titiler and stac-fastapi resolved) or if the tile extension should be dropped completely.PR Checklist:
pre-commit run --all-files)make test)make docs)