Fix ModelField alias property #13833
Draft
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 in ebdeda2
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 in ebdeda2
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!