fix: expose request body schema in Swagger for unannotated endpoints #667#670
Open
korbonits wants to merge 2 commits intoLightning-AI:mainfrom
Open
fix: expose request body schema in Swagger for unannotated endpoints #667#670korbonits wants to merge 2 commits intoLightning-AI:mainfrom
korbonits wants to merge 2 commits intoLightning-AI:mainfrom
Conversation
for more information, see https://pre-commit.ci
Author
|
shoot, should i cancel this PR and re-submit since the tests.yml failed? would be good to see failure logs... |
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.
What does this PR do?
Fixes #667
As a user, I want to use the Swagger UI (/docs) to test my LitServe endpoints interactively. Before this fix, the /predict endpoint showed no input form in Swagger, so clicking "Execute" sent an empty
body and crashed the server with a JSONDecodeError. Now Swagger correctly renders a JSON request body form for endpoints without a Pydantic type annotation on decode_request.
Before submitting
PR review
Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in GitHub issues there's a high chance it will not be merged.
Did you have fun?
Make sure you had fun coding 🙃 <- Yes I had fun!