@computed_field not showing in OpenAPI Json #9856
-
First Check
Commit to Help
Example Codefrom fastapi import FastAPI
import pydantic
import uvicorn
class StudentGrades(pydantic.BaseModel):
english: int
history: int
geography: int
@pydantic.computed_field()
@property
def grade(self) -> float:
return (self.english + self.history + self.geography)/ 3
app = FastAPI()
@app.get("/")
def sample() -> StudentGrades:
return StudentGrades(english=100, history=100, geography=70)DescriptionWhen using model with a computed field, if I check the content of the response: {
"english": 100,
"history": 100,
"geography": 70,
"grade": 90.0 // computed field
}The computed field is in the response, as expected. However, the computed field is not being added to the json schema: {
"openapi": "3.1.0",
"info": {
"title": "FastAPI",
"version": "0.1.0"
},
"paths": {
"/": {
"get": {
"summary": "Sample",
"operationId": "sample__get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StudentGrades"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"StudentGrades": {
"properties": {
"english": {
"type": "integer",
"title": "English"
},
"history": {
"type": "integer",
"title": "History"
},
"geography": {
"type": "integer",
"title": "Geography"
}
},
"type": "object",
"required": [
"english",
"history",
"geography"
],
"title": "StudentGrades"
}
}
}
}And therefore, not showing in Swagger UI: Operating SystemWindows, macOS Operating System DetailsNo response FastAPI Version0.100.0 Python VersionPython 3.10.11 Additional ContextI initially thought this was an issue on Pydantic, and i even opend an issue But as explained there, the computed field appears when using |
Beta Was this translation helpful? Give feedback.
Replies: 5 comments 20 replies
-
|
|
Beta Was this translation helpful? Give feedback.
-
|
@tiangolo is already aware of this. This will shortly be supported. |
Beta Was this translation helpful? Give feedback.
-
and not in the response of |
Beta Was this translation helpful? Give feedback.
-
Are you using |
Beta Was this translation helpful? Give feedback.
-
|
Regardless of |
Beta Was this translation helpful? Give feedback.
-
|
Here I worked around this issue in version 0.115.11 as follows: class StudentGrades(pydantic.BaseModel):
english: int
history: int
geography: int
grade: float = Field(
default_factory=lambda data: (data['english'] + data['history'] + data['geography']) / 3,
) |
Beta Was this translation helpful? Give feedback.
-
|
@danielborges93 example: |
Beta Was this translation helpful? Give feedback.
-
|
In the API route self.response_field = create_response_field(
name=response_name,
type_=self.response_model,
# TODO: This should actually set mode='serialization', just, that changes the schemas
# mode="serialization",
mode="validation",
)Is it possible |
Beta Was this translation helpful? Give feedback.
-
|
Yep, that was the change in the internal code ...plus some other thousand lines of test updates. |
Beta Was this translation helpful? Give feedback.
-
|
|
Beta Was this translation helpful? Give feedback.
-
|
It has been a year, what is the current status? |
Beta Was this translation helpful? Give feedback.
-
|
Tested against |
Beta Was this translation helpful? Give feedback.
-
|
Current PRs addressing this issue:
|
Beta Was this translation helpful? Give feedback.
-
|
A temporary workaround for this issue: #10697 (comment) |
Beta Was this translation helpful? Give feedback.
-
With So, it seems it is not a workaround. |
Beta Was this translation helpful? Give feedback.
-
|
just ran into the same issue, the workaround with json_schema_mode_override=serialization didn't work for me either. What did work was to manually add the property: def json_schema_add_computed(schema):
schema['properties']['my_computed_field'] = ...
...
model_config = ConfigDict(json_schema_extra=json_schema_add_computed)I wonder if the schema errors are caused by setting |
Beta Was this translation helpful? Give feedback.
-
|
In my case it was a matter of the order of the annotations. The @property
@computed_field
def some_field(self):
return NoneThis is correct: @computed_field
@property
def some_field(self):
return None |
Beta Was this translation helpful? Give feedback.
-
|
@mattzque I agree, I also believe this is related to |
Beta Was this translation helpful? Give feedback.
@tiangolo is already aware of this. This will shortly be supported.