server

Author: pcrespov

api/specs/web-server/_catalog.py

@@ -3,8 +3,8 @@
 from fastapi import APIRouter, Depends
 from models_library.api_schemas_api_server.pricing_plans import ServicePricingPlanGet
 from models_library.api_schemas_webserver.catalog import (
+    CatalogLatestServiceGet,
     CatalogServiceGet,
-    CatalogServiceListItem,
     CatalogServiceUpdate,
     ServiceInputGet,
     ServiceInputKey,
@@ -34,10 +34,9 @@
 
 @router.get(
     "/catalog/services/-/latest",
-    response_model=Page[CatalogServiceListItem],
+    response_model=Page[CatalogLatestServiceGet],
 )
-def list_services_latest(_query: Annotated[ListServiceParams, Depends()]):
-    pass
+def list_services_latest(_query: Annotated[ListServiceParams, Depends()]): ...
 
 
 @router.get(

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

@@ -228,7 +228,7 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
 ServiceResourcesGet: TypeAlias = api_schemas_catalog_services.ServiceResourcesGet
 
 
-class CatalogServiceListItem(api_schemas_catalog_services.ServiceListItem):
+class CatalogLatestServiceGet(api_schemas_catalog_services.LatestServiceGet):
     inputs: ServiceInputsGetDict  # type: ignore[assignment]
     outputs: ServiceOutputsGetDict  # type: ignore[assignment]
 

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

@@ -2027,7 +2027,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Page_CatalogServiceListItem_'
+                $ref: '#/components/schemas/Page_CatalogLatestServiceGet_'
   /v0/catalog/services/{service_key}/{service_version}:
     get:
       tags:
@@ -7873,7 +7873,7 @@ components:
       - default
       - items
       title: BootOption
-    CatalogServiceGet:
+    CatalogLatestServiceGet:
       properties:
         key:
           type: string
@@ -7932,11 +7932,9 @@ components:
         inputs:
           type: object
           title: Inputs
-          description: inputs with extended information
         outputs:
           type: object
           title: Outputs
-          description: outputs with extended information
         bootOptions:
           anyOf:
           - type: object
@@ -7962,19 +7960,10 @@ components:
             type: array
           - type: 'null'
           title: Classifiers
-          default: []
         quality:
           type: object
           title: Quality
-          default: {}
-        history:
-          items:
-            $ref: '#/components/schemas/ServiceRelease'
-          type: array
-          title: History
-          description: history of releases for this service at this point in time,
-            starting from the newest to the oldest. It includes current release.
-          default: []
+      additionalProperties: false
       type: object
       required:
       - key
@@ -7988,75 +7977,8 @@ components:
       - inputs
       - outputs
       - accessRights
-      title: CatalogServiceGet
-      example:
-        accessRights:
-          '1':
-            execute: true
-            write: false
-        authors:
-        - affiliation: ACME
-          email: [email protected]
-          name: Author Bar
-        classifiers: []
-        contact: [email protected]
-        description: A service which awaits for time to pass, two times.
-        description_ui: true
-        history:
-        - released: '2024-07-20T15:00:00'
-          version: 2.2.1
-          version_display: Summer Release
-        - compatibility:
-            canUpdateTo:
-              version: 2.2.1
-          version: 2.0.0
-        - version: 0.9.11
-        - version: 0.9.10
-        - compatibility:
-            canUpdateTo:
-              version: 0.9.11
-          version: 0.9.8
-        - compatibility:
-            can_update_to:
-              version: 0.9.11
-          released: '2024-01-20T18:49:17'
-          version: 0.9.1
-          versionDisplay: Matterhorn
-        - retired: '2024-07-20T15:00:00'
-          version: 0.9.0
-        - version: 0.8.0
-        - version: 0.1.0
-        icon: https://cdn-icons-png.flaticon.com/512/25/25231.png
-        inputs:
-          input0:
-            contentSchema:
-              title: Acceleration
-              type: number
-              x_unit: m/s**2
-            description: acceleration with units
-            keyId: input_1
-            label: Acceleration
-            type: ref_contentSchema
-            unitLong: meter/second<sup>3</sup>
-            unitShort: m/s<sup>3</sup>
-        key: simcore/services/comp/itis/sleeper
-        name: sleeper
-        outputs:
-          outFile:
-            description: Time the service waited before completion
-            displayOrder: 2
-            keyId: output_2
-            label: Time Slept
-            type: number
-            unit: second
-            unitLong: seconds
-            unitShort: sec
-        owner: [email protected]
-        quality: {}
-        type: computational
-        version: 2.2.1
-        version_display: 2 Xtreme
-    CatalogServiceListItem:
+      title: CatalogLatestServiceGet
+    CatalogServiceGet:
       properties:
         key:
           type: string
@@ -8115,9 +8037,11 @@ components:
         inputs:
           type: object
           title: Inputs
+          description: inputs with extended information
         outputs:
           type: object
           title: Outputs
+          description: outputs with extended information
         bootOptions:
           anyOf:
           - type: object
@@ -8143,20 +8067,17 @@ components:
             type: array
           - type: 'null'
           title: Classifiers
-          default: []
         quality:
           type: object
           title: Quality
-          default: {}
         history:
           items:
             $ref: '#/components/schemas/ServiceRelease'
           type: array
           title: History
-          description: History will be replaced by current 'release' instead
+          description: history of releases for this service at this point in time,
+            starting from the newest to the oldest. It includes current release.
           default: []
-          deprecated: true
-      additionalProperties: false
       type: object
       required:
       - key
@@ -8170,7 +8091,74 @@ components:
       - inputs
       - outputs
       - accessRights
-      title: CatalogServiceListItem
+      title: CatalogServiceGet
+      example:
+        accessRights:
+          '1':
+            execute: true
+            write: false
+        authors:
+        - affiliation: ACME
+          email: [email protected]
+          name: Author Bar
+        classifiers: []
+        contact: [email protected]
+        description: A service which awaits for time to pass, two times.
+        description_ui: true
+        history:
+        - released: '2024-07-20T15:00:00'
+          version: 2.2.1
+          version_display: Summer Release
+        - compatibility:
+            canUpdateTo:
+              version: 2.2.1
+          version: 2.0.0
+        - version: 0.9.11
+        - version: 0.9.10
+        - compatibility:
+            canUpdateTo:
+              version: 0.9.11
+          version: 0.9.8
+        - compatibility:
+            can_update_to:
+              version: 0.9.11
+          released: '2024-01-20T18:49:17'
+          version: 0.9.1
+          versionDisplay: Matterhorn
+        - retired: '2024-07-20T15:00:00'
+          version: 0.9.0
+        - version: 0.8.0
+        - version: 0.1.0
+        icon: https://cdn-icons-png.flaticon.com/512/25/25231.png
+        inputs:
+          input0:
+            contentSchema:
+              title: Acceleration
+              type: number
+              x_unit: m/s**2
+            description: acceleration with units
+            keyId: input_1
+            label: Acceleration
+            type: ref_contentSchema
+            unitLong: meter/second<sup>3</sup>
+            unitShort: m/s<sup>3</sup>
+        key: simcore/services/comp/itis/sleeper
+        name: sleeper
+        outputs:
+          outFile:
+            description: Time the service waited before completion
+            displayOrder: 2
+            keyId: output_2
+            label: Time Slept
+            type: number
+            unit: second
+            unitLong: seconds
+            unitShort: sec
+        owner: [email protected]
+        quality: {}
+        type: computational
+        version: 2.2.1
+        version_display: 2 Xtreme
     CatalogServiceUpdate:
       properties:
         name:
@@ -12400,15 +12388,15 @@ components:
       - total
       - count
       title: PageMetaInfoLimitOffset
-    Page_CatalogServiceListItem_:
+    Page_CatalogLatestServiceGet_:
       properties:
         _meta:
           $ref: '#/components/schemas/PageMetaInfoLimitOffset'
         _links:
           $ref: '#/components/schemas/PageLinks'
         data:
           items:
-            $ref: '#/components/schemas/CatalogServiceListItem'
+            $ref: '#/components/schemas/CatalogLatestServiceGet'
           type: array
           title: Data
       additionalProperties: false
@@ -12417,7 +12405,7 @@ components:
       - _meta
       - _links
       - data
-      title: Page[CatalogServiceListItem]
+      title: Page[CatalogLatestServiceGet]
     Page_LicensedItemPurchaseGet_:
       properties:
         _meta:

services/web/server/src/simcore_service_webserver/catalog/_rest_controller.py

@@ -12,6 +12,7 @@
 from aiohttp import web
 from aiohttp.web import Request, RouteTableDef
 from models_library.api_schemas_webserver.catalog import (
+    CatalogLatestServiceGet,
     CatalogServiceGet,
     CatalogServiceUpdate,
     ServiceInputKey,
@@ -83,7 +84,7 @@ async def list_services_latest(request: Request):
     assert page_meta.limit == query_params.limit  # nosec
     assert page_meta.offset == query_params.offset  # nosec
 
-    page = Page[CatalogServiceGet].model_validate(
+    page = Page[CatalogLatestServiceGet].model_validate(
         paginate_data(
             chunk=page_items,
             request_url=request.url,