Skip to content

Commit b10d83a

Browse files
Merge branch 'main' into pr@main@feat_user_ws_api_doc
2 parents 85a5324 + 589c85b commit b10d83a

File tree

5 files changed

+81
-49
lines changed

5 files changed

+81
-49
lines changed

backend/apps/datasource/api/table_relation.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,18 @@
22
# Date: 2025/9/24
33
from typing import List
44

5-
from fastapi import APIRouter
5+
from fastapi import APIRouter, Path
66

77
from apps.datasource.models.datasource import CoreDatasource
8+
from apps.swagger.i18n import PLACEHOLDER_PREFIX
89
from common.core.deps import SessionDep
910

10-
router = APIRouter(tags=["table_relation"], prefix="/table_relation")
11+
router = APIRouter(tags=["Table Relation"], prefix="/table_relation")
1112

1213

13-
@router.post("/save/{ds_id}")
14-
async def save_relation(session: SessionDep, ds_id: int, relation: List[dict]):
14+
@router.post("/save/{ds_id}", response_model=List[dict], summary=f"{PLACEHOLDER_PREFIX}tr_save")
15+
async def save_relation(session: SessionDep, relation: List[dict],
16+
ds_id: int = Path(..., description=f"{PLACEHOLDER_PREFIX}ds_id")):
1517
ds = session.get(CoreDatasource, ds_id)
1618
if ds:
1719
ds.table_relation = relation
@@ -21,8 +23,8 @@ async def save_relation(session: SessionDep, ds_id: int, relation: List[dict]):
2123
return True
2224

2325

24-
@router.post("/get/{ds_id}")
25-
async def save_relation(session: SessionDep, ds_id: int):
26+
@router.post("/get/{ds_id}", response_model=List[dict], summary=f"{PLACEHOLDER_PREFIX}tr_get")
27+
async def save_relation(session: SessionDep, ds_id: int = Path(..., description=f"{PLACEHOLDER_PREFIX}ds_id")):
2628
ds = session.get(CoreDatasource, ds_id)
2729
if ds:
2830
return ds.table_relation if ds.table_relation else []

backend/apps/mcp/mcp.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
tokenUrl=f"{settings.API_V1_STR}/login/access-token"
3434
)
3535

36-
router = APIRouter(tags=["mcp"], prefix="/mcp")
36+
router = APIRouter(tags=["mcp"], prefix="/mcp", include_in_schema=False)
3737

3838

3939
# @router.post("/access_token", operation_id="access_token")

backend/apps/swagger/i18n.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,14 @@ def load_translation(lang: str) -> Dict[str, str]:
5454
"name": "system_ws",
5555
"description": f"{PLACEHOLDER_PREFIX}system_ws_api"
5656
}
57+
"name": "Table Relation",
58+
"description": f"{PLACEHOLDER_PREFIX}tr_api"
59+
},
60+
{
61+
"name": "Data Permission",
62+
"description": f"{PLACEHOLDER_PREFIX}per_api"
63+
},
64+
5765
]
5866

5967

backend/apps/swagger/locales/en.json

Lines changed: 53 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -24,48 +24,59 @@
2424
"ds_excel": "File",
2525

2626
"system": "System Management",
27-
"system_user_api": "User APIs",
28-
"system_user_current_user": "Get Current User",
29-
"system_user_current_user_desc": "Retrieve information of the currently logged-in user",
30-
"system_user_grid": "Get User List",
31-
"user_name": "Username",
32-
"user_account": "Account",
33-
"user_email": "User Email",
34-
"page_num": "Page Number",
35-
"page_size": "Page Size",
36-
"keyword": "Search Keyword",
37-
"status": "Status",
38-
"origin": "Origin",
39-
"oid": "Workspace ID",
40-
"grid_items": "List Data",
41-
"grid_total": "Total Count",
42-
"grid_total_pages": "Total Pages",
43-
"create_time": "Creation Time",
44-
"language": "Language",
45-
"switch_oid_api": "Switch Workspace",
46-
"user_detail_api": "Get User Details",
47-
"uid": "User ID",
48-
"user_create_api": "Create User",
49-
"user_update_api": "Update User",
50-
"user_del_api": "Delete User",
51-
"user_batchdel_api": "Batch Delete Users",
52-
"language_change": "Change Language",
53-
"reset_pwd": "Reset Password",
54-
"update_pwd": "Update Password",
55-
"update_status": "Toggle Status",
56-
"origin_pwd": "Original Password",
57-
"new_pwd": "New Password",
27+
"system_user_api": "User APIs",
28+
"system_user_current_user": "Get Current User",
29+
"system_user_current_user_desc": "Retrieve information of the currently logged-in user",
30+
"system_user_grid": "Get User List",
31+
"user_name": "Username",
32+
"user_account": "Account",
33+
"user_email": "User Email",
34+
"page_num": "Page Number",
35+
"page_size": "Page Size",
36+
"keyword": "Search Keyword",
37+
"status": "Status",
38+
"origin": "Origin",
39+
"oid": "Workspace ID",
40+
"grid_items": "List Data",
41+
"grid_total": "Total Count",
42+
"grid_total_pages": "Total Pages",
43+
"create_time": "Creation Time",
44+
"language": "Language",
45+
"switch_oid_api": "Switch Workspace",
46+
"user_detail_api": "Get User Details",
47+
"uid": "User ID",
48+
"user_create_api": "Create User",
49+
"user_update_api": "Update User",
50+
"user_del_api": "Delete User",
51+
"user_batchdel_api": "Batch Delete Users",
52+
"language_change": "Change Language",
53+
"reset_pwd": "Reset Password",
54+
"update_pwd": "Update Password",
55+
"update_status": "Toggle Status",
56+
"origin_pwd": "Original Password",
57+
"new_pwd": "New Password",
5858

59-
"system_ws_api": "Workspace APIs",
60-
"ws_user_grid_api": "Get Workspace User List",
61-
"ws_user_bind_api": "Bind User to Workspace",
62-
"ws_user_unbind_api": "Remove User from Workspace",
63-
"ws_user_status_api": "Toggle User Role",
64-
"ws_all_api": "Get All Workspaces",
65-
"ws_create_api": "Create Workspace",
66-
"ws_update_api": "Update Workspace",
67-
"ws_query_api": "Get Workspace Details",
68-
"ws_del_api": "Delete Workspace",
59+
"system_ws_api": "Workspace APIs",
60+
"ws_user_grid_api": "Get Workspace User List",
61+
"ws_user_bind_api": "Bind User to Workspace",
62+
"ws_user_unbind_api": "Remove User from Workspace",
63+
"ws_user_status_api": "Toggle User Role",
64+
"ws_all_api": "Get All Workspaces",
65+
"ws_create_api": "Create Workspace",
66+
"ws_update_api": "Update Workspace",
67+
"ws_query_api": "Get Workspace Details",
68+
"ws_del_api": "Delete Workspace",
6969

70-
"weight": "Weight (1: Admin, 0: Regular User)"
70+
"weight": "Weight (1: Admin, 0: Regular User)"
71+
72+
"per_api": "Data Permission",
73+
"per_save": "Save Permission",
74+
"per_delete": "Delete Permission",
75+
"per_id": "Permission ID",
76+
"per_list": "Get Permission List",
77+
"per_get": "Get Permission Item Info",
78+
79+
"tr_api": "Table Relation",
80+
"tr_save": "Save Table Relation",
81+
"tr_get": "Get Table Relation"
7182
}

backend/apps/swagger/locales/zh.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,15 @@
6868
"ws_del_api": "删除工作空间",
6969

7070
"weight": "权重(1: 管理员, 0: 普通用户)"
71+
72+
"per_api": "数据权限",
73+
"per_save": "保存权限",
74+
"per_delete": "删除权限",
75+
"per_id": "权限 ID",
76+
"per_list": "获取权限列表",
77+
"per_get": "获取单条权限详情",
78+
79+
"tr_api": "表关联关系",
80+
"tr_save": "保存关联关系",
81+
"tr_get": "查询关联关系"
7182
}

0 commit comments

Comments
 (0)