Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds a landing page for the root endpoint (/) that provides easy access to API documentation. Previously, accessing the root URL likely resulted in a 404 or redirection; now users are presented with a styled HTML page offering links to both Swagger UI and ReDoc documentation interfaces.
Key Changes
- Created an HTML template with styling for the landing page
- Added a root endpoint handler that serves the template
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| app/templates/index.html | New HTML template with styling and links to Swagger and ReDoc documentation |
| app/main.py | Added root endpoint handler to serve the landing page template |
Contributor
Author
|
@copilot open a new pull request to apply changes based on the comments in this thread |
Contributor
…e sync Co-authored-by: jbouder <61591423+jbouder@users.noreply.github.com>
Optimize root endpoint: add template caching and error handling
This file contains hidden or 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
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.
The current baseline API, when loaded up on http://localhost:5000, returns a basic empty JSON response, due to the route not having a defined result. This update defines a route for the root path which returns an HTML response, providing links to both Swagger and Redoc docs.
Description
Related Issue
N/A
Motivation and Context
How Has This Been Tested?
Screenshots (if appropriate):
Before
After