Catalog entrypoints response model excludes None fields

Author: pcrespov

services/catalog/src/simcore_service_catalog/api/routes/services.py

@@ -26,8 +26,18 @@
 
 ServicesSelection = Set[Tuple[str, str]]
 
+# These are equivalent to pydantic export models but for responses
+# SEE https://pydantic-docs.helpmanual.io/usage/exporting_models/#modeldict
+# SEE https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter
+RESPONSE_MODEL_POLICY = {
+    "response_model_by_alias": True,
+    "response_model_exclude_unset": False,
+    "response_model_exclude_defaults": False,
+    "response_model_exclude_none": True,
+}
 
-@router.get("", response_model=List[ServiceOut])
+
+@router.get("", response_model=List[ServiceOut], **RESPONSE_MODEL_POLICY)
 async def list_services(
     # pylint: disable=too-many-arguments
     user_id: PositiveInt,
@@ -150,7 +160,11 @@ async def list_services(
     return detailed_services
 
 
-@router.get("/{service_key:path}/{service_version}", response_model=ServiceOut)
+@router.get(
+    "/{service_key:path}/{service_version}",
+    response_model=ServiceOut,
+    **RESPONSE_MODEL_POLICY,
+)
 async def get_service(
     # pylint: disable=too-many-arguments
     user_id: int,
@@ -220,7 +234,11 @@ async def get_service(
     return service
 
 
-@router.patch("/{service_key:path}/{service_version}", response_model=ServiceOut)
+@router.patch(
+    "/{service_key:path}/{service_version}",
+    response_model=ServiceOut,
+    **RESPONSE_MODEL_POLICY,
+)
 async def modify_service(
     # pylint: disable=too-many-arguments
     user_id: int,

services/web/server/src/simcore_service_webserver/catalog_api_handlers.py

@@ -36,11 +36,11 @@
 
 
 # SEE https://pydantic-docs.helpmanual.io/usage/exporting_models/#modeldict
-EXPORT_POLICY = {
+RESPONSE_MODEL_POLICY = {
     "by_alias": True,
     "exclude_unset": False,
     "exclude_defaults": False,
-    "exclude_none": False,
+    "exclude_none": True,
 }
 
 routes = RouteTableDef()
@@ -151,7 +151,7 @@ async def list_service_inputs_handler(request: Request):
 
     # format response
     enveloped: str = json_dumps(
-        {"data": [m.dict(**EXPORT_POLICY) for m in response_model]}
+        {"data": [m.dict(**RESPONSE_MODEL_POLICY) for m in response_model]}
     )
     return web.Response(text=enveloped, content_type="application/json")
 
@@ -172,7 +172,7 @@ async def get_service_input_handler(request: Request):
     )
 
     # format response
-    enveloped: str = json_dumps({"data": response_model.dict(**EXPORT_POLICY)})
+    enveloped: str = json_dumps({"data": response_model.dict(**RESPONSE_MODEL_POLICY)})
     return web.Response(text=enveloped, content_type="application/json")
 
 
@@ -219,7 +219,7 @@ async def list_service_outputs_handler(request: Request):
 
     # format response
     enveloped: str = json_dumps(
-        {"data": [m.dict(**EXPORT_POLICY) for m in response_model]}
+        {"data": [m.dict(**RESPONSE_MODEL_POLICY) for m in response_model]}
     )
     return web.Response(text=enveloped, content_type="application/json")
 
@@ -242,7 +242,7 @@ async def get_service_output_handler(request: Request):
     )
 
     # format response
-    enveloped: str = json_dumps({"data": response_model.dict(**EXPORT_POLICY)})
+    enveloped: str = json_dumps({"data": response_model.dict(**RESPONSE_MODEL_POLICY)})
     return web.Response(text=enveloped, content_type="application/json")
 
 
@@ -321,7 +321,7 @@ async def list_services(ctx: _RequestContext):
         ctx.app, ctx.user_id, ctx.product_name, only_key_versions=False
     )
     for service in services:
-        replace_service_input_outputs(service, **EXPORT_POLICY)
+        replace_service_input_outputs(service, **RESPONSE_MODEL_POLICY)
     return services
 
 
@@ -331,7 +331,7 @@ async def get_service(
     service = await catalog_client.get_service(
         ctx.app, ctx.user_id, service_key, service_version, ctx.product_name
     )
-    replace_service_input_outputs(service, **EXPORT_POLICY)
+    replace_service_input_outputs(service, **RESPONSE_MODEL_POLICY)
     return service
 
 
@@ -349,7 +349,7 @@ async def update_service(
         ctx.product_name,
         update_data,
     )
-    replace_service_input_outputs(service, **EXPORT_POLICY)
+    replace_service_input_outputs(service, **RESPONSE_MODEL_POLICY)
     return service
 
 

services/web/server/tests/unit/isolated/test_catalog_api_models.py

@@ -7,7 +7,7 @@
 from pprint import pformat
 
 import pytest
-from simcore_service_webserver.catalog_api_handlers import EXPORT_POLICY
+from simcore_service_webserver.catalog_api_handlers import RESPONSE_MODEL_POLICY
 from simcore_service_webserver.catalog_api_models import (
     ServiceInputApiOut,
     ServiceOutputApiOut,
@@ -29,7 +29,7 @@ def test_webserver_catalog_api_models(model_cls, model_cls_examples):
         assert model_instance, f"Failed with {name}"
 
         # tests export policy w/o errors
-        data = model_instance.dict(**EXPORT_POLICY)
+        data = model_instance.dict(**RESPONSE_MODEL_POLICY)
         assert model_cls(**data) == model_instance
 
 
@@ -75,7 +75,7 @@ def test_from_catalog_to_webapi_service():
     }
 
     webapi_service = deepcopy(catalog_service)
-    replace_service_input_outputs(webapi_service, **EXPORT_POLICY)
+    replace_service_input_outputs(webapi_service, **RESPONSE_MODEL_POLICY)
 
     # TODO: dev checks... generalize
     assert webapi_service["outputs"]["outFile"]["unit"] is None