Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.6k
Fix ModelField alias property#13833
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Draft
pressogh wants to merge3 commits intofastapi:masterChoose a base branch frompressogh:fix-model-field-alias
base:master
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Draft
Uh oh!
There was an error while loading.Please reload this page.
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
Sign up for freeto 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.
Hello!
I've encountered an issue in FastAPI's
openapi.json
generation for parameter inputs (Query
,Header
,Cookie
). When usingalias
for field names in Pydantic models, the alias appears correctly in the generated schema. However, when usingvalidation_alias
, it is ignored and the original field name is shown instead.To demonstrate this behavior, I’ve included minimal reproducible examples along with corresponding Swagger UI screenshots.
With alias
With validation_alias
As shown above, even though validation_alias="bar" is set, the OpenAPI schema still uses "foo".
Upon inspecting the parameter generation logic, I found that the name used in the schema is determined via the field alias:
fastapi/fastapi/openapi/utils.py
Line 137 inebdeda2
This uses Pydantic’s ModelField logic, where alias is returned if present; otherwise, the field name is used:
fastapi/fastapi/_compat.py
Lines 88 to 97 inebdeda2
Proposed Change
This PR modifies the alias resolution logic in ModelField to prioritize validation_alias or serialization_alias, depending on mode, instead of defaulting to alias alone.
Thanks for taking the time to review this!