changing web-server

Author: pcrespov

api/specs/web-server/_catalog.py

@@ -15,7 +15,7 @@
 from models_library.generics import Envelope
 from models_library.rest_pagination import Page
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.catalog._rest_controller import (
+from simcore_service_webserver.catalog._controller_rest import (
     ListServiceParams,
     ServicePathParams,
     _FromServiceOutputParams,

api/specs/web-server/_catalog_tags.py

@@ -10,7 +10,7 @@
 from models_library.api_schemas_webserver.catalog import CatalogServiceGet
 from models_library.generics import Envelope
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.catalog._rest_tags_controller import (
+from simcore_service_webserver.catalog._controller_rest_schemas import (
     ServicePathParams,
     ServiceTagPathParams,
 )

services/web/server/src/simcore_service_webserver/catalog/_rest_controller.py renamed to services/web/server/src/simcore_service_webserver/catalog/_controller_rest.py

@@ -39,15 +39,16 @@
 from ..security.decorators import permission_required
 from ..utils_aiohttp import envelope_json_response
 from . import _catalog_rest_client_service, _service
-from ._exceptions import (
+from ._controller_rest_exceptions import (
     DefaultPricingUnitForServiceNotFoundError,
     handle_plugin_requests_exceptions,
 )
-from .controller_rest_schemas import (
+from ._controller_rest_schemas import (
     CatalogRequestContext,
     ListServiceParams,
     ServicePathParams,
 )
+from .controller_rest_schemas import ServicePathParams
 
 _logger = logging.getLogger(__name__)
 
@@ -377,3 +378,43 @@ async def get_service_pricing_plan(request: Request):
     return envelope_json_response(
         PricingPlanGet.model_validate(pricing_plan.model_dump())
     )
+
+
+@routes.get(
+    f"/{API_VTAG}/catalog/services/{{service_key}}/{{service_version}}/tags",
+    name="list_service_tags",
+)
+@login_required
+@permission_required("service.tag.*")
+async def list_service_tags(request: web.Request):
+    path_params = parse_request_path_parameters_as(ServicePathParams, request)
+    assert path_params  # nosec
+    raise NotImplementedError
+
+
+@routes.post(
+    f"/{API_VTAG}/catalog/services/{{service_key}}/{{service_version}}/tags/{{tag_id}}:add",
+    name="add_service_tag",
+)
+@login_required
+@permission_required("service.tag.*")
+async def add_service_tag(request: web.Request):
+    path_params = parse_request_path_parameters_as(ServiceTagPathParams, request)
+    assert path_params  # nosec
+
+    # responds with parent's resource to get the current state (as with patch/update)
+    raise NotImplementedError
+
+
+@routes.post(
+    f"/{API_VTAG}/catalog/services/{{service_key}}/{{service_version}}/tags/{{tag_id}}:remove",
+    name="remove_service_tag",
+)
+@login_required
+@permission_required("service.tag.*")
+async def remove_service_tag(request: web.Request):
+    path_params = parse_request_path_parameters_as(ServiceTagPathParams, request)
+    assert path_params  # nosec
+
+    # responds with parent's resource to get the current state (as with patch/update)
+    raise NotImplementedError

services/web/server/src/simcore_service_webserver/catalog/_exceptions.py renamed to services/web/server/src/simcore_service_webserver/catalog/_controller_rest_exceptions.py

@@ -6,37 +6,14 @@
     CatalogItemNotFoundError,
 )
 
-from ..errors import WebServerBaseError
 from ..exception_handling import (
     ExceptionToHttpErrorMap,
     HttpErrorInfo,
     exception_handling_decorator,
     to_exceptions_handlers_map,
 )
 from ..resource_usage.errors import DefaultPricingPlanNotFoundError
-
-
-class BaseCatalogError(WebServerBaseError):
-    msg_template = "Unexpected error occured in catalog submodule"
-
-    def __init__(self, msg=None, **ctx):
-        super().__init__(**ctx)
-        if msg:
-            self.msg_template = msg
-
-    def debug_message(self):
-        # Override in subclass
-        return f"{self.code}: {self}"
-
-
-class DefaultPricingUnitForServiceNotFoundError(BaseCatalogError):
-    msg_template = "Default pricing unit not found for service key '{service_key}' and version '{service_version}'"
-
-    def __init__(self, *, service_key: str, service_version: str, **ctxs):
-        super().__init__(**ctxs)
-        self.service_key = service_key
-        self.service_version = service_version
-
+from .errors import DefaultPricingUnitForServiceNotFoundError
 
 # mypy: disable-error-code=truthy-function
 assert CatalogForbiddenError  # nosec

services/web/server/src/simcore_service_webserver/catalog/controller_rest_schemas.py renamed to services/web/server/src/simcore_service_webserver/catalog/_controller_rest_schemas.py

@@ -28,12 +28,12 @@
 
 from ..rabbitmq import get_rabbitmq_rpc_client
 from . import _catalog_rest_client_service
-from ._units_service import can_connect, replace_service_input_outputs
-from .controller_rest_schemas import (
+from ._controller_rest_schemas import (
     CatalogRequestContext,
     ServiceInputGetFactory,
     ServiceOutputGetFactory,
 )
+from ._units_service import can_connect, replace_service_input_outputs
 
 _logger = logging.getLogger(__name__)
 

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

@@ -3,7 +3,7 @@
 from models_library.services import BaseServiceIOModel, ServiceInput, ServiceOutput
 from pint import PintError, UnitRegistry
 
-from .controller_rest_schemas import (
+from ._controller_rest_schemas import (
     ServiceInputGetFactory,
     ServiceOutputGetFactory,
     get_unit_name,

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

@@ -0,0 +1,25 @@
+"""Defines the different exceptions that may arise in the catalog subpackage"""
+
+from ..errors import WebServerBaseError
+
+
+class BaseCatalogError(WebServerBaseError):
+    msg_template = "Unexpected error occured in catalog submodule"
+
+    def __init__(self, msg=None, **ctx):
+        super().__init__(**ctx)
+        if msg:
+            self.msg_template = msg
+
+    def debug_message(self):
+        # Override in subclass
+        return f"{self.code}: {self}"
+
+
+class DefaultPricingUnitForServiceNotFoundError(BaseCatalogError):
+    msg_template = "Default pricing unit not found for service key '{service_key}' and version '{service_version}'"
+
+    def __init__(self, *, service_key: str, service_version: str, **ctxs):
+        super().__init__(**ctxs)
+        self.service_key = service_key
+        self.service_version = service_version

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

@@ -6,7 +6,7 @@
 from pint import UnitRegistry
 from servicelib.aiohttp.application_setup import ModuleCategory, app_module_setup
 
-from . import _rest_controller, _rest_tags_controller
+from . import _controller_rest, _tags_controller_rest
 
 _logger = logging.getLogger(__name__)
 
@@ -22,11 +22,11 @@ def setup_catalog(app: web.Application):
     # ensures routes are names that corresponds to function names
     assert all(  # nosec
         route_def.kwargs["name"] == route_def.handler.__name__  # type: ignore[attr-defined] # route_def is a RouteDef not an Abstract
-        for route_def in _rest_controller.routes
+        for route_def in _controller_rest.routes
     )
 
-    app.add_routes(_rest_controller.routes)
-    app.add_routes(_rest_tags_controller.routes)
+    app.add_routes(_controller_rest.routes)
+    app.add_routes(_tags_controller_rest.routes)
 
     # prepares units registry
     app[UnitRegistry.__name__] = UnitRegistry()