[python-fastapi] Use ... as default value rather than None (#22494)#23398
Open
zhornback wants to merge 2 commits intoOpenAPITools:masterfrom
Open
[python-fastapi] Use ... as default value rather than None (#22494)#23398zhornback wants to merge 2 commits intoOpenAPITools:masterfrom
zhornback wants to merge 2 commits intoOpenAPITools:masterfrom
Conversation
…ols#22494) With various FastAPI parameters (Query, Path, Header, Cookie, Body, Form, and File) the default value of None is a valid value, but signifies that the parameter is optional. To allow for required parameters, default should either not be set at all or be set to '...' (ellipsis). Issue: OpenAPITools#22494
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.
With various FastAPI parameters (Query, Path, Header, Cookie, Body, Form, and File) the default value of None is a valid value, but signifies that the parameter is optional. To allow for required parameters, default should either not be set at all or be set to '...' (ellipsis).
Reproduction details can be found in #22494.
fixes #22494
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)Summary by cubic
Switch the
python-fastapigenerator to emit...as the default for required params instead ofNone, so FastAPI correctly treats them as required. Fixes #22494 and aligns generated endpoints with OpenAPI “required” semantics across all param types.endpoint_argument_definition.mustacheto use...whenrequired, otherwiseNone, forQuery,Path,Header,Cookie,Body,Form, andFile....(e.g., pet/order/user bodies, status/tags/username/password queries).Written for commit 63a2d8a. Summary will update on new commits.