add id

Author: giancarloromeo

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

@@ -1,5 +1,5 @@
 from datetime import timedelta
-from typing import Any
+from typing import Annotated, Any
 
 from pydantic import BaseModel, ConfigDict, Field, SecretStr
 
@@ -78,15 +78,22 @@ class ApiKeyCreate(BaseModel):
 
 
 class ApiKeyGet(BaseModel):
-    display_name: str = Field(..., min_length=3)
+    id_: Annotated[int, Field(alias="id")]
+    display_name: Annotated[str, Field(..., min_length=3)]
     api_key: str
     api_secret: str
 
     model_config = ConfigDict(
+        populate_by_name=True,
         from_attributes=True,
         json_schema_extra={
             "examples": [
-                {"display_name": "myapi", "api_key": "key", "api_secret": "secret"},
+                {
+                    "id": 42,
+                    "display_name": "myapi",
+                    "api_key": "key",
+                    "api_secret": "secret",
+                },
             ]
         },
     )

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

@@ -49,7 +49,7 @@ async def create_api_key(
     api_key, api_secret = _generate_api_key_and_secret(new.display_name)
 
     # raises if name exists already!
-    await db.create(
+    api_key_id = await db.create(
         app,
         user_id=user_id,
         product_name=product_name,
@@ -60,6 +60,7 @@ async def create_api_key(
     )
 
     return ApiKeyGet(
+        id_=api_key_id,
         display_name=new.display_name,
         api_key=api_key,
         api_secret=api_secret,

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

@@ -7,6 +7,7 @@
 from models_library.basic_types import IdInt
 from models_library.products import ProductName
 from models_library.users import UserID
+from pydantic import TypeAdapter
 from simcore_postgres_database.models.api_keys import api_keys
 from simcore_postgres_database.utils_repos import transaction_context
 from sqlalchemy.dialects.postgresql import insert as pg_insert
@@ -44,7 +45,7 @@ async def create(
     expiration: timedelta | None,
     api_key: str,
     api_secret: str,
-) -> list[IdInt]:
+) -> IdInt:
     async with transaction_context(get_asyncpg_engine(app), connection) as conn:
         stmt = (
             api_keys.insert()
@@ -60,8 +61,8 @@ async def create(
         )
 
         result = await conn.stream(stmt)
-        rows = [row async for row in result]
-        return [r.id for r in rows]
+        row = await result.first()
+        return TypeAdapter(IdInt).validate_python(row.id)
 
 
 async def get(

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

@@ -30,19 +30,21 @@ async def fake_user_api_keys(
     logged_user: UserInfoDict,
     osparc_product_name: ProductName,
     faker: Faker,
-) -> AsyncIterable[list[str]]:
+) -> AsyncIterable[list[int]]:
     assert client.app
-    api_key_ids = []
+    api_key_ids: list[int] = []
 
     for _ in range(5):
-        api_key_ids += await db.create(
-            client.app,
-            user_id=logged_user["id"],
-            product_name=osparc_product_name,
-            display_name=faker.pystr(),
-            expiration=None,
-            api_key=faker.pystr(),
-            api_secret=faker.pystr(),
+        api_key_ids.append(
+            await db.create(
+                client.app,
+                user_id=logged_user["id"],
+                product_name=osparc_product_name,
+                display_name=faker.pystr(),
+                expiration=None,
+                api_key=faker.pystr(),
+                api_secret=faker.pystr(),
+            )
         )
 
     yield api_key_ids