refactor: update api doc

Author: ziyujiahao

backend/apps/dashboard/api/dashboard_api.py

@@ -1,31 +1,34 @@
+from typing import List
+
 from fastapi import APIRouter, File, UploadFile, HTTPException
 
 from apps.dashboard.crud.dashboard_service import list_resource, load_resource, \
     create_resource, create_canvas, validate_name, delete_resource, update_resource, update_canvas
-from apps.dashboard.models.dashboard_model import CreateDashboard, BaseDashboard, QueryDashboard, DashboardResponse
+from apps.dashboard.models.dashboard_model import CreateDashboard, BaseDashboard, QueryDashboard
+from apps.swagger.i18n import PLACEHOLDER_PREFIX
 from common.audit.models.log_model import OperationType, OperationModules
 from common.audit.schemas.logger_decorator import LogConfig, system_log
 from common.core.deps import SessionDep, CurrentUser
 
-router = APIRouter(tags=["dashboard"], prefix="/dashboard")
+router = APIRouter(tags=["Dashboard"], prefix="/dashboard")
 
 
-@router.post("/list_resource")
+@router.post("/list_resource", summary=f"{PLACEHOLDER_PREFIX}list_resource_api")
 async def list_resource_api(session: SessionDep, dashboard: QueryDashboard, current_user: CurrentUser):
     return list_resource(session=session, dashboard=dashboard, current_user=current_user)
 
 
-@router.post("/load_resource")
+@router.post("/load_resource", summary=f"{PLACEHOLDER_PREFIX}load_resource_api")
 async def load_resource_api(session: SessionDep, dashboard: QueryDashboard):
     return load_resource(session=session, dashboard=dashboard)
 
 
-@router.post("/create_resource", response_model=BaseDashboard)
+@router.post("/create_resource", response_model=BaseDashboard, summary=f"{PLACEHOLDER_PREFIX}create_resource_api")
 async def create_resource_api(session: SessionDep, user: CurrentUser, dashboard: CreateDashboard):
     return create_resource(session, user, dashboard)
 
 
-@router.post("/update_resource", response_model=BaseDashboard)
+@router.post("/update_resource", response_model=BaseDashboard, summary=f"{PLACEHOLDER_PREFIX}update_resource")
 @system_log(LogConfig(
     operation_type=OperationType.UPDATE,
     module=OperationModules.DASHBOARD,
@@ -35,7 +38,7 @@ async def update_resource_api(session: SessionDep, user: CurrentUser, dashboard:
     return update_resource(session=session, user=user, dashboard=dashboard)
 
 
-@router.delete("/delete_resource/{resource_id}/{name}")
+@router.delete("/delete_resource/{resource_id}/{name}", summary=f"{PLACEHOLDER_PREFIX}delete_resource_api")
 @system_log(LogConfig(
     operation_type=OperationType.DELETE,
     module=OperationModules.DASHBOARD,
@@ -46,7 +49,7 @@ async def delete_resource_api(session: SessionDep, resource_id: str, name: str):
     return delete_resource(session, resource_id)
 
 
-@router.post("/create_canvas", response_model=BaseDashboard)
+@router.post("/create_canvas", response_model=BaseDashboard, summary=f"{PLACEHOLDER_PREFIX}create_canvas_api")
 @system_log(LogConfig(
     operation_type=OperationType.CREATE,
     module=OperationModules.DASHBOARD,
@@ -56,7 +59,7 @@ async def create_canvas_api(session: SessionDep, user: CurrentUser, dashboard: C
     return create_canvas(session, user, dashboard)
 
 
-@router.post("/update_canvas", response_model=BaseDashboard)
+@router.post("/update_canvas", response_model=BaseDashboard, summary=f"{PLACEHOLDER_PREFIX}update_canvas_api")
 @system_log(LogConfig(
     operation_type=OperationType.UPDATE,
     module=OperationModules.DASHBOARD,
@@ -66,6 +69,6 @@ async def update_canvas_api(session: SessionDep, user: CurrentUser, dashboard: C
     return update_canvas(session, user, dashboard)
 
 
-@router.post("/check_name")
+@router.post("/check_name", summary=f"{PLACEHOLDER_PREFIX}check_name_api")
 async def check_name_api(session: SessionDep, user: CurrentUser, dashboard: QueryDashboard):
     return validate_name(session, user, dashboard)

backend/apps/swagger/i18n.py

@@ -50,6 +50,9 @@ def load_translation(lang: str) -> Dict[str, str]:
         "name": "Datasource",
         "description": f"{PLACEHOLDER_PREFIX}ds_api"
     },
+    {"name": "Dashboard",
+     "description": f"{PLACEHOLDER_PREFIX}db_api"
+     },
     {
         "name": "system_user",
         "description": f"{PLACEHOLDER_PREFIX}system_user_api"

backend/apps/swagger/locales/en.json

@@ -82,7 +82,7 @@
   "ws_del_api": "Delete Workspace",
 
   "weight": "Weight (1: Admin, 0: Regular User)",
-  
+
   "system_model_api": "Model Configuration APIs",
   "system_model_default": "Set Default Model",
   "system_model_grid": "Get Model List",
@@ -123,7 +123,7 @@
   "authentication_enable_api": "Enable Authentication",
   "authentication_status_api": "Get Authentication Status",
   "authentication_validate_api": "Validate Authentication",
-  
+
   "per_api": "Data Permission",
   "per_save": "Save Permission",
   "per_delete": "Delete Permission",
@@ -178,5 +178,15 @@
   "delete_custom_prompt": "Delete Custom Prompt",
   "export_custom_prompt": "Export Custom Prompts",
   "excel_template_custom_prompt": "Download Template",
-  "upload_custom_prompt": "Import Custom Prompts"
+  "upload_custom_prompt": "Import Custom Prompts",
+
+  "db_api": "Dashboard Interface",
+  "list_resource_api": "Load Resource Tree",
+  "load_resource_api": "Load Resource Tree Details",
+  "create_resource_api": "Create Resource",
+  "update_resource": "Update Resource",
+  "delete_resource_api": "Delete Resource",
+  "create_canvas_api": "Create Dashboard",
+  "update_canvas_api": "Update Dashboard",
+  "check_name_api": "Name Validation"
 }

backend/apps/swagger/locales/zh.json

@@ -178,5 +178,15 @@
   "delete_custom_prompt": "删除自定义提示词",
   "export_custom_prompt": "导出自定义提示词",
   "excel_template_custom_prompt": "下载模板",
-  "upload_custom_prompt": "导入自定义提示词"
+  "upload_custom_prompt": "导入自定义提示词",
+
+  "db_api": "仪表板接口",
+  "list_resource_api": "加载资源树",
+  "load_resource_api": "加载资源树明细",
+  "create_resource_api": "创建资源",
+  "update_resource": "更新资源",
+  "delete_resource_api": "删除资源",
+  "create_canvas_api": "新建仪表板",
+  "update_canvas_api": "更新仪表板",
+  "check_name_api": "名称校验"
 }