From 5af041f5881fc6d6b7d9d5c5e2ecbf6537493394 Mon Sep 17 00:00:00 2001
From: zg <1352057131@qq.com>
Date: Thu, 9 Jul 2026 17:37:40 +0800
Subject: [PATCH] docs: document user list query parameters

---
 apps/users/api/user.py   | 33 ++++++++++++++++++---------------
 apps/users/views/user.py | 11 ++---------
 2 files changed, 20 insertions(+), 24 deletions(-)

diff --git a/apps/users/api/user.py b/apps/users/api/user.py
index a2b4931b969..0474d09c2ce 100644
--- a/apps/users/api/user.py
+++ b/apps/users/api/user.py
@@ -59,13 +59,22 @@ def get_parameters():
 class WorkspaceUserAPI(APIMixin):
     @staticmethod
     def get_parameters():
-        return [OpenApiParameter(
-            name="workspace_id",
-            description=_('Workspace ID'),
-            type=OpenApiTypes.STR,
-            location=OpenApiParameter.PATH,
-            required=True,
-        )]
+        return [
+            OpenApiParameter(
+                name="workspace_id",
+                description=_('Workspace ID'),
+                type=OpenApiTypes.STR,
+                location=OpenApiParameter.PATH,
+                required=True,
+            ),
+            OpenApiParameter(
+                name="nick_name",
+                description=_('Nick name'),
+                type=OpenApiTypes.STR,
+                location=OpenApiParameter.QUERY,
+                required=False,
+            )
+        ]
 
     @staticmethod
     def get_response():
@@ -165,16 +174,10 @@ def get_response():
 class UserListApi(APIMixin):
     @staticmethod
     def get_parameters():
-        return [OpenApiParameter(
-            name="workspace_id",
-            description=_('Workspace ID'),
-            type=OpenApiTypes.STR,
-            location=OpenApiParameter.PATH,
-            required=False,
-        ),
+        return [
             OpenApiParameter(
                 name="nick_name",
-                description=_('Nickname'),
+                description=_('Nick name'),
                 type=OpenApiTypes.STR,
                 location=OpenApiParameter.QUERY,
                 required=False,
diff --git a/apps/users/views/user.py b/apps/users/views/user.py
index ab0e5065f7c..b5c8afe898a 100644
--- a/apps/users/views/user.py
+++ b/apps/users/views/user.py
@@ -11,8 +11,7 @@
 from django.core.cache import cache
 from django.db.models import QuerySet
 from django.utils.translation import gettext_lazy as _
-from drf_spectacular.types import OpenApiTypes
-from drf_spectacular.utils import extend_schema, OpenApiParameter
+from drf_spectacular.utils import extend_schema
 from rest_framework.request import Request
 from rest_framework.views import APIView
 
@@ -131,13 +130,7 @@ 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,
-                   )],
+                   parameters=UserListApi.get_parameters(),
                    responses=UserListApi.get_response())
     @has_permissions(RoleConstants.WORKSPACE_MANAGE, RoleConstants.ADMIN, RoleConstants.EXTENDS_ADMIN,
                      RoleConstants.EXTENDS_WORKSPACE_MANAGE, RoleConstants.USER, RoleConstants.EXTENDS_USER)