@odeimaiz: returns id

Author: pcrespov

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

@@ -53,6 +53,7 @@ class LicensedItemRpcGetPage(NamedTuple):
 
 
 class _ItisVipRestData(OutputSchema):
+    id: int
     description: str
     thumbnail: str
     features: FeaturesDict  # NOTE: here there is a bit of coupling with domain model
@@ -85,7 +86,6 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
                     {
                         "licensedItemId": "0362b88b-91f8-4b41-867c-35544ad1f7a1",
                         "displayName": "my best model",
-                        "licensedResourceName": "best-model",
                         "licensedResourceType": f"{LicensedResourceType.VIP_MODEL}",
                         "licensedResourceData": cast(
                             JsonDict,

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

@@ -53,7 +53,7 @@ class FeaturesDict(TypedDict):
     "doi": "10.1000/xyz123",
     "license_key": "ABC123XYZ",
     "license_version": "1.0",
-    "protection": "Encrypted",
+    "protection": "Code",
     "available_from_url": "https://example.com/download",
     "additional_field": "trimmed if rest",
 }

packages/models-library/tests/test_licenses.py

@@ -1,20 +1,35 @@
 from models_library.api_schemas_webserver.licensed_items import LicensedItemRestGet
 from models_library.licenses import LicensedItem
+from pydantic import ConfigDict
 
 
 def test_licensed_item_from_domain_model():
     for example in LicensedItem.model_json_schema()["examples"]:
         item = LicensedItem.model_validate(example)
 
-        payload = LicensedItemRestGet.from_domain_model(item)
+        got = LicensedItemRestGet.from_domain_model(item)
 
-        assert item.display_name == payload.display_name
+        assert item.display_name == got.display_name
 
         # nullable doi
         assert (
-            payload.licensed_resource_data.source.doi
+            got.licensed_resource_data.source.doi
             == item.licensed_resource_data["source"]["doi"]
         )
 
         # date is required
-        assert payload.licensed_resource_data.source.features["date"]
+        assert got.licensed_resource_data.source.features["date"]
+
+        #
+        assert (
+            got.licensed_resource_data.source.id
+            == item.licensed_resource_data["source"]["id"]
+        )
+
+
+def test_strict_check_of_examples():
+    class TestLicensedItemRestGet(LicensedItemRestGet):
+        model_config = ConfigDict(extra="forbid")
+
+    for example in LicensedItemRestGet.model_json_schema()["examples"]:
+        TestLicensedItemRestGet.model_validate(example)

services/web/server/src/simcore_service_webserver/licenses/_itis_vip_models.py

@@ -2,15 +2,17 @@
 from typing import Annotated, Any, Literal, NamedTuple, TypeAlias
 
 from models_library.basic_types import IDStr
-from models_library.licenses import FeaturesDict
+from models_library.licenses import VIP_DETAILS_EXAMPLE, FeaturesDict
 from pydantic import (
     BaseModel,
     BeforeValidator,
+    ConfigDict,
     Field,
     HttpUrl,
     StringConstraints,
     TypeAdapter,
 )
+from pydantic.config import JsonDict
 
 _max_str_adapter: TypeAdapter[str] = TypeAdapter(
     Annotated[str, StringConstraints(strip_whitespace=True, max_length=1_000)]
@@ -53,6 +55,31 @@ class ItisVipData(BaseModel):
     protection: Annotated[Literal["Code", "PayPal"], Field(alias="Protection")]
     available_from_url: Annotated[HttpUrl | None, Field(alias="AvailableFromURL")]
 
+    @staticmethod
+    def _update_json_schema_extra(schema: JsonDict) -> None:
+        schema.update(
+            {
+                "examples": [
+                    # complete
+                    VIP_DETAILS_EXAMPLE,
+                    # minimal
+                    {
+                        "id": 1,
+                        "description": "A detailed description of the VIP model",
+                        "thumbnail": "https://example.com/thumbnail.jpg",
+                        "features": {"date": "2013-02-01"},
+                        "doi": "null",
+                        "license_key": "ABC123XYZ",
+                        "license_version": "1.0",
+                        "protection": "Code",
+                        "available_from_url": "null",
+                    },
+                ]
+            }
+        )
+
+    model_config = ConfigDict(json_schema_extra=_update_json_schema_extra)
+
 
 class ItisVipResourceData(BaseModel):
     category_id: IDStr