-
-
Notifications
You must be signed in to change notification settings - Fork 6.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support Pydantic root model as query parameter #11306
base: master
Are you sure you want to change the base?
Changes from all commits
3b0362e
2df55f2
52841df
d54c749
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,6 +29,7 @@ | |
copy_field_info, | ||
create_body_model, | ||
evaluate_forwardref, | ||
field_annotation_is_root_model, | ||
field_annotation_is_scalar, | ||
get_annotation_from_field_info, | ||
get_missing_field_error, | ||
|
@@ -414,7 +415,11 @@ def analyze_param( | |
type_annotation | ||
) or is_uploadfile_sequence_annotation(type_annotation): | ||
field_info = params.File(annotation=use_annotation, default=default_value) | ||
elif not field_annotation_is_scalar(annotation=type_annotation): | ||
elif ( | ||
not field_annotation_is_scalar(type_annotation) | ||
# Root models by default regarded as bodies | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Backward compatibility. Root models have been regarded as body params by default eventhough they were scalar. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Another option would be to explicitly require annotating by |
||
or field_annotation_is_root_model(type_annotation) | ||
): | ||
field_info = params.Body(annotation=use_annotation, default=default_value) | ||
else: | ||
field_info = params.Query(annotation=use_annotation, default=default_value) | ||
|
@@ -459,7 +464,9 @@ def is_body_param(*, param_field: ModelField, is_path_param: bool) -> bool: | |
field=param_field | ||
), "Path params must be of one of the supported types" | ||
return False | ||
elif is_scalar_field(field=param_field): | ||
elif is_scalar_field(field=param_field) and not isinstance( | ||
param_field.field_info, params.Body | ||
): | ||
return False | ||
elif isinstance( | ||
param_field.field_info, (params.Query, params.Header) | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This check was missing from v1 side. Lifted the
params.Body
check out from this "scalar field check" intois_body_param
check which is more appropriate for checking theparams.Body
case.