draft project/services api

Author: pcrespov

api/specs/web-server/_projects_nodes.py

@@ -4,8 +4,10 @@
 # pylint: disable=too-many-arguments
 
 
-from _common import assert_handler_signature_against_model
-from fastapi import APIRouter, status
+from typing import Annotated
+
+from _common import as_query, assert_handler_signature_against_model
+from fastapi import APIRouter, Depends, 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 (
@@ -18,12 +20,14 @@
     NodePatch,
     NodeRetrieve,
     NodeRetrieved,
+    ProjectNodeServicesGet,
     ServiceResourcesDict,
 )
 from models_library.generics import Envelope
 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 (
@@ -156,6 +160,24 @@ 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],
+)
+async def get_project_services(project_id: ProjectID):
+    ...
+
+
 @router.get(
     "/projects/{project_id}/nodes/-/services:access",
     response_model=Envelope[_ProjectGroupAccess],

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

@@ -1,8 +1,12 @@
 # mypy: disable-error-code=truthy-function
 from typing import Annotated, Any, Literal, TypeAlias
 
+from models_library.groups import GroupID
+from models_library.projects import ProjectID
+from models_library.services_history import ServiceRelease
 from pydantic import ConfigDict, Field
 
+from ..access_rights import AccessRights
 from ..api_schemas_directorv2.dynamic_services import RetrieveDataOut
 from ..basic_types import PortInt
 from ..projects_nodes import InputID, InputsDict, PartialNode
@@ -40,7 +44,7 @@ class NodePatch(InputSchemaWithoutCamelCase):
     ]
     inputs_required: Annotated[
         list[InputID] | None,
-         Field(alias="inputsRequired"),
+        Field(alias="inputsRequired"),
     ] = None
     input_nodes: Annotated[
         list[NodeID] | None,
@@ -197,3 +201,15 @@ class NodeRetrieve(InputSchemaWithoutCamelCase):
 
 class NodeRetrieved(RetrieveDataOut):
     model_config = OutputSchema.model_config
+
+
+class NodeServiceGet(OutputSchema):
+    key: ServiceKey
+    release: ServiceRelease
+    owner: GroupID
+    my_access_rights: AccessRights
+
+
+class ProjectNodeServicesGet(OutputSchema):
+    project_uuid: ProjectID
+    services: list[NodeServiceGet]

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

@@ -4927,6 +4927,58 @@ 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:
+      - projects
+      - nodes
+      summary: Get Project Services
+      operationId: get_project_services
+      parameters:
+      - name: project_id
+        in: path
+        required: true
+        schema:
+          type: string
+          format: uuid
+          title: Project Id
+      responses:
+        '200':
+          description: Successful Response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Envelope_ProjectNodeServicesGet_'
   /v0/projects/{project_id}/nodes/-/services:access:
     get:
       tags:
@@ -9104,6 +9156,19 @@ components:
           title: Error
       type: object
       title: Envelope[ProjectMetadataGet]
+    Envelope_ProjectNodeServicesGet_:
+      properties:
+        data:
+          anyOf:
+          - $ref: '#/components/schemas/ProjectNodeServicesGet'
+          - type: 'null'
+        error:
+          anyOf:
+          - {}
+          - type: 'null'
+          title: Error
+      type: object
+      title: Envelope[ProjectNodeServicesGet]
     Envelope_ProjectState_:
       properties:
         data:
@@ -12059,6 +12124,28 @@ components:
       - thumbnail_url
       - file_url
       title: NodeScreenshot
+    NodeServiceGet:
+      properties:
+        key:
+          type: string
+          pattern: ^simcore/services/((comp|dynamic|frontend))/([a-z0-9][a-z0-9_.-]*/)*([a-z0-9-_]+[a-z0-9])$
+          title: Key
+        release:
+          $ref: '#/components/schemas/ServiceRelease'
+        owner:
+          type: integer
+          exclusiveMinimum: true
+          title: Owner
+          minimum: 0
+        myAccessRights:
+          $ref: '#/components/schemas/AccessRights'
+      type: object
+      required:
+      - key
+      - release
+      - owner
+      - myAccessRights
+      title: NodeServiceGet
     NodeState:
       properties:
         modified:
@@ -12349,6 +12436,24 @@ 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:
@@ -13546,6 +13651,22 @@ components:
       required:
       - custom
       title: ProjectMetadataUpdate
+    ProjectNodeServicesGet:
+      properties:
+        projectUuid:
+          type: string
+          format: uuid
+          title: Projectuuid
+        services:
+          items:
+            $ref: '#/components/schemas/NodeServiceGet'
+          type: array
+          title: Services
+      type: object
+      required:
+      - projectUuid
+      - services
+      title: ProjectNodeServicesGet
     ProjectOutputGet:
       properties:
         key: