Skip to content

feat: configure OpenAPI docs for prod. (closes #110) #111

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
p-north merged 2 commits into from
Aug 25, 2025
Merged

feat: configure OpenAPI docs for prod. (closes #110) #111

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b2a592
feat: configure OpenAPI docs for prod. (closes #110)
p-north Aug 25, 2025
c37e864
fix linting
p-north Aug 25, 2025
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
26 changes: 20 additions & 6 deletions src/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,26 @@
) + "%2Fapi%2Fauth%2Flogin%3Fredirect_path%3D%2Fapi%2Fapi%2Fdocs%2F%26redirect_fragment%3D"
)

app = FastAPI(
lifespan=database.lifespan,
title="CSSS Site Backend",
description=f'To login, please click <a href="{_login_link}">here</a><br><br>To logout from CAS click <a href="https://cas.sfu.ca/cas/logout">here</a>',
root_path="/api"
)
# Enable OpenAPI docs only for local development
if os.environ.get("LOCAL") == "true":
app = FastAPI(
lifespan=database.lifespan,
title="CSSS Site Backend",
description=f'To login, please click <a href="{_login_link}">here</a><br><br>To logout from CAS click <a href="https://cas.sfu.ca/cas/logout">here</a>',
root_path="/api",
)
# if on production, disable vieweing the docs
else:
app = FastAPI(
lifespan=database.lifespan,
title="CSSS Site Backend",
description=f'To login, please click <a href="{_login_link}">here</a><br><br>To logout from CAS click <a href="https://cas.sfu.ca/cas/logout">here</a>',
root_path="/api",
docs_url=None, # disables Swagger UI
redoc_url=None, # disables ReDoc
openapi_url=None # disables OpenAPI schema
Comment thread
p-north marked this conversation as resolved.
)


app.include_router(auth.urls.router)
app.include_router(elections.urls.router)
Expand Down