use ID str

Author: giancarloromeo

api/specs/web-server/_auth_api_keys.py

@@ -1,7 +1,11 @@
 from typing import Annotated
 
 from fastapi import APIRouter, Depends, status
-from models_library.api_schemas_webserver.auth import ApiKeyCreate, ApiKeyGet
+from models_library.api_schemas_webserver.auth import (
+    ApiKeyCreateRequest,
+    ApiKeyCreateResponse,
+    ApiKeyGet,
+)
 from models_library.generics import Envelope
 from models_library.rest_error import EnvelopedError
 from simcore_service_webserver._meta import API_VTAG
@@ -21,9 +25,9 @@
     "/auth/api-keys",
     operation_id="create_api_key",
     status_code=status.HTTP_201_CREATED,
-    response_model=Envelope[ApiKeyGet],
+    response_model=Envelope[ApiKeyCreateResponse],
 )
-async def create_api_key(_body: ApiKeyCreate):
+async def create_api_key(_body: ApiKeyCreateRequest):
     """creates API keys to access public API"""
 
 

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

@@ -1,6 +1,7 @@
 from datetime import timedelta
 from typing import Annotated, Any
 
+from models_library.basic_types import IDStr
 from pydantic import BaseModel, ConfigDict, Field, HttpUrl, SecretStr
 
 from ..emails import LowerCaseEmailStr
@@ -51,14 +52,15 @@ class UnregisterCheck(InputSchema):
 #
 
 
-class ApiKeyCreate(BaseModel):
+class ApiKeyCreateRequest(BaseModel):
     display_name: Annotated[str, Field(..., min_length=3)]
     expiration: timedelta | None = Field(
         None,
         description="Time delta from creation time to expiration. If None, then it does not expire.",
     )
 
     model_config = ConfigDict(
+        from_attributes=True,
         json_schema_extra={
             "examples": [
                 {
@@ -73,27 +75,28 @@ class ApiKeyCreate(BaseModel):
                     "expiration": "24:00:00",
                 },
             ]
-        }
+        },
     )
 
 
+class ApiKeyCreateResponse(ApiKeyCreateRequest):
+    id: IDStr
+    api_base_url: HttpUrl
+    api_key: str
+    api_secret: str
+
+
 class ApiKeyGet(BaseModel):
-    id: int
+    id: IDStr
     display_name: Annotated[str, Field(..., min_length=3)]
-    api_base_url: HttpUrl | None = None
-    api_key: str | None = None
-    api_secret: str | None = None
 
     model_config = ConfigDict(
-        populate_by_name=True,
         from_attributes=True,
         json_schema_extra={
             "examples": [
                 {
-                    "id": 42,
+                    "id": "42",
                     "display_name": "myapi",
-                    "api_key": "key",
-                    "api_secret": "secret",
                 },
             ]
         },

services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml

@@ -412,15 +412,15 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/ApiKeyCreate'
+              $ref: '#/components/schemas/ApiKeyCreateRequest'
         required: true
       responses:
         '201':
           description: Successful Response
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Envelope_ApiKeyGet_'
+                $ref: '#/components/schemas/Envelope_ApiKeyCreateResponse_'
         '404':
           description: Not Found
           content:
@@ -439,7 +439,9 @@ paths:
         in: path
         required: true
         schema:
-          type: integer
+          type: string
+          minLength: 1
+          maxLength: 100
           title: Api Key Id
       responses:
         '200':
@@ -465,7 +467,9 @@ paths:
         in: path
         required: true
         schema:
-          type: integer
+          type: string
+          minLength: 1
+          maxLength: 100
           title: Api Key Id
       responses:
         '204':
@@ -6629,7 +6633,7 @@ components:
       - link
       - widgets
       title: Announcement
-    ApiKeyCreate:
+    ApiKeyCreateRequest:
       properties:
         display_name:
           type: string
@@ -6646,36 +6650,59 @@ components:
       type: object
       required:
       - display_name
-      title: ApiKeyCreate
-    ApiKeyGet:
+      title: ApiKeyCreateRequest
+    ApiKeyCreateResponse:
       properties:
-        id:
-          type: integer
-          title: Id
         display_name:
           type: string
           minLength: 3
           title: Display Name
-        api_base_url:
+        expiration:
           anyOf:
           - type: string
-            maxLength: 2083
-            minLength: 1
-            format: uri
+            format: duration
           - type: 'null'
+          title: Expiration
+          description: Time delta from creation time to expiration. If None, then
+            it does not expire.
+        id:
+          type: string
+          maxLength: 100
+          minLength: 1
+          title: Id
+        api_base_url:
+          type: string
+          maxLength: 2083
+          minLength: 1
+          format: uri
           title: Api Base Url
         api_key:
-          anyOf:
-          - type: string
-          - type: 'null'
+          type: string
           title: Api Key
         api_secret:
-          anyOf:
-          - type: string
-          - type: 'null'
+          type: string
           title: Api Secret
       type: object
       required:
+      - display_name
+      - id
+      - api_base_url
+      - api_key
+      - api_secret
+      title: ApiKeyCreateResponse
+    ApiKeyGet:
+      properties:
+        id:
+          type: string
+          maxLength: 100
+          minLength: 1
+          title: Id
+        display_name:
+          type: string
+          minLength: 3
+          title: Display Name
+      type: object
+      required:
       - id
       - display_name
       title: ApiKeyGet
@@ -7504,6 +7531,19 @@ components:
       additionalProperties: false
       type: object
       title: EmptyModel
+    Envelope_ApiKeyCreateResponse_:
+      properties:
+        data:
+          anyOf:
+          - $ref: '#/components/schemas/ApiKeyCreateResponse'
+          - type: 'null'
+        error:
+          anyOf:
+          - {}
+          - type: 'null'
+          title: Error
+      type: object
+      title: Envelope[ApiKeyCreateResponse]
     Envelope_ApiKeyGet_:
       properties:
         data:

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

@@ -64,7 +64,7 @@ async def get_api_keys(
 async def get_api_key(
     app: web.Application,
     *,
-    api_key_id: int,
+    api_key_id: str,
     user_id: UserID,
     product_name: ProductName,
 ) -> ApiKey:
@@ -104,7 +104,7 @@ async def get_or_create_api_key(
 async def delete_api_key(
     app: web.Application,
     *,
-    api_key_id: int,
+    api_key_id: str,
     user_id: UserID,
     product_name: ProductName,
 ) -> None:

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

@@ -45,7 +45,7 @@ async def create(
         row = await result.first()
 
         return ApiKey(
-            id=row.id,
+            id=f"{row.id}",  # NOTE: remove after migration to str
             display_name=display_name,
             expiration=expiration,
             api_key=api_key,
@@ -91,7 +91,7 @@ async def get_or_create(
         assert row  # nosec
 
         return ApiKey(
-            id=row.id,
+            id=f"{row.id}",  # NOTE: remove after migration to str
             display_name=row.display_name,
             expiration=row.expires_at,
             api_key=row.api_key,
@@ -116,7 +116,7 @@ async def get_all(
 
         return [
             ApiKey(
-                id=row.id,
+                id=f"{row.id}",  # NOTE: remove after migration to str
                 display_name=row.display_name,
             )
             for row in rows
@@ -133,8 +133,8 @@ async def get(
 ) -> ApiKey | 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.id == api_key_id)
+            (api_keys.c.id == int(api_key_id))  # NOTE: remove after migration to str
+            & (api_keys.c.user_id == user_id)
             & (api_keys.c.product_name == product_name)
         )
 
@@ -143,7 +143,7 @@ async def get(
 
         return (
             ApiKey(
-                id=row.id,
+                id=f"{row.id}",  # NOTE: remove after migration to str
                 display_name=row.display_name,
                 expiration=row.expires_at,
             )
@@ -158,11 +158,11 @@ async def delete(
     *,
     user_id: UserID,
     product_name: ProductName,
-    api_key_id: int,
+    api_key_id: str,
 ) -> None:
     async with transaction_context(get_asyncpg_engine(app), connection) as conn:
         stmt = api_keys.delete().where(
-            (api_keys.c.id == api_key_id)
+            (api_keys.c.id == int(api_key_id))  # NOTE: remove after migration to str
             & (api_keys.c.user_id == user_id)
             & (api_keys.c.product_name == product_name)
         )

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

@@ -1,8 +1,14 @@
 import logging
+from dataclasses import asdict
 
 from aiohttp import web
 from aiohttp.web import RouteTableDef
-from models_library.api_schemas_webserver.auth import ApiKeyCreate, ApiKeyGet
+from models_library.api_schemas_webserver.auth import (
+    ApiKeyCreateRequest,
+    ApiKeyCreateResponse,
+    ApiKeyGet,
+)
+from models_library.basic_types import IDStr
 from models_library.rest_base import StrictRequestParameters
 from pydantic import TypeAdapter
 from servicelib.aiohttp import status
@@ -29,7 +35,7 @@
 
 
 class ApiKeysPathParams(StrictRequestParameters):
-    api_key_id: int
+    api_key_id: IDStr
 
 
 @routes.post(f"/{API_VTAG}/auth/api-keys", name="create_api_key")
@@ -38,7 +44,7 @@ class ApiKeysPathParams(StrictRequestParameters):
 @handle_plugin_requests_exceptions
 async def create_api_key(request: web.Request):
     req_ctx = RequestContext.model_validate(request)
-    new_api_key = await parse_request_body_as(ApiKeyCreate, request)
+    new_api_key = await parse_request_body_as(ApiKeyCreateRequest, request)
 
     created_api_key: ApiKey = await _api.create_api_key(
         request.app,
@@ -48,8 +54,12 @@ async def create_api_key(request: web.Request):
         product_name=req_ctx.product_name,
     )
 
-    api_key = ApiKeyGet.model_validate(created_api_key)
-    # api_key.api_base_url = TODO: https://github.com/ITISFoundation/osparc-simcore/issues/6340 # @pcrespov
+    api_key = ApiKeyCreateResponse.model_validate(
+        {
+            **asdict(created_api_key),
+            "api_base_url": "http://localhost:8000",
+        }  # TODO: https://github.com/ITISFoundation/osparc-simcore/issues/6340 # @pcrespov
+    )
 
     return envelope_json_response(api_key)