updates doc

ITISFoundation · Dec 17, 2024 · 5592677 · 5592677
1 parent 818588c
commit 5592677
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/packages/models-library/src/models_library/api_schemas_webserver/users.py b/packages/models-library/src/models_library/api_schemas_webserver/users.py
@@ -204,7 +204,7 @@ class UsersSearch(InputSchema):
         str,
         StringConstraints(strip_whitespace=True, min_length=1, max_length=80),
         Field(
-            description="Search string to match with public usernames and emails",
+            description="Search string to match with usernames and public profiles (e.g. emails, first/last name)",
             alias="match",
         ),
     ]

diff --git a/services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml b/services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml
@@ -14696,7 +14696,8 @@ components:
           maxLength: 80
           minLength: 1
           title: Match
-          description: Search string to match with public usernames and emails
+          description: Search string to match with usernames and public profiles (e.g.
+            emails, first/last name)
         limit:
           type: integer
           maximum: 50