feat: user manage

Author: wxg0103

apps/common/constants/permission_constants.py

@@ -154,7 +154,7 @@ class PermissionConstants(Enum):
     USER_READ = Permission(group=Group.USER, operate=Operate.READ, role_list=[RoleConstants.ADMIN,
                                                                               RoleConstants.USER])
     USER_CREATE = Permission(group=Group.USER, operate=Operate.CREATE,
-                             role_list=[RoleConstants.ADMIN, RoleConstants.USER])
+                             role_list=[RoleConstants.ADMIN])
     USER_EDIT = Permission(group=Group.USER, operate=Operate.EDIT, role_list=[RoleConstants.ADMIN])
     USER_DELETE = Permission(group=Group.USER, operate=Operate.DELETE, role_list=[RoleConstants.ADMIN])
 

apps/models_provider/urls.py

@@ -4,19 +4,14 @@
 
 app_name = "models_provider"
 urlpatterns = [
-    path('provider', views.Provide.as_view(), name='provide'),
-    path('provider/model_type_list', views.Provide.ModelTypeList.as_view(), name="provider/model_type_list"),
-    path('provider/model_list', views.Provide.ModelList.as_view(), name="provider/model_name_list"),
-    path('provider/model_params_form', views.Provide.ModelParamsForm.as_view(),
-         name="provider/model_params_form"),
-    path('provider/model_form', views.Provide.ModelForm.as_view(),
-         name="provider/model_form"),
-    path('workspace/<str:workspace_id>/model', views.Model.as_view(), name='model'),
-    path('workspace/<str:workspace_id>/model/<str:model_id>/model_params_form', views.Model.ModelParamsForm.as_view(),
-         name='model/model_params_form'),
-    path('workspace/<str:workspace_id>/model/<str:model_id>', views.Model.Operate.as_view(), name='model/operate'),
-    path('workspace/<str:workspace_id>/model/<str:model_id>/pause_download', views.Model.PauseDownload.as_view(),
-         name='model/operate'),
-    path('workspace/<str:workspace_id>/model/<str:model_id>/meta', views.Model.ModelMeta.as_view(),
-         name='model/operate/meta'),
+    path('provider', views.Provide.as_view()),
+    path('provider/model_type_list', views.Provide.ModelTypeList.as_view()),
+    path('provider/model_list', views.Provide.ModelList.as_view()),
+    path('provider/model_params_form', views.Provide.ModelParamsForm.as_view()),
+    path('provider/model_form', views.Provide.ModelForm.as_view()),
+    path('workspace/<str:workspace_id>/model', views.Model.as_view()),
+    path('workspace/<str:workspace_id>/model/<str:model_id>/model_params_form', views.Model.ModelParamsForm.as_view()),
+    path('workspace/<str:workspace_id>/model/<str:model_id>', views.Model.Operate.as_view()),
+    path('workspace/<str:workspace_id>/model/<str:model_id>/pause_download', views.Model.PauseDownload.as_view()),
+    path('workspace/<str:workspace_id>/model/<str:model_id>/meta', views.Model.ModelMeta.as_view()),
 ]

apps/models_provider/views/model.py

@@ -14,7 +14,7 @@
 from common.auth import TokenAuth
 from common.auth.authentication import has_permissions
 from common.constants.permission_constants import PermissionConstants
-from common.result import result, DefaultResultSerializer
+from common.result import result
 from common.utils.common import query_params_to_single_dict
 from models_provider.api.model import ModelCreateAPI, GetModelApi, ModelEditApi, ModelListResponse, DefaultModelResponse
 from models_provider.api.provide import ProvideApi
@@ -25,6 +25,7 @@ class Model(APIView):
     authentication_classes = [TokenAuth]
 
     @extend_schema(methods=['POST'],
+                   summary=_("Create model"),
                    description=_("Create model"),
                    operation_id=_("Create model"),
                    tags=[_("Model")],
@@ -38,7 +39,7 @@ def post(self, request: Request, workspace_id: str):
                                                                                              with_valid=True))
 
     # @extend_schema(methods=['PUT'],
-    #                description=_('Update model'),
+    #                summary=_('Update model'),
     #                operation_id=_('Update model'),
     #                request=ModelEditApi.get_request(),
     #                responses=ModelCreateApi.get_response(),
@@ -50,6 +51,7 @@ def post(self, request: Request, workspace_id: str):
     #                                                                                               with_valid=True))
 
     @extend_schema(methods=['GET'],
+                   summary=_('Query model list'),
                    description=_('Query model list'),
                    operation_id=_('Query model list'),
                    parameters=ModelCreateAPI.get_query_params_api(),
@@ -66,6 +68,7 @@ class Operate(APIView):
         authentication_classes = [TokenAuth]
 
         @extend_schema(methods=['PUT'],
+                       summary=_('Update model'),
                        description=_('Update model'),
                        operation_id=_('Update model'),
                        request=ModelEditApi.get_request(),
@@ -79,6 +82,7 @@ def put(self, request: Request, workspace_id, model_id: str):
                                                                                                 str(request.user.id)))
 
         @extend_schema(methods=['DELETE'],
+                       summary=_('Delete model'),
                        description=_('Delete model'),
                        operation_id=_('Delete model'),
                        parameters=GetModelApi.get_query_params_api(),
@@ -90,6 +94,7 @@ def delete(self, request: Request, workspace_id: str, model_id: str):
                 ModelSerializer.Operate(data={'id': model_id, 'user_id': request.user.id}).delete())
 
         @extend_schema(methods=['GET'],
+                       summary=_('Query model details'),
                        description=_('Query model details'),
                        operation_id=_('Query model details'),
                        parameters=GetModelApi.get_query_params_api(),
@@ -104,6 +109,7 @@ class ModelParamsForm(APIView):
         authentication_classes = [TokenAuth]
 
         @extend_schema(methods=['GET'],
+                       summary=_('Get model parameter form'),
                        description=_('Get model parameter form'),
                        operation_id=_('Get model parameter form'),
                        parameters=GetModelApi.get_query_params_api(),
@@ -115,6 +121,7 @@ def get(self, request: Request, workspace_id: str, model_id: str):
                 ModelSerializer.ModelParams(data={'id': model_id}).get_model_params())
 
         @extend_schema(methods=['PUT'],
+                       summary=_('Save model parameter form'),
                        description=_('Save model parameter form'),
                        operation_id=_('Save model parameter form'),
                        parameters=GetModelApi.get_query_params_api(),
@@ -130,6 +137,8 @@ class ModelMeta(APIView):
         authentication_classes = [TokenAuth]
 
         @extend_schema(methods=['GET'],
+                       summary=_(
+                           'Query model meta information, this interface does not carry authentication information'),
                        description=_(
                            'Query model meta information, this interface does not carry authentication information'),
                        operation_id=_(
@@ -146,6 +155,7 @@ class PauseDownload(APIView):
         authentication_classes = [TokenAuth]
 
         @extend_schema(methods=['PUT'],
+                       summary=_('Pause model download'),
                        description=_('Pause model download'),
                        operation_id=_('Pause model download'),
                        parameters=GetModelApi.get_query_params_api(),

apps/models_provider/views/provide.py

@@ -18,6 +18,7 @@ class Provide(APIView):
     authentication_classes = [TokenAuth]
 
     @extend_schema(methods=['GET'],
+                   summary=_('Get a list of model suppliers'),
                    description=_('Get a list of model suppliers'),
                    operation_id=_('Get a list of model suppliers'),
                    responses=ProvideApi.get_response(),
@@ -40,6 +41,7 @@ class ModelTypeList(APIView):
         authentication_classes = [TokenAuth]
 
         @extend_schema(methods=['GET'],
+                       summary=_('Get a list of model types'),
                        description=_('Get a list of model types'),
                        operation_id=_('Get a list of model types'),
                        parameters=ProvideApi.ModelTypeList.get_query_params_api(),
@@ -54,6 +56,7 @@ class ModelList(APIView):
         authentication_classes = [TokenAuth]
 
         @extend_schema(methods=['GET'],
+                       summary=_('Example of obtaining model list'),
                        description=_('Example of obtaining model list'),
                        operation_id=_('Example of obtaining model list'),
                        parameters=ProvideApi.ModelList.get_query_params_api(),
@@ -72,6 +75,7 @@ class ModelParamsForm(APIView):
         authentication_classes = [TokenAuth]
 
         @extend_schema(methods=['GET'],
+                       summary=_('Get model default parameters'),
                        description=_('Get model default parameters'),
                        operation_id=_('Get model default parameters'),
                        parameters=ProvideApi.ModelParamsForm.get_query_params_api(),
@@ -89,6 +93,7 @@ class ModelForm(APIView):
         authentication_classes = [TokenAuth]
 
         @extend_schema(methods=['GET'],
+                       summary=_('Get the model creation form'),
                        description=_('Get the model creation form'),
                        operation_id=_('Get the model creation form'),
                        parameters=ProvideApi.ModelParamsForm.get_query_params_api(),

apps/users/api/user.py

@@ -11,7 +11,10 @@
 
 from common.mixins.api_mixin import APIMixin
 from common.result import ResultSerializer
-from users.serializers.user import UserProfileResponse, CreateUserSerializer
+from users.serializers.user import UserProfileResponse, CreateUserSerializer, UserManageSerializer, \
+    UserInstanceSerializer
+from django.utils.translation import gettext_lazy as _
+from rest_framework import serializers
 
 
 class ApiUserProfileResponse(ResultSerializer):
@@ -29,6 +32,87 @@ def get_response():
     def get_request():
         return CreateUserSerializer
 
+    @staticmethod
+    def get_parameters():
+        return [OpenApiParameter(
+            name="user_id",
+            description=_('User ID'),
+            type=OpenApiTypes.STR,
+            location=OpenApiParameter.PATH,
+            required=True,
+        )]
+
+
+class EditUserApi(APIMixin):
+    @staticmethod
+    def get_parameters():
+        return [OpenApiParameter(
+            name="user_id",
+            description=_('User ID'),
+            type=OpenApiTypes.STR,
+            location=OpenApiParameter.PATH,
+            required=True,
+        )]
+
+    @staticmethod
+    def get_request():
+        return UserManageSerializer.UserEditInstance
+
+
+class DeleteUserApi(APIMixin):
+    @staticmethod
+    def get_parameters():
+        return [OpenApiParameter(
+            name="user_id",
+            description=_('User ID'),
+            type=OpenApiTypes.STR,
+            location=OpenApiParameter.PATH,
+            required=True,
+        )]
+
+
+class ChangeUserPasswordApi(APIMixin):
+    @staticmethod
+    def get_request():
+        return UserManageSerializer.RePasswordInstance
+
+
+class UserListResponse(ResultSerializer):
+    def get_data(self):
+        return serializers.ListSerializer(child=UserInstanceSerializer())
+
+
+class UserPageApi(APIMixin):
+    @staticmethod
+    def get_parameters():
+        return [OpenApiParameter(
+            name="email_or_username",
+            description=_('Email or Username'),
+            type=OpenApiTypes.STR,
+            location=OpenApiParameter.QUERY,
+            required=False,
+        )]
+
+    @staticmethod
+    def get_response():
+        return UserListResponse
+
+
+class UserListApi(APIMixin):
+    @staticmethod
+    def get_parameters():
+        return [OpenApiParameter(
+            name="workspace_id",
+            description=_('Workspace ID'),
+            type=OpenApiTypes.STR,
+            location=OpenApiParameter.PATH,
+            required=False,
+        )]
+
+    @staticmethod
+    def get_response():
+        return UserListResponse
+
 
 class TestWorkspacePermissionUserApi(APIMixin):
     @staticmethod

apps/users/migrations/0001_initial.py

@@ -5,13 +5,15 @@
 
 from common.constants.permission_constants import RoleConstants
 from common.utils.common import password_encrypt
+from maxkb.const import CONFIG
 
+default_password = CONFIG.get('default_password', 'MaxKB@123..')
 
 def insert_default_data(apps, schema_editor):
     UserModel = apps.get_model('users', 'User')
     UserModel.objects.create(id='f0dd8f71-e4ee-11ee-8c84-a8a1595801ab', email='', username='admin',
                              nick_name="系统管理员",
-                             password=password_encrypt('MaxKB@123..'),
+                             password=password_encrypt(default_password),
                              role=RoleConstants.ADMIN.name,
                              is_active=True)