cleanup

Author: pcrespov

api/specs/web-server/_products.py

@@ -11,8 +11,8 @@
 from models_library.api_schemas_webserver.product import (
     GenerateInvitation,
     GetCreditPrice,
-    GetProduct,
     InvitationGenerated,
+    ProductGet,
     UpdateProductTemplate,
 )
 from models_library.generics import Envelope
@@ -40,7 +40,8 @@ async def get_current_product_price():
 
 @router.get(
     "/products/{product_name}",
-    response_model=Envelope[GetProduct],
+    response_model=Envelope[ProductGet],
+    description="NOTE: `/products/current` is used to define current project w/o naming it",
     tags=[
         "po",
     ],

packages/models-library/src/models_library/api_schemas_webserver/product.py

@@ -60,31 +60,34 @@ class UpdateProductTemplate(InputSchema):
     content: str
 
 
-class GetProduct(OutputSchema):
+class ProductGet(OutputSchema):
     name: ProductName
     display_name: str
-    short_name: str | None = Field(
-        default=None, description="Short display name for SMS"
-    )
-
-    vendor: dict | None = Field(default=None, description="vendor attributes")
-    issues: list[dict] | None = Field(
-        default=None, description="Reference to issues tracker"
-    )
-    manuals: list[dict] | None = Field(default=None, description="List of manuals")
-    support: list[dict] | None = Field(
-        default=None, description="List of support resources"
-    )
+    short_name: Annotated[
+        str | None, Field(description="Short display name for SMS")
+    ] = None
+
+    vendor: Annotated[dict | None, Field(description="vendor attributes")] = None
+    issues: Annotated[
+        list[dict] | None, Field(description="Reference to issues tracker")
+    ] = None
+    manuals: Annotated[list[dict] | None, Field(description="List of manuals")] = None
+    support: Annotated[
+        list[dict] | None, Field(description="List of support resources")
+    ] = None
 
     login_settings: dict
     max_open_studies_per_user: PositiveInt | None
     is_payment_enabled: bool
     credits_per_usd: NonNegativeDecimal | None
 
-    templates: list[GetProductTemplate] = Field(
-        default_factory=list,
-        description="List of templates available to this product for communications (e.g. emails, sms, etc)",
-    )
+    templates: Annotated[
+        list[GetProductTemplate],
+        Field(
+            description="List of templates available to this product for communications (e.g. emails, sms, etc)",
+            default_factory=list,
+        ),
+    ]
 
 
 ExtraCreditsUsdRangeInt: TypeAlias = Annotated[int, Field(ge=0, lt=500)]

services/web/server/src/simcore_service_webserver/products/_handlers.py

@@ -2,7 +2,7 @@
 from typing import Literal
 
 from aiohttp import web
-from models_library.api_schemas_webserver.product import GetCreditPrice, GetProduct
+from models_library.api_schemas_webserver.product import GetCreditPrice, ProductGet
 from models_library.basic_types import IDStr
 from models_library.rest_base import RequestParameters, StrictRequestParameters
 from models_library.users import UserID
@@ -69,9 +69,9 @@ async def _get_product(request: web.Request):
     except KeyError as err:
         raise web.HTTPNotFound(reason=f"{product_name=} not found") from err
 
-    assert "extra" in GetProduct.model_config  # nosec
-    assert GetProduct.model_config["extra"] == "ignore"  # nosec
-    data = GetProduct(**product.model_dump(), templates=[])
+    assert "extra" in ProductGet.model_config  # nosec
+    assert ProductGet.model_config["extra"] == "ignore"  # nosec
+    data = ProductGet(**product.model_dump(), templates=[])
     return envelope_json_response(data)