Allow adding multiple media types for a response#495
Merged
greyli merged 1 commit intoapiflask:mainfrom Nov 12, 2023
Merged
Conversation
Member
|
Merged, thanks! |
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.
This PR modifies the code that handles
@app.doc(responses=...). The proposed implementation deals with cases wherea
dictis passed.The previous behavior assumed the passed dict would be used as the OpenAPI definition of the view's responses. This proposed implementation instead merges the contents of the passed dict taking into account the
contentkey of eachstatus code. This is done in order to preserve whatever information might have already been automatically generated in
previous steps, namely what had been added while processing
app.output().This means that with the current PR, APIFlask would preserve a view's main response media type, while also allowing
the addition of other, secondary media types, thus addressing the contents of issue #494
fixes #494
Checklist:
docsfolder and in code docstring.CHANGES.mdsummarizing the change and linking to the issue.*Version changed*or*Version added*note in any relevant docs and docstring. - IMO this doesn't seem relevant for the current PRpytestandtox, no tests failed.