Display API version number at top of Swagger UI page#66
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR customizes the Swagger UI interface by updating the FastAPI application configuration to display project-specific branding and version information instead of default values.
- Replaces default "FastAPI" title with "BERtron API"
- Adds description with GitHub source link and BERtron schema version
- Sets API version to match the package version from pyproject.toml
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.
On this branch, I customized the Swagger UI header. Specifically, I made it so the header shows the same package version number as the
/versionendpoint returns, which comes frompyproject.toml. I also replaced the default "FastAPI" title with "BERtron API". Finally, I added a description that links to the GitHub repository and shows the schema version.