resolve: solve some problems

TencentBlueKing · Jan 16, 2025 · f1ec797 · f1ec797
1 parent c3f568c
commit f1ec797
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 35 deletions.
diff --git a/src/bk-user/bkuser/apis/open_v3/pagination.py b/src/bk-user/bkuser/apis/open_v3/pagination.py
diff --git a/src/bk-user/bkuser/apis/open_v3/serializers/user.py b/src/bk-user/bkuser/apis/open_v3/serializers/user.py
@@ -78,3 +78,7 @@ def get_display_name(self, obj: TenantUser) -> str:
 class TenantUserListOutputSLZ(serializers.Serializer):
     bk_username = serializers.CharField(help_text="蓝鲸用户唯一标识", source="id")
     full_name = serializers.CharField(help_text="姓名", source="data_source_user.full_name")
+    display_name = serializers.SerializerMethodField(help_text="用户展示名称")
+
+    def get_display_name(self, obj: TenantUser) -> str:
+        return TenantUserHandler.generate_tenant_user_display_name(obj)
diff --git a/src/bk-user/bkuser/apis/open_v3/views/user.py b/src/bk-user/bkuser/apis/open_v3/views/user.py
@@ -24,7 +24,6 @@
 from rest_framework.response import Response
 
 from bkuser.apis.open_v3.mixins import OpenApiCommonMixin
-from bkuser.apis.open_v3.pagination import OpenApiPagination
 from bkuser.apis.open_v3.serializers.user import (
     TenantUserDepartmentListInputSLZ,
     TenantUserDepartmentListOutputSLZ,
@@ -41,6 +40,7 @@
 )
 from bkuser.apps.tenant.models import TenantDepartment, TenantUser
 from bkuser.biz.organization import DataSourceDepartmentHandler
+from bkuser.common.pagination import CustomPageNumberPagination
 
 logger = logging.getLogger(__name__)
 
@@ -218,7 +218,8 @@ class TenantUserListApi(OpenApiCommonMixin, generics.ListAPIView):
     查询用户列表
     """
 
-    pagination_class = OpenApiPagination
+    pagination_class = CustomPageNumberPagination
+    pagination_class.max_page_size = 1000
 
     serializer_class = TenantUserListOutputSLZ
 

diff --git a/src/bk-user/support-files/apidocs/en/list_user.md b/src/bk-user/support-files/apidocs/en/list_user.md
@@ -26,10 +26,12 @@ page=1&page_size=5
       {
         "bk_username": "q9k6bhqks0ckl5ew",
         "full_name": "张三",
+        "display_name": "张三",
       },
       {
         "bk_username": "er0ugcammqwf1q5w",
         "full_name": "李四",
+        "display_name": "李四",
       }
     ],
   }
@@ -38,10 +40,11 @@ page=1&page_size=5
 
 ### Response Parameters Description
 
-| Name        | Type   | Description                       |
-|-------------|--------|-----------------------------------|
-| bk_username | string | Blueking user's unique identifier |
-| full_name   | string | User's name                       |
+| Name         | Type   | Description                       |
+|--------------|--------|-----------------------------------|
+| bk_username  | string | Blueking user's unique identifier |
+| full_name    | string | User's name                       |
+| display_name | string | User's display name               |
 
 # Response Example for Non-200 Status Code
 

diff --git a/src/bk-user/support-files/apidocs/zh/list_user.md b/src/bk-user/support-files/apidocs/zh/list_user.md
@@ -26,10 +26,12 @@ page=1&page_size=5
       {
         "bk_username": "q9k6bhqks0ckl5ew",
         "full_name": "张三",
+        "display_name": "张三",
       },
       {
         "bk_username": "er0ugcammqwf1q5w",
         "full_name": "李四",
+        "display_name": "李四",
       }
     ],
   }
@@ -38,10 +40,11 @@ page=1&page_size=5
 
 ### 响应参数说明
 
-| 参数名称        | 参数类型   | 描述       |
-|-------------|--------|----------|
-| bk_username | string | 蓝鲸用户唯一标识 |
-| full_name   | string | 用户姓名     |
+| 参数名称         | 参数类型   | 描述       |
+|--------------|--------|----------|
+| bk_username  | string | 蓝鲸用户唯一标识 |
+| full_name    | string | 用户姓名     |
+| display_name | string | 用户展示名    |
 
 ### 状态码非 200 的响应示例
 

diff --git a/src/bk-user/tests/apis/open_v3/test_user.py b/src/bk-user/tests/apis/open_v3/test_user.py
@@ -182,3 +182,16 @@ def test_standard(self, api_client, random_tenant):
             "白十二",
             "自由人",
         }
+        assert {t["display_name"] for t in resp.data["results"]} == {
+            "张三",
+            "李四",
+            "王五",
+            "赵六",
+            "柳七",
+            "麦八",
+            "杨九",
+            "鲁十",
+            "林十一",
+            "白十二",
+            "自由人",
+        }