DiamondLightSource / DiamondLightSource/smartem-decisions

API swagger docs inaccessible behind proxy

Open
#306 0 comments 0 reactions 0 assignees View on GitHub
bugfixing documentation
Dominant language
Python
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Going to the docs page sends you to this error

Image

I've seen this before and the solution was to set the `--root-path` flag as described here: https://fastapi.tiangolo.com/advanced/behind-a-proxy/#proxy-with-a-stripped-path-prefix

Contributor guide

Open the contributing guide

Research direction

The issue does not name a file or test. Start by reproducing the Swagger docs failure when the application is served behind a proxy, then read FastAPI's linked 'behind a proxy' guidance and inspect the application's startup entry point for the `--root-path` setting. Done means the docs page loads successfully through the proxy without the shown error.

Written by the indexing model from the issue text.

Assessment

Tech stack
fastapi, python
Domain
api, backend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.