openapi specs

Author: matusdrobuliak66

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

@@ -1,10 +1,8 @@
 from datetime import datetime
-from typing import NamedTuple
+from typing import Any, NamedTuple
 
-from common_library.dict_tools import remap_keys
 from models_library.licensed_items import (
     VIP_DETAILS_EXAMPLE,
-    LicensedItemDB,
     LicensedItemID,
     LicensedResourceType,
 )
@@ -20,21 +18,21 @@
 
 class LicensedItemRpcGet(BaseModel):
     licensed_item_id: LicensedItemID
-    display_name: str
+    licensed_resource_name: str
     licensed_resource_type: LicensedResourceType
+    licensed_resource_data: dict[str, Any]
     pricing_plan_id: PricingPlanId
-    licensed_resource_type_details: dict[str, Any]
     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_name": "best-model",
                     "licensed_resource_type": f"{LicensedResourceType.VIP_MODEL}",
+                    "licensed_resource_data": VIP_DETAILS_EXAMPLE,
                     "pricing_plan_id": "15",
-                    "licensed_resource_type_details": VIP_DETAILS_EXAMPLE,
                     "created_at": "2024-12-12 09:59:26.422140",
                     "modified_at": "2024-12-12 09:59:26.422140",
                 }
@@ -53,52 +51,30 @@ class LicensedItemRpcGetPage(NamedTuple):
 
 class LicensedItemRestGet(OutputSchema):
     licensed_item_id: LicensedItemID
-    display_name: str
+    licensed_resource_name: str
     licensed_resource_type: LicensedResourceType
-    pricing_plan_id: PricingPlanId
-    licensed_resource_type_details: Annotated[
+    licensed_resource_data: Annotated[
         dict[str, Any], AfterValidator(to_camel_recursive)
     ]
+    pricing_plan_id: PricingPlanId
     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_name": "best-model",
                     "licensed_resource_type": f"{LicensedResourceType.VIP_MODEL}",
+                    "licensed_resource_data": VIP_DETAILS_EXAMPLE,
                     "pricing_plan_id": "15",
-                    "licensed_resource_type_details": VIP_DETAILS_EXAMPLE,
                     "created_at": "2024-12-12 09:59:26.422140",
                     "modified_at": "2024-12-12 09:59:26.422140",
                 }
             ]
         }
     )
 
-    @classmethod
-    def from_domain_model(cls, licensed_item_db: LicensedItemDB) -> Self:
-        return cls.model_validate(
-            remap_keys(
-                licensed_item_db.model_dump(
-                    include={
-                        "licensed_item_id",
-                        "licensed_resource_name",
-                        "license_key",
-                        "pricing_plan_id",
-                        "created",
-                        "modified",
-                    }
-                ),
-                {
-                    "licensed_resource_name": "name",
-                    "created": "created_at",
-                    "modified": "modified_at",
-                },
-            )
-        )
-
 
 class LicensedItemRestGetPage(NamedTuple):
     items: list[LicensedItemRestGet]

services/api-server/src/simcore_service_api_server/models/schemas/model_adapter.py

@@ -137,10 +137,10 @@ class ServicePricingPlanGetLegacy(BaseModel):
 
 class LicensedItemGet(BaseModel):
     licensed_item_id: LicensedItemID
-    display_name: Annotated[str, Field(alias="display_name")]
+    licensed_resource_name: str
     licensed_resource_type: LicensedResourceType
+    licensed_resource_data: dict[str, Any]
     pricing_plan_id: PricingPlanId
-    licensed_resource_type_details: dict[str, Any]
     created_at: datetime
     modified_at: datetime
     model_config = ConfigDict(

services/api-server/src/simcore_service_api_server/services_rpc/wb_api_server.py

@@ -58,10 +58,10 @@ def _create_licensed_items_get_page(
         [
             LicensedItemGet(
                 licensed_item_id=elm.licensed_item_id,
-                display_name=elm.display_name,
+                licensed_resource_name=elm.licensed_resource_name,
                 licensed_resource_type=elm.licensed_resource_type,
+                licensed_resource_data=elm.licensed_resource_data,
                 pricing_plan_id=elm.pricing_plan_id,
-                licensed_resource_type_details=elm.licensed_resource_type_details,
                 created_at=elm.created_at,
                 modified_at=elm.modified_at,
             )

services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml

@@ -10695,19 +10695,19 @@ components:
           type: string
           format: uuid
           title: Licenseditemid
-        displayName:
+        licensedResourceName:
           type: string
-          title: Displayname
+          title: Licensedresourcename
         licensedResourceType:
           $ref: '#/components/schemas/LicensedResourceType'
+        licensedResourceData:
+          type: object
+          title: Licensedresourcedata
         pricingPlanId:
           type: integer
           exclusiveMinimum: true
           title: Pricingplanid
           minimum: 0
-        licensedResourceTypeDetails:
-          type: object
-          title: Licensedresourcetypedetails
         createdAt:
           type: string
           format: date-time
@@ -10719,10 +10719,10 @@ components:
       type: object
       required:
       - licensedItemId
-      - displayName
+      - licensedResourceName
       - licensedResourceType
+      - licensedResourceData
       - pricingPlanId
-      - licensedResourceTypeDetails
       - createdAt
       - modifiedAt
       title: LicensedItemRestGet

services/web/server/src/simcore_service_webserver/licenses/_common/models.py

@@ -31,21 +31,21 @@
 
 class LicensedItem(BaseModel):
     licensed_item_id: LicensedItemID
-    display_name: str
+    licensed_resource_name: str
     licensed_resource_type: LicensedResourceType
+    licensed_resource_data: dict[str, Any]
     pricing_plan_id: PricingPlanId
-    licensed_resource_type_details: dict[str, Any]
     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_name": "best-model",
                     "licensed_resource_type": f"{LicensedResourceType.VIP_MODEL}",
+                    "licensed_resource_data": VIP_DETAILS_EXAMPLE,
                     "pricing_plan_id": "15",
-                    "licensed_resource_type_details": VIP_DETAILS_EXAMPLE,
                     "created_at": "2024-12-12 09:59:26.422140",
                     "modified_at": "2024-12-12 09:59:26.422140",
                 }

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

@@ -43,6 +43,7 @@ async def create(
     *,
     licensed_resource_name: str,
     licensed_resource_type: LicensedResourceType,
+    licensed_resource_data: dict | None,
     product_name: ProductName | None,
     pricing_plan_id: PricingPlanId | None,
 ) -> LicensedItemDB:
@@ -54,7 +55,7 @@ async def create(
                 licensed_resource_type=licensed_resource_type,
                 pricing_plan_id=pricing_plan_id,
                 product_name=product_name,
-                licensed_resource_type_details=licensed_resource_type_details,
+                licensed_resource_data=licensed_resource_data,
                 created=func.now(),
                 modified=func.now(),
             )

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

@@ -61,10 +61,10 @@ async def list_licensed_items(request: web.Request):
         items=[
             LicensedItemRestGet.model_construct(
                 licensed_item_id=licensed_item.licensed_item_id,
-                display_name=licensed_item.display_name,
+                licensed_resource_name=licensed_item.licensed_resource_name,
                 licensed_resource_type=licensed_item.licensed_resource_type,
+                licensed_resource_data=licensed_item.licensed_resource_data,
                 pricing_plan_id=licensed_item.pricing_plan_id,
-                licensed_resource_type_details=licensed_item.licensed_resource_type_details,
                 created_at=licensed_item.created_at,
                 modified_at=licensed_item.modified_at,
             )
@@ -105,10 +105,10 @@ async def get_licensed_item(request: web.Request):
     )
     licensed_item_get = LicensedItemRestGet.model_construct(
         licensed_item_id=licensed_item.licensed_item_id,
-        display_name=licensed_item.display_name,
+        licensed_resource_name=licensed_item.licensed_resource_name,
         licensed_resource_type=licensed_item.licensed_resource_type,
         pricing_plan_id=licensed_item.pricing_plan_id,
-        licensed_resource_type_details=licensed_item.licensed_resource_type_details,
+        licensed_resource_data=licensed_item.licensed_resource_data,
         created_at=licensed_item.created_at,
         modified_at=licensed_item.modified_at,
     )

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

@@ -40,10 +40,10 @@ async def get_licensed_item(
     )
     return LicensedItem.model_construct(
         licensed_item_id=licensed_item_db.licensed_item_id,
-        display_name=licensed_item_db.display_name,
+        licensed_resource_name=licensed_item_db.licensed_resource_name,
         licensed_resource_type=licensed_item_db.licensed_resource_type,
+        licensed_resource_data=licensed_item_db.licensed_resource_data,
         pricing_plan_id=licensed_item_db.pricing_plan_id,
-        licensed_resource_type_details=licensed_item_db.licensed_resource_type_details,
         created_at=licensed_item_db.created,
         modified_at=licensed_item_db.modified,
     )
@@ -64,10 +64,10 @@ async def list_licensed_items(
         items=[
             LicensedItem.model_construct(
                 licensed_item_id=licensed_item_db.licensed_item_id,
-                display_name=licensed_item_db.display_name,
+                licensed_resource_name=licensed_item_db.licensed_resource_name,
                 licensed_resource_type=licensed_item_db.licensed_resource_type,
+                licensed_resource_data=licensed_item_db.licensed_resource_data,
                 pricing_plan_id=licensed_item_db.pricing_plan_id,
-                licensed_resource_type_details=licensed_item_db.licensed_resource_type_details,
                 created_at=licensed_item_db.created,
                 modified_at=licensed_item_db.modified,
             )

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

@@ -47,18 +47,18 @@ async def get_licensed_items(
             product_name=product_name,
             offset=offset,
             limit=limit,
-            order_by=OrderBy(field=IDStr("display_name")),
+            order_by=OrderBy(field=IDStr("licensed_resource_name")),
         )
     )
 
     licensed_item_get_page: LicensedItemRpcGetPage = LicensedItemRpcGetPage(
         items=[
             LicensedItemRpcGet.model_construct(
                 licensed_item_id=licensed_item.licensed_item_id,
-                display_name=licensed_item.display_name,
+                licensed_resource_name=licensed_item.licensed_resource_name,
                 licensed_resource_type=licensed_item.licensed_resource_type,
+                licensed_resource_data=licensed_item.licensed_resource_data,
                 pricing_plan_id=licensed_item.pricing_plan_id,
-                licensed_resource_type_details=licensed_item.licensed_resource_type_details,
                 created_at=licensed_item.created_at,
                 modified_at=licensed_item.modified_at,
             )

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

@@ -50,7 +50,7 @@ async def test_licensed_items_db_crud(
         licensed_resource_name="Model A",
         licensed_resource_type=LicensedResourceType.VIP_MODEL,
         pricing_plan_id=pricing_plan_id,
-        licensed_resource_type_details=VIP_DETAILS_EXAMPLE,
+        licensed_resource_data=VIP_DETAILS_EXAMPLE,
     )
     _licensed_item_id = licensed_item_db.licensed_item_id
 
@@ -68,8 +68,8 @@ async def test_licensed_items_db_crud(
         licensed_item_id=_licensed_item_id,
         product_name=osparc_product_name,
     )
-    assert licensed_item_db.licensed_resource_display_name == "Model A"
-    assert isinstance(licensed_item_db.licensed_resource_type_details, dict)
+    assert licensed_item_db.licensed_resource_name == "Model A"
+    assert isinstance(licensed_item_db.licensed_resource_data, dict)
 
     await _licensed_items_repository.update(
         client.app,
@@ -116,6 +116,7 @@ async def test_licensed_items_db_trash(
             product_name=osparc_product_name,
             licensed_resource_name=name,
             licensed_resource_type=LicensedResourceType.VIP_MODEL,
+            licensed_resource_data=None,
             pricing_plan_id=pricing_plan_id,
         )
         licensed_item_ids.append(licensed_item_db.licensed_item_id)