new example

Author: pcrespov

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

@@ -26,6 +26,7 @@ class LicensedItemRpcGet(BaseModel):
     pricing_plan_id: PricingPlanId
     created_at: datetime
     modified_at: datetime
+
     model_config = ConfigDict(
         json_schema_extra={
             "examples": [
@@ -76,21 +77,33 @@ class LicensedItemRestGet(OutputSchema):
     created_at: datetime
     modified_at: datetime
 
-    model_config = ConfigDict(
-        json_schema_extra={
-            "examples": [
-                {
-                    "licensed_item_id": "0362b88b-91f8-4b41-867c-35544ad1f7a1",
-                    "display_name": "best-model",
-                    "licensed_resource_type": f"{LicensedResourceType.VIP_MODEL}",
-                    "licensed_resource_data": cast(JsonDict, VIP_DETAILS_EXAMPLE),
-                    "pricing_plan_id": "15",
-                    "created_at": "2024-12-12 09:59:26.422140",
-                    "modified_at": "2024-12-12 09:59:26.422140",
-                }
-            ]
-        }
-    )
+    @staticmethod
+    def _update_json_schema_extra(schema: JsonDict) -> None:
+        schema.update(
+            {
+                "examples": [
+                    {
+                        "licensedItemId": "0362b88b-91f8-4b41-867c-35544ad1f7a1",
+                        "displayName": "my best model",
+                        "licensedResourceName": "best-model",
+                        "licensedResourceType": f"{LicensedResourceType.VIP_MODEL}",
+                        "licensedResourceData": cast(
+                            JsonDict,
+                            {
+                                "categoryId": "HumanWholeBody",
+                                "categoryDisplay": "Humans",
+                                "source": VIP_DETAILS_EXAMPLE,
+                            },
+                        ),
+                        "pricingPlanId": "15",
+                        "createdAt": "2024-12-12 09:59:26.422140",
+                        "modifiedAt": "2024-12-12 09:59:26.422140",
+                    }
+                ]
+            }
+        )
+
+    model_config = ConfigDict(json_schema_extra=_update_json_schema_extra)
 
     @classmethod
     def from_domain_model(cls, item: LicensedItem) -> Self:

packages/models-library/src/models_library/licenses.py

@@ -26,7 +26,7 @@ class LicensedResourceType(StrAutoEnum):
     "age": "34 years",
     "weight": "70.2 Kg",
     "height": "1.77 m",
-    "data": "2015-03-01",
+    "date": "2015-03-01",
     "ethnicity": "Caucasian",
     "functionality": "Static",
     "additional_field": "allowed",
@@ -55,7 +55,7 @@ class FeaturesDict(TypedDict):
     "license_version": "custom value",
     "protection": "custom value",
     "available_from_url": "custom value",
-    "additional_field": "allowed",
+    "additional_field": "trimmed if rest",
 }
 
 

services/web/server/tests/unit/with_dbs/04/licenses/test_licensed_items_rest.py

@@ -46,8 +46,13 @@ async def test_licensed_items_listing(
         licensed_resource_name="Model A",
         licensed_resource_type=LicensedResourceType.VIP_MODEL,
         pricing_plan_id=pricing_plan_id,
-        licensed_resource_data=VIP_DETAILS_EXAMPLE,
+        licensed_resource_data={
+            "categoryId": "HumanWholeBody",
+            "categoryDisplay": "Humans",
+            "source": VIP_DETAILS_EXAMPLE,
+        },
     )
+
     _licensed_item_id = licensed_item_db.licensed_item_id
 
     # list
@@ -56,12 +61,14 @@ async def test_licensed_items_listing(
     data, _ = await assert_status(resp, status.HTTP_200_OK)
     assert len(data) == 1
     assert LicensedItemRestGet(**data[0])
-    assert data[0]["licensedResourceData"][
-        "additionalField"
-    ]  # <-- Testing nested camel case
-    assert data[0]["licensedResourceData"]["features"][
-        "additionalField"
-    ]  # <-- Testing nested camel case
+
+    # <-- Testing nested camel case
+    source = data[0]["licensedResourceData"]["source"]
+    assert source["license"]
+
+    # Testing trimmed
+    assert "additionalField" not in source["features"]
+    assert "additional_field" not in source["features"]
 
     # get
     url = client.app.router["get_licensed_item"].url_for(
@@ -77,17 +84,13 @@ def mock_licensed_items_purchase_functions(mocker: MockerFixture) -> tuple:
     mock_wallet_credits = mocker.patch(
         "simcore_service_webserver.licenses._licensed_items_service.get_wallet_with_available_credits_by_user_and_wallet",
         spec=True,
-        return_value=WalletGetWithAvailableCredits.model_validate(
-            WalletGetWithAvailableCredits.model_config["json_schema_extra"]["examples"][
-                0
-            ]
-        ),
+        return_value=WalletGetWithAvailableCredits.model_json_schema()["examples"][0],
     )
     mock_get_pricing_unit = mocker.patch(
         "simcore_service_webserver.licenses._licensed_items_service.get_pricing_plan_unit",
         spec=True,
         return_value=PricingUnitGet.model_validate(
-            PricingUnitGet.model_config["json_schema_extra"]["examples"][0]
+            PricingUnitGet.model_json_schema()["examples"][0]
         ),
     )
     mock_create_licensed_item_purchase = mocker.patch(
@@ -121,7 +124,11 @@ async def test_licensed_items_purchase(
         licensed_resource_name="Model A",
         licensed_resource_type=LicensedResourceType.VIP_MODEL,
         pricing_plan_id=pricing_plan_id,
-        licensed_resource_data=VIP_DETAILS_EXAMPLE,
+        licensed_resource_data={
+            "categoryId": "HumanWholeBody",
+            "categoryDisplay": "Humans",
+            "source": VIP_DETAILS_EXAMPLE,
+        },
     )
     _licensed_item_id = licensed_item_db.licensed_item_id