Allow support for exclusion/inclusion of none and unset fields in OpenAPI schema #5693
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
|
📝 Docs preview for commit bc42942 at: https://63829f79adf1a077f4910f7c--fastapi.netlify.app |
|
📝 Docs preview for commit 53c5b4c at: https://638365e8adf1a0751591140e--fastapi.netlify.app |
|
📝 Docs preview for commit b1f7581 at: https://6383987b8f98a10b42c6c25f--fastapi.netlify.app |
|
📝 Docs preview for commit 35320a8 at: https://639ce6c6a7c2ed05d88a98ed--fastapi.netlify.app |
Ryandaydev
approved these changes
Jan 6, 2023
There was a problem hiding this comment.
Full disclosure: I can't speak to the appropriateness of where the parameters are applied, etc.
However:
- Reproduced behavior in master before fix (missing fields in example with 'none' value).
- Verified intended behavior after PR applied (configurable parameter, 'none' value in example).
- Verified tests ran successfully.
- Verified openapi.json is valid using online validator.
yezz123
approved these changes
Jan 6, 2023
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.
Summary
This PR addresses the issue #5559. Currently, the OpenAPI schema returned by
get_openapiexcludes none fields by default, and there are no parameters to customize this. The fix allows user to specify the exclusion/inclusion of none or unset fields when initializingFastAPI().