[Swagger] Support multiple status codes in Swagger documentation #98
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
mjreiss
commented
Feb 16, 2021
| @@ -367,7 +367,14 @@ def _model_from_parser(model_name: str, parser: reqparse.RequestParser) -> Model | |||
|
|
|||
|
|
|||
| def merge(first: dict, second: dict) -> dict: | |||
| return {**first, **second} | |||
| for key, value in first.items(): | |||
There was a problem hiding this comment.
Perform a deep merge, which will also merge the response. This method is only called on line 370, where the given response model will be combined with any existing __apidoc__ responses.
|
Sorry for the delay, thanks so much! |
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.
This change adds support for providing multiple status code responses in the generated Swagger docs. Currently, any response provided in the
@respondsdecorator will completely override any additional documentation. It would be nice if any existing docs were respected and persisted. This is helpful when documenting any known errors that a route may raise, such as 404 and 401, which might not require a schema or any additional information. If desired, these responses may be added to the Swagger docs using a decorator such as@api.doc(responses={401: "Not Authorized", 404: "Not Found"}).This is partially related to issue #17, however it only adds support for multiple status code responses in the Swagger docs, it does not provide any additional support for the actual response. I might look into a fix for the given issue, which would actually support multiple responses and schemas.