drafter interface

Author: pcrespov

api/specs/web-server/_users.py

@@ -14,10 +14,9 @@
     MyProfilePatch,
     MyTokenCreate,
     MyTokenGet,
-    MyUsersGetParams,
-    MyUsersSearchQueryParams,
-    UserAsAdminGet,
-    UsersSearchQueryParams,
+    UserForAdminGet,
+    UsersForAdminSearchQueryParams,
+    UsersGetParams,
 )
 from models_library.api_schemas_webserver.users_preferences import PatchRequestBody
 from models_library.generics import Envelope
@@ -151,18 +150,18 @@ async def list_user_permissions():
 
 @router.get(
     "/users/{user_id}",
-    response_model=Envelope[UserAsAdminGet],
+    response_model=Envelope[UserForAdminGet],
 )
-async def get_user(_path: Annotated[MyUsersGetParams, Depends()]):
+async def get_user(_path: Annotated[UsersGetParams, Depends()]):
     ...
 
 
-@router.get(
+@router.post(
     "/users:search",
-    response_model=Envelope[list[UserAsAdminGet]],
+    response_model=Envelope[list[UserForAdminGet]],
     description="Search among users who are publicly visible to the caller (i.e., me) based on their privacy settings.",
 )
-async def search_users(_query: Annotated[MyUsersSearchQueryParams, Depends()]):
+async def search_users(_body: Annotated[UsersForAdminSearchQueryParams, Depends()]):
     ...
 
 
@@ -175,17 +174,19 @@ async def search_users(_query: Annotated[MyUsersSearchQueryParams, Depends()]):
 
 @router.get(
     "/admin/users:search",
-    response_model=Envelope[list[UserAsAdminGet]],
+    response_model=Envelope[list[UserForAdminGet]],
     tags=_extra_tags,
 )
-async def search_users_for_admin(_query: Annotated[UsersSearchQueryParams, Depends()]):
+async def search_users_for_admin(
+    _query: Annotated[UsersForAdminSearchQueryParams, Depends()]
+):
     # NOTE: see `Search` in `Common Custom Methods` in https://cloud.google.com/apis/design/custom_methods
     ...
 
 
 @router.post(
     "/admin/users:pre-register",
-    response_model=Envelope[UserAsAdminGet],
+    response_model=Envelope[UserForAdminGet],
     tags=_extra_tags,
 )
 async def pre_register_user_for_admin(_body: PreRegisteredUserGet):

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

@@ -10,7 +10,6 @@
 from common_library.users_enums import UserStatus
 from models_library.groups import AccessRightsDict
 from pydantic import (
-    BaseModel,
     ConfigDict,
     EmailStr,
     Field,
@@ -23,6 +22,7 @@
 from ..emails import LowerCaseEmailStr
 from ..groups import AccessRightsDict, Group, GroupID, GroupsByTypeTuple
 from ..products import ProductName
+from ..rest_base import RequestParameters
 from ..users import (
     FirstNameStr,
     LastNameStr,
@@ -196,11 +196,11 @@ def _validate_user_name(cls, value: str):
 #
 
 
-class MyUsersGetParams(BaseModel):
+class UsersGetParams(RequestParameters):
     user_id: UserID
 
 
-class MyUsersSearchQueryParams(BaseModel):
+class UsersSearch(InputSchema):
     match_: Annotated[
         str,
         StringConstraints(strip_whitespace=True, min_length=1, max_length=50),
@@ -212,7 +212,7 @@ class MyUsersSearchQueryParams(BaseModel):
     limit: Annotated[int, annotated_types.Interval(ge=1, le=50)] = 10
 
 
-class UserAsAdminGet(OutputSchema):
+class UserGet(OutputSchema):
     # Public profile of a user subject to its privacy settings
     user_id: UserID
     group_id: GroupID
@@ -221,8 +221,12 @@ class UserAsAdminGet(OutputSchema):
     last_name: str | None = None
     email: EmailStr | None = None
 
+    @classmethod
+    def from_model(cls, args):
+        ...
+
 
-class UsersSearchQueryParams(BaseModel):
+class UsersForAdminSearchQueryParams(RequestParameters):
     email: Annotated[
         str,
         Field(
@@ -233,7 +237,7 @@ class UsersSearchQueryParams(BaseModel):
     ]
 
 
-class UserAsAdminGet(OutputSchema):
+class UserForAdminGet(OutputSchema):
     # ONLY for admins
     first_name: str | None
     last_name: str | None

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

@@ -1344,40 +1344,31 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Envelope_UserAsAdminGet_'
+                $ref: '#/components/schemas/Envelope_UserForAdminGet_'
   /v0/users:search:
-    get:
+    post:
       tags:
       - user
       summary: Search Users
       description: Search among users who are publicly visible to the caller (i.e.,
         me) based on their privacy settings.
       operationId: search_users
       parameters:
-      - name: match
+      - name: email
         in: query
         required: true
         schema:
           type: string
-          minLength: 1
-          maxLength: 50
-          title: Match
-      - name: limit
-        in: query
-        required: false
-        schema:
-          type: integer
-          maximum: 50
-          minimum: 1
-          default: 10
-          title: Limit
+          minLength: 3
+          maxLength: 200
+          title: Email
       responses:
         '200':
           description: Successful Response
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Envelope_list_UserAsAdminGet__'
+                $ref: '#/components/schemas/Envelope_list_UserForAdminGet__'
   /v0/admin/users:search:
     get:
       tags:
@@ -1400,7 +1391,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Envelope_list_UserAsAdminGet__'
+                $ref: '#/components/schemas/Envelope_list_UserForAdminGet__'
   /v0/admin/users:pre-register:
     post:
       tags:
@@ -1420,7 +1411,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Envelope_UserAsAdminGet_'
+                $ref: '#/components/schemas/Envelope_UserForAdminGet_'
   /v0/wallets:
     get:
       tags:
@@ -8611,19 +8602,19 @@ components:
           title: Error
       type: object
       title: Envelope[Union[WalletGet, NoneType]]
-    Envelope_UserAsAdminGet_:
+    Envelope_UserForAdminGet_:
       properties:
         data:
           anyOf:
-          - $ref: '#/components/schemas/UserAsAdminGet'
+          - $ref: '#/components/schemas/UserForAdminGet'
           - type: 'null'
         error:
           anyOf:
           - {}
           - type: 'null'
           title: Error
       type: object
-      title: Envelope[UserAsAdminGet]
+      title: Envelope[UserForAdminGet]
     Envelope_WalletGetWithAvailableCredits_:
       properties:
         data:
@@ -9257,12 +9248,12 @@ components:
           title: Error
       type: object
       title: Envelope[list[TaskGet]]
-    Envelope_list_UserAsAdminGet__:
+    Envelope_list_UserForAdminGet__:
       properties:
         data:
           anyOf:
           - items:
-              $ref: '#/components/schemas/UserAsAdminGet'
+              $ref: '#/components/schemas/UserForAdminGet'
             type: array
           - type: 'null'
           title: Data
@@ -9272,7 +9263,7 @@ components:
           - type: 'null'
           title: Error
       type: object
-      title: Envelope[list[UserAsAdminGet]]
+      title: Envelope[list[UserForAdminGet]]
     Envelope_list_UserNotification__:
       properties:
         data:
@@ -14395,7 +14386,7 @@ components:
       - number
       - e_tag
       title: UploadedPart
-    UserAsAdminGet:
+    UserForAdminGet:
       properties:
         firstName:
           anyOf:
@@ -14486,7 +14477,7 @@ components:
       - country
       - registered
       - status
-      title: UserAsAdminGet
+      title: UserForAdminGet
     UserNotification:
       properties:
         user_id:

services/web/server/src/simcore_service_webserver/users/_common/schemas.py

@@ -12,7 +12,7 @@
 
 import pycountry
 from models_library.api_schemas_webserver._base import InputSchema
-from models_library.api_schemas_webserver.users import UserAsAdminGet
+from models_library.api_schemas_webserver.users import UserForAdminGet
 from models_library.emails import LowerCaseEmailStr
 from models_library.users import UserID
 from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
@@ -110,5 +110,5 @@ def _pre_check_and_normalize_country(cls, v):
 
 # asserts field names are in sync
 assert set(PreRegisteredUserGet.model_fields).issubset(
-    UserAsAdminGet.model_fields
+    UserForAdminGet.model_fields
 )  # nosec

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

@@ -5,11 +5,15 @@
 from models_library.api_schemas_webserver.users import (
     MyProfileGet,
     MyProfilePatch,
-    UsersSearchQueryParams,
+    UserGet,
+    UsersForAdminSearchQueryParams,
+    UsersGetParams,
+    UsersSearch,
 )
 from servicelib.aiohttp import status
 from servicelib.aiohttp.requests_validation import (
     parse_request_body_as,
+    parse_request_path_parameters_as,
     parse_request_query_parameters_as,
 )
 from servicelib.rest_constants import RESPONSE_MODEL_POLICY
@@ -133,15 +137,20 @@ async def update_my_profile(request: web.Request) -> web.Response:
 #
 
 
-@routes.get(f"/{API_VTAG}/users:search", name="get_user")
+@routes.get(f"/{API_VTAG}/users/{{user_id}}", name="get_user")
 @login_required
 @permission_required("user.read")
 @_handle_users_exceptions
 async def get_user(request: web.Request) -> web.Response:
     req_ctx = UsersRequestContext.model_validate(request)
     assert req_ctx.product_name  # nosec
+    path_params = parse_request_path_parameters_as(UsersGetParams, request)
 
-    raise NotImplementedError
+    user = await _users_service.get_public_user(
+        request.app, caller_id=req_ctx.user_id, user_id=path_params.user_id
+    )
+
+    return envelope_json_response(UserGet.from_model(user))
 
 
 @routes.get(f"/{API_VTAG}/users:search", name="search_users")
@@ -152,7 +161,16 @@ async def search_users(request: web.Request) -> web.Response:
     req_ctx = UsersRequestContext.model_validate(request)
     assert req_ctx.product_name  # nosec
 
-    raise NotImplementedError
+    search_params = await parse_request_body_as(UsersSearch, request)
+
+    found = await _users_service.search_public_users(
+        request.app,
+        caller_id=req_ctx.user_id,
+        match_=search_params.match_,
+        limit=search_params.limit,
+    )
+
+    return envelope_json_response([UserGet.from_model(user) for user in found])
 
 
 #
@@ -171,8 +189,8 @@ async def search_users_for_admin(request: web.Request) -> web.Response:
     req_ctx = UsersRequestContext.model_validate(request)
     assert req_ctx.product_name  # nosec
 
-    query_params: UsersSearchQueryParams = parse_request_query_parameters_as(
-        UsersSearchQueryParams, request
+    query_params: UsersForAdminSearchQueryParams = parse_request_query_parameters_as(
+        UsersForAdminSearchQueryParams, request
     )
 
     found = await _users_service.search_users(

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

@@ -3,7 +3,7 @@
 
 import pycountry
 from aiohttp import web
-from models_library.api_schemas_webserver.users import MyProfilePatch, UserAsAdminGet
+from models_library.api_schemas_webserver.users import MyProfilePatch, UserForAdminGet
 from models_library.basic_types import IDStr
 from models_library.emails import LowerCaseEmailStr
 from models_library.groups import GroupID
@@ -43,7 +43,7 @@ async def pre_register_user(
     app: web.Application,
     profile: PreRegisteredUserGet,
     creator_user_id: UserID,
-) -> UserAsAdminGet:
+) -> UserForAdminGet:
 
     found = await search_users(app, email_glob=profile.email, include_products=False)
     if found:
@@ -87,6 +87,19 @@ async def pre_register_user(
 #
 
 
+async def get_public_user(
+    app: web.Application, *, caller_id: UserID, user_id: UserID
+) -> dict[str, Any]:
+    ...
+
+
+async def search_public_users(
+    app: web.Application, *, caller_id: UserID, match_: str, limit: int
+) -> list[dict[str, Any]]:
+
+    ...
+
+
 async def get_user(app: web.Application, user_id: UserID) -> dict[str, Any]:
     """
     :raises UserNotFoundError: if missing but NOT if marked for deletion!
@@ -108,7 +121,7 @@ async def get_user_id_from_gid(app: web.Application, primary_gid: GroupID) -> Us
 
 async def search_users(
     app: web.Application, email_glob: str, *, include_products: bool = False
-) -> list[UserAsAdminGet]:
+) -> list[UserForAdminGet]:
     # NOTE: this search is deploy-wide i.e. independent of the product!
 
     def _glob_to_sql_like(glob_pattern: str) -> str:
@@ -130,7 +143,7 @@ async def _list_products_or_none(user_id):
         return None
 
     return [
-        UserAsAdminGet(
+        UserForAdminGet(
             first_name=r.first_name or r.pre_first_name,
             last_name=r.last_name or r.pre_last_name,
             email=r.email or r.pre_email,