🎨 Enhance Functions REST API endpoints in Web Server (ITISFoundation#8117)

Author: giancarloromeo

api/specs/web-server/_functions.py

@@ -7,15 +7,19 @@
 
 from typing import Annotated
 
+from _common import as_query
 from fastapi import APIRouter, Depends, status
 from models_library.api_schemas_webserver.functions import (
     FunctionToRegister,
     RegisteredFunctionGet,
+    RegisteredFunctionUpdate,
 )
 from models_library.generics import Envelope
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.functions._controller._functions_rest_schemas import (
+    FunctionGetQueryParams,
     FunctionPathParams,
+    FunctionsListQueryParams,
 )
 
 router = APIRouter(
@@ -35,12 +39,32 @@ async def register_function(
 ) -> Envelope[RegisteredFunctionGet]: ...
 
 
+@router.get(
+    "/functions",
+    response_model=Envelope[list[RegisteredFunctionGet]],
+)
+async def list_functions(
+    _query: Annotated[as_query(FunctionsListQueryParams), Depends()],
+): ...
+
+
 @router.get(
     "/functions/{function_id}",
     response_model=Envelope[RegisteredFunctionGet],
 )
 async def get_function(
     _path: Annotated[FunctionPathParams, Depends()],
+    _query: Annotated[as_query(FunctionGetQueryParams), Depends()],
+): ...
+
+
+@router.patch(
+    "/functions/{function_id}",
+    response_model=Envelope[RegisteredFunctionGet],
+)
+async def update_function(
+    _body: RegisteredFunctionUpdate,
+    _path: Annotated[FunctionPathParams, Depends()],
 ): ...
 
 

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

@@ -1,9 +1,11 @@
+import datetime
 from typing import Annotated, TypeAlias
 
 from pydantic import Field
 
 from ..functions import (
     Function,
+    FunctionAccessRights,
     FunctionBase,
     FunctionClass,
     FunctionClassSpecificData,
@@ -23,6 +25,7 @@
     FunctionOutputs,
     FunctionOutputSchema,
     FunctionSchemaClass,
+    FunctionUpdate,
     JSONFunctionInputSchema,
     JSONFunctionOutputSchema,
     ProjectFunction,
@@ -46,6 +49,7 @@
     UnsupportedFunctionClassError,
     UnsupportedFunctionFunctionJobClassCombinationError,
 )
+from ..projects import ProjectID
 from ._base import InputSchema, OutputSchema
 
 __all__ = [
@@ -113,7 +117,13 @@
 class RegisteredSolverFunctionGet(RegisteredSolverFunction, OutputSchema): ...
 
 
-class RegisteredProjectFunctionGet(RegisteredProjectFunction, OutputSchema): ...
+class RegisteredProjectFunctionGet(RegisteredProjectFunction, OutputSchema):
+    uid: Annotated[FunctionID, Field(alias="uuid")]
+    project_id: Annotated[ProjectID, Field(alias="templateId")]
+    created_at: Annotated[datetime.datetime, Field(alias="creationDate")]
+    modified_at: Annotated[datetime.datetime, Field(alias="lastChangeDate")]
+    access_rights: FunctionAccessRights | None = None
+    thumbnail: str | None = None
 
 
 class SolverFunctionToRegister(SolverFunction, InputSchema): ...
@@ -131,3 +141,6 @@ class ProjectFunctionToRegister(ProjectFunction, InputSchema): ...
     RegisteredProjectFunctionGet | RegisteredSolverFunctionGet,
     Field(discriminator="function_class"),
 ]
+
+
+class RegisteredFunctionUpdate(FunctionUpdate, InputSchema): ...

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

@@ -386,4 +386,5 @@ def from_domain_model(cls, permission: UserPermission) -> Self:
 
 
 class MyFunctionPermissionsGet(OutputSchema):
+    read_functions: bool
     write_functions: bool

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

@@ -99,6 +99,12 @@ class FunctionBase(BaseModel):
 class RegisteredFunctionBase(FunctionBase):
     uid: FunctionID
     created_at: datetime.datetime
+    modified_at: datetime.datetime
+
+
+class FunctionUpdate(BaseModel):
+    title: str | None = None
+    description: str | None = None
 
 
 class ProjectFunction(FunctionBase):
@@ -250,6 +256,7 @@ class FunctionDB(BaseModel):
 class RegisteredFunctionDB(FunctionDB):
     uuid: FunctionID
     created: datetime.datetime
+    modified: datetime.datetime
 
 
 class FunctionJobCollectionDB(BaseModel):

services/api-server/openapi.json

@@ -10623,6 +10623,11 @@
             "format": "date-time",
             "title": "Created At"
           },
+          "modified_at": {
+            "type": "string",
+            "format": "date-time",
+            "title": "Modified At"
+          },
           "project_id": {
             "type": "string",
             "format": "uuid",
@@ -10636,6 +10641,7 @@
           "default_inputs",
           "uid",
           "created_at",
+          "modified_at",
           "project_id"
         ],
         "title": "RegisteredProjectFunction"
@@ -10782,6 +10788,11 @@
             "format": "date-time",
             "title": "Created At"
           },
+          "modified_at": {
+            "type": "string",
+            "format": "date-time",
+            "title": "Modified At"
+          },
           "code_url": {
             "type": "string",
             "title": "Code Url"
@@ -10794,6 +10805,7 @@
           "default_inputs",
           "uid",
           "created_at",
+          "modified_at",
           "code_url"
         ],
         "title": "RegisteredPythonCodeFunction"
@@ -10934,6 +10946,11 @@
             "format": "date-time",
             "title": "Created At"
           },
+          "modified_at": {
+            "type": "string",
+            "format": "date-time",
+            "title": "Modified At"
+          },
           "solver_key": {
             "type": "string",
             "pattern": "^simcore/services/((comp|dynamic|frontend))/([a-z0-9][a-z0-9_.-]*/)*([a-z0-9-_]+[a-z0-9])$",
@@ -10952,6 +10969,7 @@
           "default_inputs",
           "uid",
           "created_at",
+          "modified_at",
           "solver_key",
           "solver_version"
         ],

services/api-server/tests/unit/api_functions/conftest.py

@@ -127,9 +127,10 @@ def mock_function(
 def mock_registered_project_function(mock_function: Function) -> RegisteredFunction:
     return RegisteredProjectFunction(
         **{
-            **mock_function.dict(),
-            "uid": str(uuid4()),
+            **mock_function.model_dump(),
+            "uid": f"{uuid4()}",
             "created_at": datetime.datetime.now(datetime.UTC),
+            "modified_at": datetime.datetime.now(datetime.UTC),
         }
     )
 
@@ -148,8 +149,9 @@ def mock_registered_solver_function(
             "input_schema": sample_input_schema,
             "output_schema": sample_output_schema,
             "default_inputs": None,
-            "uid": str(uuid4()),
+            "uid": f"{uuid4()}",
             "created_at": datetime.datetime.now(datetime.UTC),
+            "modified_at": datetime.datetime.now(datetime.UTC),
             "solver_key": "simcore/services/comp/ans-model",
             "solver_version": "1.0.1",
         }
@@ -166,7 +168,7 @@ def mock_project_function_job(
         "description": "A test function job",
         "inputs": {"key": "value"},
         "outputs": None,
-        "project_job_id": str(uuid4()),
+        "project_job_id": f"{uuid4()}",
         "function_class": FunctionClass.PROJECT,
     }
     return ProjectFunctionJob(**mock_function_job)
@@ -178,8 +180,8 @@ def mock_registered_project_function_job(
 ) -> RegisteredFunctionJob:
     return RegisteredProjectFunctionJob(
         **{
-            **mock_project_function_job.dict(),
-            "uid": str(uuid4()),
+            **mock_project_function_job.model_dump(),
+            "uid": f"{uuid4()}",
             "created_at": datetime.datetime.now(datetime.UTC),
         }
     )
@@ -206,8 +208,8 @@ def mock_registered_solver_function_job(
 ) -> RegisteredFunctionJob:
     return RegisteredSolverFunctionJob(
         **{
-            **mock_solver_function_job.dict(),
-            "uid": str(uuid4()),
+            **mock_solver_function_job.model_dump(),
+            "uid": f"{uuid4()}",
             "created_at": datetime.datetime.now(datetime.UTC),
         }
     )
@@ -222,7 +224,7 @@ def mock_function_job_collection(
         "description": "A test function job collection",
         "function_uid": mock_registered_project_function_job.function_uid,
         "function_class": FunctionClass.PROJECT,
-        "project_id": str(uuid4()),
+        "project_id": f"{uuid4()}",
         "function_job_ids": [
             mock_registered_project_function_job.uid for _ in range(5)
         ],
@@ -237,7 +239,7 @@ def mock_registered_function_job_collection(
     return RegisteredFunctionJobCollection(
         **{
             **mock_function_job_collection.model_dump(),
-            "uid": str(uuid4()),
+            "uid": f"{uuid4()}",
             "created_at": datetime.datetime.now(datetime.UTC),
         }
     )

services/static-webserver/client/source/class/osparc/data/Resources.js

@@ -631,6 +631,14 @@ qx.Class.define("osparc.data.Resources", {
           create: {
             method: "POST",
             url: statics.API + "/functions"
+          },
+          getOne: {
+            method: "GET",
+            url: statics.API + "/functions/{functionId}?include_extras=true"
+          },
+          getPage: {
+            method: "GET",
+            url: statics.API + "/functions?include_extras=true"
           }
         }
       },

services/static-webserver/client/source/class/osparc/data/model/Function.js

@@ -31,7 +31,7 @@ qx.Class.define("osparc.data.model.Function", {
     this.set({
       uuid: functionData.uuid,
       functionType: functionData.functionClass,
-      name: functionData.name,
+      name: functionData.title,
       description: functionData.description,
       inputSchema: functionData.inputSchema || this.getInputSchema(),
       outputSchema: functionData.outputSchema || this.getOutputSchema(),

services/static-webserver/client/source/class/osparc/store/Functions.js

@@ -92,7 +92,7 @@ qx.Class.define("osparc.store.Functions", {
     },
 
     fetchFunctionsPaginated: function(params, options) {
-      const isBackendReady = false;
+      const isBackendReady = true;
       if (!isBackendReady) {
         return new Promise(resolve => {
           const response = this.__dummyResponse();
@@ -110,7 +110,7 @@ qx.Class.define("osparc.store.Functions", {
     },
 
     fetchFunction: function(functionId) {
-      const isBackendReady = false;
+      const isBackendReady = true;
       if (!isBackendReady) {
         return new Promise(resolve => {
           const response = this.__dummyResponse();