Swagger Docs #126
Merged
Swagger Docs #126
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
…gets pulled into the swagger docs (/docs endpoint) Update dependencies, add version retrieval function, and README.md rendering This commit updates the 'dataclasses-json' package and removes an unnecessary PyYAML wheel file from 'poetry.lock'. It also introduces 'get_version()' in 'utils.py' and modifies 'smib-fast.Dockerfile' to enable the root package installation with Poetry. Additionally, it includes a change to render the 'smib/webserver/README.md' file in the FastAPI app.
Refactored the webserver main to extract logic into separate functions for better code maintainability and readability. Also updated the README.md file of the webserver to contain more detailed information about the APIs, the server, and its endpoints, and improved error handling with specific responses for certain status codes.
sam57719
commented
May 28, 2024
sam57719
commented
May 28, 2024
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.
/docs endpoint now pulls in smib/webserver/README.md as its description
Refactored smib/webserver/main.py slightly, grouping the /smib/events path endpoints together so they share common settings for the swagger docs