fix: falcon json get_media should not throw error if json is annotated #447
Conversation
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
Member
kemingy
commented
Sep 12, 2025
- fix bug: Falcon Plugin does not return pydantic model with defaults if possible. #446
Signed-off-by: Keming <kemingy94@gmail.com>
There was a problem hiding this comment.
Pull Request Overview
This PR fixes an issue where Falcon's get_media() method throws an error when validating optional JSON in annotated handlers. The fix ensures that when JSON is optional (meaning it can be None or empty), the validation process doesn't fail due to missing media content.
- Adds
default_when_empty={}parameter toget_media()calls in Falcon plugin - Introduces
OptionalJSONmodel and corresponding test views for optional JSON validation - Adds comprehensive test coverage for optional JSON scenarios in both sync and async Falcon handlers
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| spectree/plugins/falcon_plugin.py | Modified validation logic to handle optional JSON by providing default empty dict when media is missing |
| tests/common.py | Added OptionalJSON model for testing optional JSON validation scenarios |
| tests/test_plugin_falcon.py | Added OptionalUserScore class and test for optional JSON validation in sync Falcon |
| tests/test_plugin_falcon_asgi.py | Added OptionalUserScore class and test for optional JSON validation in async Falcon, plus test function name updates |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Signed-off-by: Keming <kemingy94@gmail.com>
Signed-off-by: Keming <kemingy94@gmail.com>
Signed-off-by: Keming <kemingy94@gmail.com>
Signed-off-by: Keming <kemingy94@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.