[python-fastapi] exclude unset response fields

Exclude unset fields when marshalling api endpoint response bodies.

Author: mgoltzsche

modules/openapi-generator/src/main/resources/python-fastapi/api.mustache

@@ -52,6 +52,7 @@ for _, name, _ in pkgutil.iter_modules(ns_pkg.__path__, ns_pkg.__name__ + "."):
     description = "{{.}}",
     {{/description}}
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def {{operationId}}(
     {{#allParams}}

samples/server/petstore/python-fastapi/src/openapi_server/apis/fake_api.py

@@ -44,6 +44,7 @@
     tags=["fake"],
     summary="test query parameter default value",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def fake_query_param_default(
     has_default: Annotated[Optional[StrictStr], Field(description="has default value")] = Query('Hello World', description="has default value", alias="hasDefault"),

samples/server/petstore/python-fastapi/src/openapi_server/apis/pet_api.py

@@ -46,6 +46,7 @@
     tags=["pet"],
     summary="Add a new pet to the store",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def add_pet(
     pet: Annotated[Pet, Field(description="Pet object that needs to be added to the store")] = Body(None, description="Pet object that needs to be added to the store"),
@@ -67,6 +68,7 @@ async def add_pet(
     tags=["pet"],
     summary="Deletes a pet",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def delete_pet(
     petId: Annotated[StrictInt, Field(description="Pet id to delete")] = Path(..., description="Pet id to delete"),
@@ -90,6 +92,7 @@ async def delete_pet(
     tags=["pet"],
     summary="Finds Pets by status",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def find_pets_by_status(
     status: Annotated[List[StrictStr], Field(description="Status values that need to be considered for filter")] = Query(None, description="Status values that need to be considered for filter", alias="status"),
@@ -112,6 +115,7 @@ async def find_pets_by_status(
     tags=["pet"],
     summary="Finds Pets by tags",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def find_pets_by_tags(
     tags: Annotated[List[StrictStr], Field(description="Tags to filter by")] = Query(None, description="Tags to filter by", alias="tags"),
@@ -135,6 +139,7 @@ async def find_pets_by_tags(
     tags=["pet"],
     summary="Find pet by ID",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def get_pet_by_id(
     petId: Annotated[StrictInt, Field(description="ID of pet to return")] = Path(..., description="ID of pet to return"),
@@ -159,6 +164,7 @@ async def get_pet_by_id(
     tags=["pet"],
     summary="Update an existing pet",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def update_pet(
     pet: Annotated[Pet, Field(description="Pet object that needs to be added to the store")] = Body(None, description="Pet object that needs to be added to the store"),
@@ -180,6 +186,7 @@ async def update_pet(
     tags=["pet"],
     summary="Updates a pet in the store with form data",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def update_pet_with_form(
     petId: Annotated[StrictInt, Field(description="ID of pet that needs to be updated")] = Path(..., description="ID of pet that needs to be updated"),
@@ -203,6 +210,7 @@ async def update_pet_with_form(
     tags=["pet"],
     summary="uploads an image",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def upload_file(
     petId: Annotated[StrictInt, Field(description="ID of pet to update")] = Path(..., description="ID of pet to update"),

samples/server/petstore/python-fastapi/src/openapi_server/apis/store_api.py

@@ -45,6 +45,7 @@
     tags=["store"],
     summary="Delete purchase order by ID",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def delete_order(
     orderId: Annotated[StrictStr, Field(description="ID of the order that needs to be deleted")] = Path(..., description="ID of the order that needs to be deleted"),
@@ -63,6 +64,7 @@ async def delete_order(
     tags=["store"],
     summary="Returns pet inventories by status",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def get_inventory(
     token_api_key: TokenModel = Security(
@@ -85,6 +87,7 @@ async def get_inventory(
     tags=["store"],
     summary="Find purchase order by ID",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def get_order_by_id(
     orderId: Annotated[int, Field(le=5, strict=True, ge=1, description="ID of pet that needs to be fetched")] = Path(..., description="ID of pet that needs to be fetched", ge=1, le=5),
@@ -104,6 +107,7 @@ async def get_order_by_id(
     tags=["store"],
     summary="Place an order for a pet",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def place_order(
     order: Annotated[Order, Field(description="order placed for purchasing the pet")] = Body(None, description="order placed for purchasing the pet"),

samples/server/petstore/python-fastapi/src/openapi_server/apis/user_api.py

@@ -44,6 +44,7 @@
     tags=["user"],
     summary="Create user",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def create_user(
     user: Annotated[User, Field(description="Created user object")] = Body(None, description="Created user object"),
@@ -65,6 +66,7 @@ async def create_user(
     tags=["user"],
     summary="Creates list of users with given input array",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def create_users_with_array_input(
     user: Annotated[List[User], Field(description="List of user object")] = Body(None, description="List of user object"),
@@ -86,6 +88,7 @@ async def create_users_with_array_input(
     tags=["user"],
     summary="Creates list of users with given input array",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def create_users_with_list_input(
     user: Annotated[List[User], Field(description="List of user object")] = Body(None, description="List of user object"),
@@ -108,6 +111,7 @@ async def create_users_with_list_input(
     tags=["user"],
     summary="Delete user",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def delete_user(
     username: Annotated[StrictStr, Field(description="The name that needs to be deleted")] = Path(..., description="The name that needs to be deleted"),
@@ -131,6 +135,7 @@ async def delete_user(
     tags=["user"],
     summary="Get user by user name",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def get_user_by_name(
     username: Annotated[StrictStr, Field(description="The name that needs to be fetched. Use user1 for testing.")] = Path(..., description="The name that needs to be fetched. Use user1 for testing."),
@@ -150,6 +155,7 @@ async def get_user_by_name(
     tags=["user"],
     summary="Logs user into the system",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def login_user(
     username: Annotated[str, Field(strict=True, description="The user name for login")] = Query(None, description="The user name for login", alias="username", regex=r"/^[a-zA-Z0-9]+[a-zA-Z0-9\.\-_]*[a-zA-Z0-9]+$/"),
@@ -169,6 +175,7 @@ async def login_user(
     tags=["user"],
     summary="Logs out current logged in user session",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def logout_user(
     token_api_key: TokenModel = Security(
@@ -190,6 +197,7 @@ async def logout_user(
     tags=["user"],
     summary="Updated user",
     response_model_by_alias=True,
+    response_model_exclude_unset=True,
 )
 async def update_user(
     username: Annotated[StrictStr, Field(description="name that need to be deleted")] = Path(..., description="name that need to be deleted"),