feat: add update functions endpoint

Author: giancarloromeo

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

@@ -23,6 +23,7 @@
     FunctionOutputs,
     FunctionOutputSchema,
     FunctionSchemaClass,
+    FunctionUpdate,
     JSONFunctionInputSchema,
     JSONFunctionOutputSchema,
     ProjectFunction,
@@ -131,3 +132,6 @@ class ProjectFunctionToRegister(ProjectFunction, InputSchema): ...
     RegisteredProjectFunctionGet | RegisteredSolverFunctionGet,
     Field(discriminator="function_class"),
 ]
+
+
+class RegisteredFunctionUpdate(FunctionUpdate, InputSchema): ...

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

@@ -101,6 +101,11 @@ class RegisteredFunctionBase(FunctionBase):
     created_at: datetime.datetime
 
 
+class FunctionUpdate(BaseModel):
+    title: str | None = None
+    description: str | None = None
+
+
 class ProjectFunction(FunctionBase):
     function_class: Literal[FunctionClass.PROJECT] = FunctionClass.PROJECT
     project_id: ProjectID

services/web/server/src/simcore_service_webserver/functions/_controller/_functions_rest.py

@@ -4,6 +4,7 @@
     FunctionToRegister,
     RegisteredFunction,
     RegisteredFunctionGet,
+    RegisteredFunctionUpdate,
 )
 from models_library.api_schemas_webserver.users import MyFunctionPermissionsGet
 from pydantic import TypeAdapter
@@ -82,7 +83,7 @@ async def get_function(request: web.Request) -> web.Response:
     )
 
 
-@routes.put(
+@routes.patch(
     "/{VTAG}/functions/{function_id}",
     name="update_function",
 )
@@ -93,9 +94,24 @@ async def update_function(request: web.Request) -> web.Response:
     path_params = parse_request_path_parameters_as(FunctionPathParams, request)
     function_id = path_params.function_id
 
+    function_update = TypeAdapter(RegisteredFunctionUpdate).validate_python(
+        await request.json()
+    )
     req_ctx = AuthenticatedRequestContext.model_validate(request)
 
-    raise NotImplementedError
+    updated_function = await _functions_service.update_function(
+        request.app,
+        user_id=req_ctx.user_id,
+        product_name=req_ctx.product_name,
+        function_id=function_id,
+        function=function_update,
+    )
+
+    return envelope_json_response(
+        TypeAdapter(RegisteredFunctionUpdate).validate_python(
+            updated_function.model_dump(mode="json")
+        )
+    )
 
 
 @routes.delete(

services/web/server/src/simcore_service_webserver/functions/_controller/_functions_rpc.py

@@ -11,6 +11,7 @@
     FunctionJobCollectionsListFilters,
     FunctionJobID,
     FunctionOutputSchema,
+    FunctionUpdate,
     FunctionUserApiAccessRights,
     RegisteredFunction,
     RegisteredFunctionJob,
@@ -318,12 +319,12 @@ async def update_function_title(
     function_id: FunctionID,
     title: str,
 ) -> RegisteredFunction:
-    return await _functions_service.update_function_title(
+    return await _functions_service.update_function(
         app=app,
         user_id=user_id,
         product_name=product_name,
         function_id=function_id,
-        title=title,
+        function=FunctionUpdate(title=title),
     )
 
 
@@ -342,12 +343,12 @@ async def update_function_description(
     function_id: FunctionID,
     description: str,
 ) -> RegisteredFunction:
-    return await _functions_service.update_function_description(
+    return await _functions_service.update_function(
         app=app,
         user_id=user_id,
         product_name=product_name,
         function_id=function_id,
-        description=description,
+        function=FunctionUpdate(description=description),
     )
 
 

services/web/server/src/simcore_service_webserver/functions/_functions_repository.py

@@ -20,6 +20,7 @@
     FunctionOutputs,
     FunctionOutputSchema,
     FunctionsApiAccessRights,
+    FunctionUpdate,
     FunctionUserApiAccessRights,
     RegisteredFunctionDB,
     RegisteredFunctionJobCollectionDB,
@@ -633,14 +634,14 @@ async def delete_function(
         )
 
 
-async def _update_function_attribute(
+async def update_function(
     app: web.Application,
-    connection: AsyncConnection | None,
+    connection: AsyncConnection | None = None,
     *,
     user_id: UserID,
     product_name: ProductName,
     function_id: FunctionID,
-    **update_kwargs,
+    function: FunctionUpdate,
 ) -> RegisteredFunctionDB:
     async with transaction_context(get_asyncpg_engine(app), connection) as transaction:
         await check_user_api_access_rights(
@@ -667,7 +668,7 @@ async def _update_function_attribute(
         result = await transaction.execute(
             functions_table.update()
             .where(functions_table.c.uuid == function_id)
-            .values(**update_kwargs)
+            .values(**function.model_dump(exclude_none=True, exclude_unset=True))
             .returning(*_FUNCTIONS_TABLE_COLS)
         )
         row = result.one_or_none()
@@ -678,44 +679,6 @@ async def _update_function_attribute(
         return RegisteredFunctionDB.model_validate(row)
 
 
-async def update_function_title(
-    app: web.Application,
-    connection: AsyncConnection | None = None,
-    *,
-    user_id: UserID,
-    product_name: ProductName,
-    function_id: FunctionID,
-    title: str,
-) -> RegisteredFunctionDB:
-    return await _update_function_attribute(
-        app,
-        connection=connection,
-        user_id=user_id,
-        product_name=product_name,
-        function_id=function_id,
-        title=title,
-    )
-
-
-async def update_function_description(
-    app: web.Application,
-    connection: AsyncConnection | None = None,
-    *,
-    user_id: UserID,
-    product_name: ProductName,
-    function_id: FunctionID,
-    description: str,
-) -> RegisteredFunctionDB:
-    return await _update_function_attribute(
-        app,
-        connection=connection,
-        user_id=user_id,
-        product_name=product_name,
-        function_id=function_id,
-        description=description,
-    )
-
-
 async def get_function_job(
     app: web.Application,
     connection: AsyncConnection | None = None,

services/web/server/src/simcore_service_webserver/functions/_functions_service.py

@@ -14,6 +14,7 @@
     FunctionJobDB,
     FunctionJobID,
     FunctionOutputSchema,
+    FunctionUpdate,
     FunctionUserAccessRights,
     FunctionUserApiAccessRights,
     RegisteredFunction,
@@ -291,38 +292,20 @@ async def delete_function_job_collection(
     )
 
 
-async def update_function_title(
+async def update_function(
     app: web.Application,
     *,
     user_id: UserID,
     product_name: ProductName,
     function_id: FunctionID,
-    title: str,
+    function: FunctionUpdate,
 ) -> RegisteredFunction:
-    updated_function = await _functions_repository.update_function_title(
+    updated_function = await _functions_repository.update_function(
         app=app,
         user_id=user_id,
         product_name=product_name,
         function_id=function_id,
-        title=title,
-    )
-    return _decode_function(updated_function)
-
-
-async def update_function_description(
-    app: web.Application,
-    *,
-    user_id: UserID,
-    product_name: ProductName,
-    function_id: FunctionID,
-    description: str,
-) -> RegisteredFunction:
-    updated_function = await _functions_repository.update_function_description(
-        app=app,
-        user_id=user_id,
-        product_name=product_name,
-        function_id=function_id,
-        description=description,
+        function=function,
     )
     return _decode_function(updated_function)