Optimize global

Author: wu-clan

backend/app/admin/api/v1/log/login_log.py

@@ -43,7 +43,7 @@ async def get_pagination_login_logs(
         DependsRBAC,
     ],
 )
-async def delete_login_log(pk: Annotated[list[int], Query(..., description='登录日志 ID 列表')]) -> ResponseModel:
+async def delete_login_log(pk: Annotated[list[int], Query(description='登录日志 ID 列表')]) -> ResponseModel:
     count = await login_log_service.delete(pk=pk)
     if count > 0:
         return response_base.success()

backend/app/admin/api/v1/log/opera_log.py

@@ -43,7 +43,7 @@ async def get_pagination_opera_logs(
         DependsRBAC,
     ],
 )
-async def delete_opera_log(pk: Annotated[list[int], Query(..., description='操作日志 ID 列表')]) -> ResponseModel:
+async def delete_opera_log(pk: Annotated[list[int], Query(description='操作日志 ID 列表')]) -> ResponseModel:
     count = await opera_log_service.delete(pk=pk)
     if count > 0:
         return response_base.success()

backend/app/admin/api/v1/sys/__init__.py

@@ -16,7 +16,7 @@
 
 router = APIRouter(prefix='/sys')
 
-router.include_router(config_router, prefix='/configs', tags=['系统配置'])
+router.include_router(config_router, prefix='/configs', tags=['系统参数配置'])
 router.include_router(dept_router, prefix='/depts', tags=['系统部门'])
 router.include_router(dict_data_router, prefix='/dict-datas', tags=['系统字典数据'])
 router.include_router(dict_type_router, prefix='/dict-types', tags=['系统字典类型'])

backend/app/admin/api/v1/sys/config.py

@@ -21,15 +21,15 @@
 router = APIRouter()
 
 
-@router.get('/website', summary='获取网站配置', dependencies=[DependsJwtAuth])
+@router.get('/website', summary='获取网站参数配置', dependencies=[DependsJwtAuth])
 async def get_website_config() -> ResponseSchemaModel[list[GetConfigDetail]]:
     config = await config_service.get_built_in_config('website')
     return response_base.success(data=config)
 
 
 @router.post(
     '/website',
-    summary='保存网站配置',
+    summary='保存网站参数配置',
     dependencies=[
         Depends(RequestPermission('sys:config:website:add')),
         DependsRBAC,
@@ -78,23 +78,23 @@ async def save_policy_config(objs: list[SaveBuiltInConfigParam]) -> ResponseMode
     return response_base.success()
 
 
-@router.get('/{pk}', summary='获取配置详情', dependencies=[DependsJwtAuth])
-async def get_config(pk: Annotated[int, Path(..., description='配置 ID')]) -> ResponseSchemaModel[GetConfigDetail]:
+@router.get('/{pk}', summary='获取参数配置详情', dependencies=[DependsJwtAuth])
+async def get_config(pk: Annotated[int, Path(description='参数配置 ID')]) -> ResponseSchemaModel[GetConfigDetail]:
     config = await config_service.get(pk)
     return response_base.success(data=config)
 
 
 @router.get(
     '',
-    summary='分页获取所有配置',
+    summary='分页获取所有参数配置',
     dependencies=[
         DependsJwtAuth,
         DependsPagination,
     ],
 )
 async def get_pagination_configs(
     db: CurrentSession,
-    name: Annotated[str | None, Query(description='配置名称')] = None,
+    name: Annotated[str | None, Query(description='参数配置名称')] = None,
     type: Annotated[str | None, Query()] = None,
 ) -> ResponseSchemaModel[PageData[GetConfigDetail]]:
     config_select = await config_service.get_select(name=name, type=type)
@@ -104,7 +104,7 @@ async def get_pagination_configs(
 
 @router.post(
     '',
-    summary='创建配置',
+    summary='创建参数配置',
     dependencies=[
         Depends(RequestPermission('sys:config:add')),
         DependsRBAC,
@@ -117,13 +117,13 @@ async def create_config(obj: CreateConfigParam) -> ResponseModel:
 
 @router.put(
     '/{pk}',
-    summary='更新配置',
+    summary='更新参数配置',
     dependencies=[
         Depends(RequestPermission('sys:config:edit')),
         DependsRBAC,
     ],
 )
-async def update_config(pk: Annotated[int, Path(..., description='配置 ID')], obj: UpdateConfigParam) -> ResponseModel:
+async def update_config(pk: Annotated[int, Path(description='参数配置 ID')], obj: UpdateConfigParam) -> ResponseModel:
     count = await config_service.update(pk=pk, obj=obj)
     if count > 0:
         return response_base.success()
@@ -132,13 +132,13 @@ async def update_config(pk: Annotated[int, Path(..., description='配置 ID')],
 
 @router.delete(
     '',
-    summary='批量删除配置',
+    summary='批量删除参数配置',
     dependencies=[
         Depends(RequestPermission('sys:config:del')),
         DependsRBAC,
     ],
 )
-async def delete_config(pk: Annotated[list[int], Query(..., description='配置 ID 列表')]) -> ResponseModel:
+async def delete_config(pk: Annotated[list[int], Query(description='参数配置 ID 列表')]) -> ResponseModel:
     count = await config_service.delete(pk=pk)
     if count > 0:
         return response_base.success()

backend/app/admin/api/v1/sys/data_rule.py

@@ -38,7 +38,7 @@ async def get_all_data_rules() -> ResponseSchemaModel[list[GetDataRuleDetail]]:
 
 @router.get('/{pk}', summary='获取数据权限规则详情', dependencies=[DependsJwtAuth])
 async def get_data_rule(
-    pk: Annotated[int, Path(..., description='数据规则 ID')],
+    pk: Annotated[int, Path(description='数据规则 ID')],
 ) -> ResponseSchemaModel[GetDataRuleDetail]:
     data = await data_rule_service.get(pk=pk)
     return response_base.success(data=data)
@@ -82,7 +82,7 @@ async def create_data_rule(obj: CreateDataRuleParam) -> ResponseModel:
     ],
 )
 async def update_data_rule(
-    pk: Annotated[int, Path(..., description='数据规则 ID')], obj: UpdateDataRuleParam
+    pk: Annotated[int, Path(description='数据规则 ID')], obj: UpdateDataRuleParam
 ) -> ResponseModel:
     count = await data_rule_service.update(pk=pk, obj=obj)
     if count > 0:
@@ -99,7 +99,7 @@ async def update_data_rule(
     ],
 )
 async def delete_data_rule(
-    request: Request, pk: Annotated[list[int], Query(..., description='数据规则 ID 列表')]
+    request: Request, pk: Annotated[list[int], Query(description='数据规则 ID 列表')]
 ) -> ResponseModel:
     count = await data_rule_service.delete(request=request, pk=pk)
     if count > 0:

backend/app/admin/api/v1/sys/dept.py

@@ -15,7 +15,7 @@
 
 
 @router.get('/{pk}', summary='获取部门详情', dependencies=[DependsJwtAuth])
-async def get_dept(pk: Annotated[int, Path(..., description='部门 ID')]) -> ResponseSchemaModel[GetDeptDetail]:
+async def get_dept(pk: Annotated[int, Path(description='部门 ID')]) -> ResponseSchemaModel[GetDeptDetail]:
     data = await dept_service.get(pk=pk)
     return response_base.success(data=data)
 
@@ -52,7 +52,7 @@ async def create_dept(obj: CreateDeptParam) -> ResponseModel:
         DependsRBAC,
     ],
 )
-async def update_dept(pk: Annotated[int, Path(..., description='部门 ID')], obj: UpdateDeptParam) -> ResponseModel:
+async def update_dept(pk: Annotated[int, Path(description='部门 ID')], obj: UpdateDeptParam) -> ResponseModel:
     count = await dept_service.update(pk=pk, obj=obj)
     if count > 0:
         return response_base.success()
@@ -67,7 +67,7 @@ async def update_dept(pk: Annotated[int, Path(..., description='部门 ID')], ob
         DependsRBAC,
     ],
 )
-async def delete_dept(request: Request, pk: Annotated[int, Path(..., description='部门 ID')]) -> ResponseModel:
+async def delete_dept(request: Request, pk: Annotated[int, Path(description='部门 ID')]) -> ResponseModel:
     count = await dept_service.delete(request=request, pk=pk)
     if count > 0:
         return response_base.success()

backend/app/admin/api/v1/sys/dict_data.py

@@ -23,7 +23,7 @@
 
 @router.get('/{pk}', summary='获取字典详情', dependencies=[DependsJwtAuth])
 async def get_dict_data(
-    pk: Annotated[int, Path(..., description='字典数据 ID')],
+    pk: Annotated[int, Path(description='字典数据 ID')],
 ) -> ResponseSchemaModel[GetDictDataWithRelation]:
     data = await dict_data_service.get(pk=pk)
     return response_base.success(data=data)
@@ -70,7 +70,7 @@ async def create_dict_data(obj: CreateDictDataParam) -> ResponseModel:
     ],
 )
 async def update_dict_data(
-    pk: Annotated[int, Path(..., description='字典数据 ID')], obj: UpdateDictDataParam
+    pk: Annotated[int, Path(description='字典数据 ID')], obj: UpdateDictDataParam
 ) -> ResponseModel:
     count = await dict_data_service.update(pk=pk, obj=obj)
     if count > 0:
@@ -86,7 +86,7 @@ async def update_dict_data(
         DependsRBAC,
     ],
 )
-async def delete_dict_data(pk: Annotated[list[int], Query(..., description='字典数据 ID 列表')]) -> ResponseModel:
+async def delete_dict_data(pk: Annotated[list[int], Query(description='字典数据 ID 列表')]) -> ResponseModel:
     count = await dict_data_service.delete(pk=pk)
     if count > 0:
         return response_base.success()

backend/app/admin/api/v1/sys/dict_type.py

@@ -57,7 +57,7 @@ async def create_dict_type(obj: CreateDictTypeParam) -> ResponseModel:
     ],
 )
 async def update_dict_type(
-    pk: Annotated[int, Path(..., description='字典类型 ID')], obj: UpdateDictTypeParam
+    pk: Annotated[int, Path(description='字典类型 ID')], obj: UpdateDictTypeParam
 ) -> ResponseModel:
     count = await dict_type_service.update(pk=pk, obj=obj)
     if count > 0:
@@ -73,7 +73,7 @@ async def update_dict_type(
         DependsRBAC,
     ],
 )
-async def delete_dict_type(pk: Annotated[list[int], Query(..., description='字典类型 ID 列表')]) -> ResponseModel:
+async def delete_dict_type(pk: Annotated[list[int], Query(description='字典类型 ID 列表')]) -> ResponseModel:
     count = await dict_type_service.delete(pk=pk)
     if count > 0:
         return response_base.success()

backend/app/admin/api/v1/sys/menu.py

@@ -21,7 +21,7 @@ async def get_user_sidebar(request: Request) -> ResponseSchemaModel[list[dict[st
 
 
 @router.get('/{pk}', summary='获取菜单详情', dependencies=[DependsJwtAuth])
-async def get_menu(pk: Annotated[int, Path(..., description='菜单 ID')]) -> ResponseSchemaModel[GetMenuDetail]:
+async def get_menu(pk: Annotated[int, Path(description='菜单 ID')]) -> ResponseSchemaModel[GetMenuDetail]:
     data = await menu_service.get(pk=pk)
     return response_base.success(data=data)
 
@@ -56,7 +56,7 @@ async def create_menu(obj: CreateMenuParam) -> ResponseModel:
         DependsRBAC,
     ],
 )
-async def update_menu(pk: Annotated[int, Path(..., description='菜单 ID')], obj: UpdateMenuParam) -> ResponseModel:
+async def update_menu(pk: Annotated[int, Path(description='菜单 ID')], obj: UpdateMenuParam) -> ResponseModel:
     count = await menu_service.update(pk=pk, obj=obj)
     if count > 0:
         return response_base.success()
@@ -71,7 +71,7 @@ async def update_menu(pk: Annotated[int, Path(..., description='菜单 ID')], ob
         DependsRBAC,
     ],
 )
-async def delete_menu(request: Request, pk: Annotated[int, Path(..., description='菜单 ID 列表')]) -> ResponseModel:
+async def delete_menu(request: Request, pk: Annotated[int, Path(description='菜单 ID 列表')]) -> ResponseModel:
     count = await menu_service.delete(request=request, pk=pk)
     if count > 0:
         return response_base.success()

backend/app/admin/api/v1/sys/plugin.py

@@ -78,7 +78,7 @@ async def install_plugin(file: Annotated[UploadFile, File()]) -> ResponseModel:
         DependsRBAC,
     ],
 )
-async def build_plugin(plugin: Annotated[str, Query(..., description='插件名称')]) -> StreamingResponse:
+async def build_plugin(plugin: Annotated[str, Query(description='插件名称')]) -> StreamingResponse:
     plugin_dir = os.path.join(PLUGIN_DIR, plugin)
     if not os.path.exists(plugin_dir):
         raise errors.ForbiddenError(msg='插件不存在')