rename as user-account

Author: pcrespov

api/specs/web-server/_users.py

@@ -15,12 +15,12 @@
     MyProfilePatch,
     MyTokenCreate,
     MyTokenGet,
+    UserAccountGet,
+    UserAccountSearchQueryParams,
     UserApprove,
-    UserForAdminGet,
     UserGet,
     UserReject,
-    UsersForAdminListQueryParams,
-    UsersForAdminSearchQueryParams,
+    UsersAccountListQueryParams,
     UsersSearch,
 )
 from models_library.api_schemas_webserver.users_preferences import PatchRequestBody
@@ -149,46 +149,46 @@ async def search_users(_body: UsersSearch): ...
 
 
 @router.get(
-    "/admin/users",
-    response_model=Page[UserForAdminGet],
+    "/admin/user-accounts",
+    response_model=Page[UserAccountGet],
     tags=_extra_tags,
 )
-async def list_users_for_admin(
-    _query: Annotated[as_query(UsersForAdminListQueryParams), Depends()],
+async def list_users_accounts(
+    _query: Annotated[as_query(UsersAccountListQueryParams), Depends()],
 ): ...
 
 
 @router.post(
-    "/admin/users:approve",
+    "/admin/user-accounts:approve",
     status_code=status.HTTP_204_NO_CONTENT,
     tags=_extra_tags,
 )
 async def approve_user_account(_body: UserApprove): ...
 
 
 @router.post(
-    "/admin/users:reject",
+    "/admin/user-accounts:reject",
     status_code=status.HTTP_204_NO_CONTENT,
     tags=_extra_tags,
 )
 async def reject_user_account(_body: UserReject): ...
 
 
 @router.get(
-    "/admin/users:search",
-    response_model=Envelope[list[UserForAdminGet]],
+    "/admin/user-accounts:search",
+    response_model=Envelope[list[UserAccountGet]],
     tags=_extra_tags,
 )
-async def search_users_for_admin(
-    _query: Annotated[UsersForAdminSearchQueryParams, Depends()],
+async def search_user_account(
+    _query: Annotated[UserAccountSearchQueryParams, 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[UserForAdminGet],
+    "/admin/user-accounts:pre-register",
+    response_model=Envelope[UserAccountGet],
     tags=_extra_tags,
 )
-async def pre_register_user_for_admin(_body: PreRegisteredUserGet): ...
+async def pre_register_user_account(_body: PreRegisteredUserGet): ...

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

@@ -252,7 +252,7 @@ class UsersForAdminListFilter(Filters):
     model_config = ConfigDict(extra="forbid")
 
 
-class UsersForAdminListQueryParams(UsersForAdminListFilter, PageQueryParameters): ...
+class UsersAccountListQueryParams(UsersForAdminListFilter, PageQueryParameters): ...
 
 
 class UserApprove(InputSchema):
@@ -264,7 +264,7 @@ class UserReject(InputSchema):
     email: EmailStr
 
 
-class UsersForAdminSearchQueryParams(RequestParameters):
+class UserAccountSearchQueryParams(RequestParameters):
     email: Annotated[
         str,
         Field(
@@ -275,7 +275,7 @@ class UsersForAdminSearchQueryParams(RequestParameters):
     ]
 
 
-class UserForAdminGet(OutputSchema):
+class UserAccountGet(OutputSchema):
     # ONLY for admins
     first_name: str | None
     last_name: str | None

scripts/maintenance/pre_registration.py

@@ -123,7 +123,7 @@ async def _pre_register_user(
     extras: dict[str, Any] = {},
 ) -> dict[str, Any]:
     """Pre-register a user in the system"""
-    path = "/v0/admin/users:pre-register"
+    path = "/v0/admin/user-accounts:pre-register"
 
     user_data = PreRegisterUserRequest(
         firstName=first_name,

services/static-webserver/client/source/class/osparc/data/Resources.js

@@ -1059,27 +1059,27 @@ qx.Class.define("osparc.data.Resources", {
         endpoints: {
           search: {
             method: "GET",
-            url: statics.API + "/admin/users:search?email={email}"
+            url: statics.API + "/admin/user-accounts:search?email={email}"
           },
           getPendingUsers: {
             method: "GET",
-            url: statics.API + "/admin/users?review_status=PENDING"
+            url: statics.API + "/admin/user-accounts?review_status=PENDING"
           },
           approveUser: {
             method: "POST",
-            url: statics.API + "/admin/users:approve"
+            url: statics.API + "/admin/user-accounts:approve"
           },
           rejectUser: {
             method: "POST",
-            url: statics.API + "/admin/users:reject"
+            url: statics.API + "/admin/user-accounts:reject"
           },
           resendConfirmationEmail: {
             method: "POST",
-            url: statics.API + "/admin/users:resendConfirmationEmail"
+            url: statics.API + "/admin/user-accounts:resendConfirmationEmail"
           },
           preRegister: {
             method: "POST",
-            url: statics.API + "/admin/users:pre-register"
+            url: statics.API + "/admin/user-accounts:pre-register"
           }
         }
       },

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

@@ -1365,13 +1365,13 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Envelope_list_UserGet__'
-  /v0/admin/users:
+  /v0/admin/user-accounts:
     get:
       tags:
       - users
       - admin
-      summary: List Users For Admin
-      operationId: list_users_for_admin
+      summary: List Users Accounts
+      operationId: list_users_accounts
       parameters:
       - name: limit
         in: query
@@ -1404,8 +1404,8 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Page_UserForAdminGet_'
-  /v0/admin/users:approve:
+                $ref: '#/components/schemas/Page_UserAccountGet_'
+  /v0/admin/user-accounts:approve:
     post:
       tags:
       - users
@@ -1421,7 +1421,7 @@ paths:
       responses:
         '204':
           description: Successful Response
-  /v0/admin/users:reject:
+  /v0/admin/user-accounts:reject:
     post:
       tags:
       - users
@@ -1437,13 +1437,13 @@ paths:
       responses:
         '204':
           description: Successful Response
-  /v0/admin/users:search:
+  /v0/admin/user-accounts:search:
     get:
       tags:
       - users
       - admin
-      summary: Search Users For Admin
-      operationId: search_users_for_admin
+      summary: Search User Account
+      operationId: search_user_account
       parameters:
       - name: email
         in: query
@@ -1459,14 +1459,14 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Envelope_list_UserForAdminGet__'
-  /v0/admin/users:pre-register:
+                $ref: '#/components/schemas/Envelope_list_UserAccountGet__'
+  /v0/admin/user-accounts:pre-register:
     post:
       tags:
       - users
       - admin
-      summary: Pre Register User For Admin
-      operationId: pre_register_user_for_admin
+      summary: Pre Register User Account
+      operationId: pre_register_user_account
       requestBody:
         content:
           application/json:
@@ -1479,7 +1479,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Envelope_UserForAdminGet_'
+                $ref: '#/components/schemas/Envelope_UserAccountGet_'
   /v0/wallets:
     get:
       tags:
@@ -10656,19 +10656,19 @@ components:
           title: Error
       type: object
       title: Envelope[Union[WalletGet, NoneType]]
-    Envelope_UserForAdminGet_:
+    Envelope_UserAccountGet_:
       properties:
         data:
           anyOf:
-          - $ref: '#/components/schemas/UserForAdminGet'
+          - $ref: '#/components/schemas/UserAccountGet'
           - type: 'null'
         error:
           anyOf:
           - {}
           - type: 'null'
           title: Error
       type: object
-      title: Envelope[UserForAdminGet]
+      title: Envelope[UserAccountGet]
     Envelope_WalletGetWithAvailableCredits_:
       properties:
         data:
@@ -11212,12 +11212,12 @@ components:
           title: Error
       type: object
       title: Envelope[list[TaskGet]]
-    Envelope_list_UserForAdminGet__:
+    Envelope_list_UserAccountGet__:
       properties:
         data:
           anyOf:
           - items:
-              $ref: '#/components/schemas/UserForAdminGet'
+              $ref: '#/components/schemas/UserAccountGet'
             type: array
           - type: 'null'
           title: Data
@@ -11227,7 +11227,7 @@ components:
           - type: 'null'
           title: Error
       type: object
-      title: Envelope[list[UserForAdminGet]]
+      title: Envelope[list[UserAccountGet]]
     Envelope_list_UserGet__:
       properties:
         data:
@@ -13854,15 +13854,15 @@ components:
       - _links
       - data
       title: Page[ServiceRunGet]
-    Page_UserForAdminGet_:
+    Page_UserAccountGet_:
       properties:
         _meta:
           $ref: '#/components/schemas/PageMetaInfoLimitOffset'
         _links:
           $ref: '#/components/schemas/PageLinks'
         data:
           items:
-            $ref: '#/components/schemas/UserForAdminGet'
+            $ref: '#/components/schemas/UserAccountGet'
           type: array
           title: Data
       additionalProperties: false
@@ -13871,7 +13871,7 @@ components:
       - _meta
       - _links
       - data
-      title: Page[UserForAdminGet]
+      title: Page[UserAccountGet]
     PatchRequestBody:
       properties:
         value:
@@ -16996,21 +16996,7 @@ components:
       - number
       - e_tag
       title: UploadedPart
-    UserApprove:
-      properties:
-        email:
-          type: string
-          format: email
-          title: Email
-        invitation:
-          anyOf:
-          - $ref: '#/components/schemas/InvitationGenerate'
-          - type: 'null'
-      type: object
-      required:
-      - email
-      title: UserApprove
-    UserForAdminGet:
+    UserAccountGet:
       properties:
         firstName:
           anyOf:
@@ -17125,7 +17111,21 @@ components:
       - accountRequestStatus
       - registered
       - status
-      title: UserForAdminGet
+      title: UserAccountGet
+    UserApprove:
+      properties:
+        email:
+          type: string
+          format: email
+          title: Email
+        invitation:
+          anyOf:
+          - $ref: '#/components/schemas/InvitationGenerate'
+          - type: 'null'
+      type: object
+      required:
+      - email
+      title: UserApprove
     UserGet:
       properties:
         userId:

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

@@ -1,18 +1,17 @@
-""" input/output datasets used in the rest-API
+"""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
 """
 
-
 import re
 import sys
 from contextlib import suppress
 from typing import Annotated, Any, Final
 
 import pycountry
 from models_library.api_schemas_webserver._base import InputSchema
-from models_library.api_schemas_webserver.users import UserForAdminGet
+from models_library.api_schemas_webserver.users import UserAccountGet
 from models_library.emails import LowerCaseEmailStr
 from models_library.users import UserID
 from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
@@ -110,5 +109,5 @@ def _pre_check_and_normalize_country(cls, v):
 
 # asserts field names are in sync
 assert set(PreRegisteredUserGet.model_fields).issubset(
-    UserForAdminGet.model_fields
+    UserAccountGet.model_fields
 )  # nosec