Change root path for API to display an informative landing message/page #199
Labels
feat:add
The first minimal viable change that implements a new functionality.
good first issue
Good issue for a new contributor.
importance:medium
We will address this but will delay for higher priority items.
PR welcome
Issue that is not an internal priority, but external PRs to address it are welcome.
released
This issue/pull request has been released.
type:feature
Effort to deliver new features, feature changes & improvements
Currently, navigating to the root of the API (
/
) displays a{"detail": "not found"}
message by default.We want to update our path config in FastAPI to instead show a page that displays a simple welcome message and directs users to visit the API docs for more information should be sufficient, e.g.:
(If
/docs
part could be made a link to the<base-url>/docs
, that would also be cool but is not a necessity.)The text was updated successfully, but these errors were encountered: