feat: add nick_name parameter to user API for enhanced user retrieval

Author: wxg0103

apps/users/api/user.py

@@ -6,15 +6,15 @@
     @date：2025/4/14 19:23
     @desc:
 """
+from django.utils.translation import gettext_lazy as _
 from drf_spectacular.types import OpenApiTypes
 from drf_spectacular.utils import OpenApiParameter
+from rest_framework import serializers
 
 from common.mixins.api_mixin import APIMixin
 from common.result import ResultSerializer, DefaultResultSerializer
 from users.serializers.user import UserProfileResponse, CreateUserSerializer, UserManageSerializer, \
     UserInstanceSerializer, RePasswordSerializer, CheckCodeSerializer, SendEmailSerializer
-from django.utils.translation import gettext_lazy as _
-from rest_framework import serializers
 
 
 class ApiUserProfileResponse(ResultSerializer):
@@ -171,7 +171,15 @@ def get_parameters():
             type=OpenApiTypes.STR,
             location=OpenApiParameter.PATH,
             required=False,
-        )]
+        ),
+            OpenApiParameter(
+                name="nick_name",
+                description=_('Nickname'),
+                type=OpenApiTypes.STR,
+                location=OpenApiParameter.QUERY,
+                required=False,
+            )
+        ]
 
     @staticmethod
     def get_response():

apps/users/views/user.py

@@ -11,22 +11,22 @@
 from django.core.cache import cache
 from django.db.models import QuerySet
 from django.utils.translation import gettext_lazy as _
-from drf_spectacular.utils import extend_schema
+from drf_spectacular.types import OpenApiTypes
+from drf_spectacular.utils import extend_schema, OpenApiParameter
 from rest_framework.request import Request
 from rest_framework.views import APIView
 
 from common.auth.authenticate import TokenAuth
 from common.auth.authentication import has_permissions
 from common.constants.cache_version import Cache_Version
-from common.constants.permission_constants import PermissionConstants, Permission, Group, Operate, RoleConstants
+from common.constants.permission_constants import PermissionConstants, RoleConstants
 from common.exception.app_exception import AppApiException
 from common.log.log import log
 from common.result import result
 from common.utils.common import query_params_to_single_dict
 from common.utils.rsa_util import decrypt
 from maxkb.const import CONFIG
 from models_provider.api.model import DefaultModelResponse
-from tools.serializers.tool import encryption
 from users.api.user import UserProfileAPI, TestWorkspacePermissionUserApi, DeleteUserApi, EditUserApi, \
     ChangeUserPasswordApi, UserPageApi, UserListApi, UserPasswordResponse, WorkspaceUserAPI, ResetPasswordAPI, \
     SendEmailAPI, CheckCodeAPI, SwitchUserLanguageAPI
@@ -131,6 +131,13 @@ class UserList(APIView):
                    description=_("Get all user"),
                    operation_id=_("Get all user"),  # type: ignore
                    tags=[_("User Management")],  # type: ignore
+                   parameters=[OpenApiParameter(
+                       name="nick_name",
+                       description=_('Nickname'),
+                       type=OpenApiTypes.STR,
+                       location=OpenApiParameter.QUERY,  # type: ignore
+                       required=False,
+                   )],
                    responses=UserListApi.get_response())
     @has_permissions(RoleConstants.WORKSPACE_MANAGE, RoleConstants.ADMIN, RoleConstants.EXTENDS_ADMIN,
                      RoleConstants.EXTENDS_WORKSPACE_MANAGE, RoleConstants.USER, RoleConstants.EXTENDS_USER)