annotated

Author: pcrespov

api/specs/web-server/_users.py

@@ -11,10 +11,10 @@
     MyProfileGet,
     MyProfilePatch,
     PermissionGet,
-    SearchQueryParams,
     ThirdPartyToken,
     TokenCreate,
     UserGet,
+    UsersSearchQueryParams,
 )
 from models_library.api_schemas_webserver.users_preferences import PatchRequestBody
 from models_library.generics import Envelope
@@ -146,7 +146,7 @@ async def list_user_permissions():
         "po",
     ],
 )
-async def search_users(_params: Annotated[SearchQueryParams, Depends()]):
+async def search_users(_params: Annotated[UsersSearchQueryParams, Depends()]):
     # NOTE: see `Search` in `Common Custom Methods` in https://cloud.google.com/apis/design/custom_methods
     ...
 

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

@@ -4,6 +4,7 @@
 from typing import Annotated, Any, Literal
 from uuid import UUID
 
+from common_library.basic_types import DEFAULT_FACTORY
 from common_library.users_enums import UserStatus
 from pydantic import BaseModel, ConfigDict, Field, ValidationInfo, field_validator
 
@@ -17,17 +18,18 @@
 
 
 #
-# TOKENS resource
+# THIRD-PARTY TOKENS
 #
 class ThirdPartyToken(BaseModel):
     """
     Tokens used to access third-party services connected to osparc (e.g. pennsieve, scicrunch, etc)
     """
 
-    service: str = Field(
-        ..., description="uniquely identifies the service where this token is used"
-    )
-    token_key: UUID = Field(..., description="basic token key")
+    service: Annotated[
+        str,
+        Field(description="uniquely identifies the service where this token is used"),
+    ]
+    token_key: Annotated[UUID, Field(..., description="basic token key")]
     token_secret: UUID | None = None
 
     model_config = ConfigDict(
@@ -45,7 +47,7 @@ class TokenCreate(ThirdPartyToken):
 
 
 #
-# Permissions
+# PERMISSIONS
 #
 class Permission(BaseModel):
     name: str
@@ -57,7 +59,7 @@ class PermissionGet(Permission, OutputSchema):
 
 
 #
-# My Profile
+# MY PROFILE
 #
 
 
@@ -179,16 +181,19 @@ def _validate_user_name(cls, value: str):
 
 
 #
-# User
+# USER
 #
 
 
-class SearchQueryParams(BaseModel):
-    email: str = Field(
-        min_length=3,
-        max_length=200,
-        description="complete or glob pattern for an email",
-    )
+class UsersSearchQueryParams(BaseModel):
+    email: Annotated[
+        str,
+        Field(
+            min_length=3,
+            max_length=200,
+            description="complete or glob pattern for an email",
+        ),
+    ]
 
 
 class UserGet(OutputSchema):
@@ -199,24 +204,29 @@ class UserGet(OutputSchema):
     phone: str | None
     address: str | None
     city: str | None
-    state: str | None = Field(description="State, province, canton, ...")
+    state: Annotated[str | None, Field(description="State, province, canton, ...")]
     postal_code: str | None
     country: str | None
-    extras: dict[str, Any] = Field(
-        default_factory=dict,
-        description="Keeps extra information provided in the request form",
-    )
+    extras: Annotated[
+        dict[str, Any],
+        Field(
+            default_factory=dict,
+            description="Keeps extra information provided in the request form",
+        ),
+    ] = DEFAULT_FACTORY
 
     # authorization
-    invited_by: str | None = Field(default=None)
+    invited_by: str | None = None
 
     # user status
     registered: bool
     status: UserStatus | None
-    products: list[ProductName] | None = Field(
-        default=None,
-        description="List of products this users is included or None if fields is unset",
-    )
+    products: Annotated[
+        list[ProductName] | None,
+        Field(
+            description="List of products this users is included or None if fields is unset",
+        ),
+    ]
 
     @field_validator("status")
     @classmethod

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

@@ -5,7 +5,7 @@
 from models_library.api_schemas_webserver.users import (
     MyProfileGet,
     MyProfilePatch,
-    SearchQueryParams,
+    UsersSearchQueryParams,
 )
 from servicelib.aiohttp import status
 from servicelib.aiohttp.requests_validation import (
@@ -106,8 +106,8 @@ async def search_users(request: web.Request) -> web.Response:
     req_ctx = UsersRequestContext.model_validate(request)
     assert req_ctx.product_name  # nosec
 
-    query_params: SearchQueryParams = parse_request_query_parameters_as(
-        SearchQueryParams, request
+    query_params: UsersSearchQueryParams = parse_request_query_parameters_as(
+        UsersSearchQueryParams, request
     )
 
     found = await _users_service.search_users(

services/web/server/src/simcore_service_webserver/users/_users_rest.py

@@ -1,6 +1,7 @@
 """ input/output datasets used in the rest-API
 
-NOTE: Most of the model schemas are in `models_library.api_schemas_webserver.users`, the rest (hidden or needs a dependency) is here
+NOTE: Most of the model schemas are in `models_library.api_schemas_webserver.users`,
+the rest (hidden or needs a dependency) is here
 """
 
 
@@ -48,7 +49,7 @@ class PreRegisteredUserGet(InputSchema):
         dict[str, Any],
         Field(
             default_factory=dict,
-            description="Keeps extra information provided in the request form. At most MAX_NUM_EXTRAS fields",
+            description="Keeps extra information provided in the request form.",
         ),
     ]