updates OAS

Author: pcrespov

api/specs/web-server/_projects_nodes.py

@@ -4,10 +4,8 @@
 # pylint: disable=too-many-arguments
 
 
-from typing import Annotated
-
-from _common import as_query, assert_handler_signature_against_model
-from fastapi import APIRouter, Depends, status
+from _common import assert_handler_signature_against_model
+from fastapi import APIRouter, status
 from models_library.api_schemas_directorv2.dynamic_services import DynamicServiceGet
 from models_library.api_schemas_long_running_tasks.tasks import TaskGet
 from models_library.api_schemas_webserver.projects_nodes import (
@@ -27,7 +25,6 @@
 from models_library.groups import GroupID
 from models_library.projects import ProjectID
 from models_library.projects_nodes_io import NodeID
-from models_library.rest_pagination import Page, PageQueryParameters
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.projects._crud_handlers import ProjectPathParams
 from simcore_service_webserver.projects._nodes_handlers import (
@@ -160,16 +157,6 @@ def replace_node_resources(
 #
 
 
-@router.get(
-    "/projects/-/nodes/-/services",
-    response_model=Page[ProjectNodeServicesGet],
-)
-async def list_projects_services(
-    _query: Annotated[as_query(PageQueryParameters), Depends()]
-):
-    """Lists all services used in the user's projects **grouped by project**"""
-
-
 @router.get(
     "/projects/{project_id}/nodes/-/services",
     response_model=Envelope[ProjectNodeServicesGet],

packages/models-library/src/models_library/api_schemas_catalog/services.py

@@ -1,6 +1,7 @@
 from datetime import datetime
-from typing import Any, TypeAlias
+from typing import Annotated, Any, TypeAlias
 
+from common_library.basic_types import DEFAULT_FACTORY
 from models_library.rpc_pagination import PageRpc
 from pydantic import ConfigDict, Field, HttpUrl, NonNegativeInt
 from pydantic.config import JsonDict
@@ -154,9 +155,10 @@
 class ServiceGet(
     ServiceMetaDataPublished, ServiceAccessRights, ServiceMetaDataEditable
 ):  # pylint: disable=too-many-ancestors
-    owner: LowerCaseEmailStr | None = Field(
-        description="None when the owner email cannot be found in the database"
-    )
+    owner: Annotated[
+        LowerCaseEmailStr | None,
+        Field(description="None when the owner email cannot be found in the database"),
+    ]
 
     @staticmethod
     def _update_json_schema_extra(schema: JsonDict) -> None:
@@ -169,7 +171,7 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
     )
 
 
-class ServiceGetV2(CatalogOutputSchema):
+class ServiceGetV2Base(CatalogOutputSchema):
     # Model used in catalog's rpc and rest interfaces
     key: ServiceKey
     version: ServiceVersion
@@ -183,13 +185,14 @@ class ServiceGetV2(CatalogOutputSchema):
 
     version_display: str | None = None
 
-    service_type: ServiceType = Field(default=..., alias="type")
+    service_type: Annotated[ServiceType, Field(alias="type")]
 
     contact: LowerCaseEmailStr | None
-    authors: list[Author] = Field(..., min_length=1)
-    owner: LowerCaseEmailStr | None = Field(
-        description="None when the owner email cannot be found in the database"
-    )
+    authors: Annotated[list[Author], Field(min_length=1)]
+    owner: Annotated[
+        LowerCaseEmailStr | None,
+        Field(description="None when the owner email cannot be found in the database"),
+    ]
 
     inputs: ServiceInputsDict
     outputs: ServiceOutputsDict
@@ -202,12 +205,18 @@ class ServiceGetV2(CatalogOutputSchema):
     classifiers: list[str] | None = []
     quality: dict[str, Any] = {}
 
-    history: list[ServiceRelease] = Field(
-        default_factory=list,
-        description="history of releases for this service at this point in time, starting from the newest to the oldest."
-        " It includes current release.",
-        json_schema_extra={"default": []},
-    )
+
+class ServiceGetV2(ServiceGetV2Base):
+    # Model used in catalog's rpc and rest interfaces
+    history: Annotated[
+        list[ServiceRelease],
+        Field(
+            default_factory=list,
+            description="history of releases for this service at this point in time, starting from the newest to the oldest."
+            " It includes current release.",
+            json_schema_extra={"default": []},
+        ),
+    ] = DEFAULT_FACTORY
 
     @staticmethod
     def _update_json_schema_extra(schema: JsonDict) -> None:
@@ -276,9 +285,22 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
     )
 
 
+class ServiceItemList(ServiceGetV2Base):
+    release: ServiceRelease
+    history: Annotated[
+        list[ServiceRelease],
+        Field(
+            default_factory=list,
+            deprecated=True,
+            description="History will be replaced by current 'release' instead",
+            json_schema_extra={"default": []},
+        ),
+    ] = DEFAULT_FACTORY
+
+
 PageRpcServicesGetV2: TypeAlias = PageRpc[
     # WARNING: keep this definition in models_library and not in the RPC interface
-    ServiceGetV2
+    ServiceItemList
 ]
 
 ServiceResourcesGet: TypeAlias = ServiceResourcesDict

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

@@ -4927,36 +4927,6 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Envelope_dict_Annotated_str__StringConstraints___ImageResources__'
-  /v0/projects/-/nodes/-/services:
-    get:
-      tags:
-      - projects
-      - nodes
-      summary: List Projects Services
-      description: Lists all services used in the user's projects **grouped by project**
-      operationId: list_projects_services
-      parameters:
-      - name: limit
-        in: query
-        required: false
-        schema:
-          type: integer
-          default: 20
-          title: Limit
-      - name: offset
-        in: query
-        required: false
-        schema:
-          type: integer
-          default: 0
-          title: Offset
-      responses:
-        '200':
-          description: Successful Response
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Page_ProjectNodeServicesGet_'
   /v0/projects/{project_id}/nodes/-/services:
     get:
       tags:
@@ -12436,24 +12406,6 @@ components:
       - _links
       - data
       title: Page[ProjectListItem]
-    Page_ProjectNodeServicesGet_:
-      properties:
-        _meta:
-          $ref: '#/components/schemas/PageMetaInfoLimitOffset'
-        _links:
-          $ref: '#/components/schemas/PageLinks'
-        data:
-          items:
-            $ref: '#/components/schemas/ProjectNodeServicesGet'
-          type: array
-          title: Data
-      additionalProperties: false
-      type: object
-      required:
-      - _meta
-      - _links
-      - data
-      title: Page[ProjectNodeServicesGet]
     Page_ServiceRunGet_:
       properties:
         _meta: