continue refactor

Author: giancarloromeo

api/specs/web-server/_auth.py

@@ -287,6 +287,29 @@ async def list_api_keys():
     """lists display names of API keys by this user"""
 
 
+@router.get(
+    "/auth/api-keys/{id_}",
+    operation_id="get_api_key",
+    responses={
+        status.HTTP_200_OK: {
+            "description": "returns the api key or None",
+            "model": ApiKeyGet | None,
+        },
+        status.HTTP_400_BAD_REQUEST: {
+            "description": "key name requested is invalid",
+        },
+        status.HTTP_401_UNAUTHORIZED: {
+            "description": "requires login to get the keu",
+        },
+        status.HTTP_403_FORBIDDEN: {
+            "description": "not enough permissions to get the keu",
+        },
+    },
+)
+async def get_api_key(id_: int):
+    """returns the key or None"""
+
+
 @router.post(
     "/auth/api-keys",
     operation_id="create_api_key",

services/web/server/src/simcore_service_webserver/api_keys/_api.py

@@ -68,10 +68,10 @@ async def create_api_key(
 
 
 async def get_api_key(
-    app: web.Application, *, name: str, user_id: UserID, product_name: ProductName
+    app: web.Application, *, api_key_id: int, user_id: UserID, product_name: ProductName
 ) -> ApiKeyGet | None:
     row = await db.get(
-        app, display_name=name, user_id=user_id, product_name=product_name
+        app, api_key_id=api_key_id, user_id=user_id, product_name=product_name
     )
     return ApiKeyGet.model_validate(row) if row else None
 

services/web/server/src/simcore_service_webserver/api_keys/_db.py

@@ -69,14 +69,14 @@ async def get(
     app: web.Application,
     connection: AsyncConnection | None = None,
     *,
-    display_name: str,
+    api_key_id: int,
     user_id: UserID,
     product_name: ProductName,
 ) -> ApiKeyInDB | None:
     async with transaction_context(get_asyncpg_engine(app), connection) as conn:
         stmt = sa.select(api_keys).where(
             (api_keys.c.user_id == user_id)
-            & (api_keys.c.display_name == display_name)
+            & (api_keys.c.id == api_key_id)
             & (api_keys.c.product_name == product_name)
         )
 

services/web/server/src/simcore_service_webserver/api_keys/_rest.py

@@ -39,6 +39,21 @@ async def list_api_keys(request: web.Request):
     return envelope_json_response(api_keys_names)
 
 
+@routes.get(f"/{API_VTAG}/auth/api-keys/{{api_key_id}}", name="api_key_get")
+@login_required
+@permission_required("user.apikey.*")
+async def api_key_get(request: web.Request):
+    req_ctx = RequestContext.model_validate(request)
+    path_params = parse_request_path_parameters_as(ApiKeysPathParams, request)
+    key = await _api.get_api_key(
+        request.app,
+        api_key_id=path_params.api_key_id,
+        user_id=req_ctx.user_id,
+        product_name=req_ctx.product_name,
+    )
+    return envelope_json_response(key)
+
+
 @routes.post(f"/{API_VTAG}/auth/api-keys", name="create_api_key")
 @login_required
 @permission_required("user.apikey.*")

services/web/server/tests/unit/with_dbs/01/test_api_keys.py

@@ -183,19 +183,21 @@ async def test_get_or_create_api_key(
         assert client.app
 
         options = {
-            "name": "repeated_name",
             "user_id": user["id"],
             "product_name": "osparc",
         }
 
         # does not exist
-        assert await get_api_key(client.app, **options) is None
+        assert await get_api_key(client.app, **options | {"api_key_id": 1}) is None
 
         # create once
-        created = await get_or_create_api_key(client.app, **options)
-        assert created.display_name == options["name"]
+        created = await get_or_create_api_key(client.app, **options | {"name": "foo"})
+        assert created.display_name == "foo"
         assert created.api_key != created.api_secret
 
         # idempottent
         for _ in range(3):
-            assert await get_or_create_api_key(client.app, **options) == created
+            assert (
+                await get_or_create_api_key(client.app, **options | {"name": "foo"})
+                == created
+            )