refactor: move Swagger UI to root path #665
Merged
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
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
- Move Swagger UI from /docs to root path (/) - Relocate root health check to /health endpoint - Add redirect from /docs to / for backward compatibility - Disable Redoc UI Co-Authored-By: Benjamin Bolte <[email protected]>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
⚙️ Control Options:
|
codekansas
requested changes
Dec 29, 2024
www/app/main.py
Outdated
Comment on lines
121
to
124
| @app.get("/docs", include_in_schema=False) | ||
| async def docs_redirect() -> RedirectResponse: | ||
| """Redirect /docs to the root path where Swagger UI is now served.""" | ||
| return RedirectResponse(url="/") |
www/app/main.py
Outdated
Comment on lines
115
to
118
| @app.get("/") | ||
| async def read_root() -> bool: | ||
| @app.get("/health") | ||
| async def health_check() -> bool: | ||
| """Health check endpoint that returns True if the service is running.""" | ||
| return True |
There was a problem hiding this comment.
actually, we can just delete this and use /docs for health checks
www/app/main.py
Outdated
Comment on lines
52
to
53
| docs_url="/", # New location for Swagger UI | ||
| redoc_url=None, # Disable Redoc UI |
There was a problem hiding this comment.
remove the comments, and add back the redoc url from before
…direct) Co-Authored-By: Benjamin Bolte <[email protected]>
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.
Move Swagger UI to Root Path
This PR moves the Swagger UI from
/docsto the root path (/), improving API documentation accessibility.Changes
/docsto root path (/)/healthendpoint with improved documentation/docsto/for backward compatibilityNotes
make lintandmake teststeps/)Testing
make lint)/healthendpoint returning true/docsredirecting to rootLink to Devin run: https://app.devin.ai/sessions/acedfbfec89b44af8bf3b190b1f01502