From ceedfccde0951dfd445015b39c5dae66ad3897dc Mon Sep 17 00:00:00 2001 From: William Hayes Date: Sat, 13 Jun 2020 09:23:29 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Document=20additional=20paramete?= =?UTF-8?q?rs=20for=20response=5Fmodel=20(#1427)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Documented additional parameters These are included in a recent PR (https://github.com/tiangolo/fastapi/pull/1166) but not in the docs yet. * response_model_exclude_none * response_model_exclude_defaults * 📝 Update note about response_model_exclude_defaults and response_model_exclude_none Co-authored-by: Sebastián Ramírez --- docs/en/docs/tutorial/response-model.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/en/docs/tutorial/response-model.md b/docs/en/docs/tutorial/response-model.md index 9dd0b6dee..dd76eca6e 100644 --- a/docs/en/docs/tutorial/response-model.md +++ b/docs/en/docs/tutorial/response-model.md @@ -124,6 +124,14 @@ So, if you send a request to that *path operation* for the item with ID `foo`, t !!! info FastAPI uses Pydantic model's `.dict()` with its `exclude_unset` parameter to achieve this. +!!! info + You can also use: + + * `response_model_exclude_defaults=True` + * `response_model_exclude_none=True` + + as described in the Pydantic docs for `exclude_defaults` and `exclude_none`. + #### Data with values for fields with defaults But if your data has values for the model's fields with default values, like the item with ID `bar`: