Skip to content

feat: Remove 404 at "/" #1330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dan-fernandes merged 12 commits into from
Jan 14, 2026
Merged

feat: Remove 404 at "/" #1330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
c467cd8
Set app's docs_url to "/"
dan-fernandes Jan 9, 2026
d1ce0b9
Revert "Set app's docs_url to "/""
dan-fernandes Jan 13, 2026
288aa94
Add redirect from / to /docs
dan-fernandes Jan 13, 2026
3cfc3e9
Add docs_endpoint config field
dan-fernandes Jan 13, 2026
24bda6f
Update config schema
dan-fernandes Jan 13, 2026
418788c
fix config interface
ZohebShaikh Jan 14, 2026
abe5393
Change docs endpoint from config field to constant variable
dan-fernandes Jan 14, 2026
9e10812
Change root redirect from permanent to temporary redirect
dan-fernandes Jan 14, 2026
1bf3cb3
Merge branch 'main' into change-docs-url
dan-fernandes Jan 14, 2026
439ca4f
Update tests/unit_tests/service/test_rest_api.py
dan-fernandes Jan 14, 2026
15944f4
Fix root_redirect function signature
dan-fernandes Jan 14, 2026
c126751
Lint
dan-fernandes Jan 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion src/blueapi/service/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
VENDOR_CONTEXT_HEADER = "tracestate"
AUTHORIZAITON_HEADER = "authorization"
PROPAGATED_HEADERS = {CONTEXT_HEADER, VENDOR_CONTEXT_HEADER, AUTHORIZAITON_HEADER}
DOCS_ENDPOINT = "/docs"


class Tag(str, Enum):
Expand Down Expand Up @@ -132,7 +133,7 @@ async def inner(app: FastAPI):

def get_app(config: ApplicationConfig):
app = FastAPI(
docs_url="/docs",
docs_url=DOCS_ENDPOINT,
title="BlueAPI Control",
summary="BlueAPI wraps bluesky plans and devices and "
"exposes endpoints to send commands/receive data",
Expand Down Expand Up @@ -205,6 +206,14 @@ async def on_token_error_401(_: Request, __: Exception):
)


@secure_router.get("/", include_in_schema=False)
def root_redirect() -> RedirectResponse:
"""Redirect to docs url"""
return RedirectResponse(
status_code=status.HTTP_307_TEMPORARY_REDIRECT, url=DOCS_ENDPOINT
)


@secure_router.get("/environment", tags=[Tag.ENV])
@start_as_current_span(TRACER, "runner")
def get_environment(
Expand Down
10 changes: 10 additions & 0 deletions tests/unit_tests/service/test_rest_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -744,6 +744,16 @@ def test_logout(
)


def test_docs_redirect(
mock_authn_server,
client_with_auth: TestClient,
):
client_with_auth.follow_redirects = False
response = client_with_auth.get("/")
assert response.headers.get("location") == main.DOCS_ENDPOINT
assert response.status_code == status.HTTP_307_TEMPORARY_REDIRECT


@pytest.mark.parametrize("has_oidc_config", [True, False])
def test_logout_when_oidc_config_invalid(
has_oidc_config: bool,
Expand Down