Skip to content

feat: Add Api Docs #642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
XiaJunjie2020 merged 1 commit into from
Dec 19, 2025
Merged

feat: Add Api Docs #642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions backend/apps/datasource/api/datasource.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@ def insert_pg(df, tableName, engine):
f_c_col = "字段备注"


@router.get("/exportDsSchema/{id}")
@router.get("/exportDsSchema/{id}", response_model=None, summary=f"{PLACEHOLDER_PREFIX}ds_export_ds_schema")
async def export_ds_schema(session: SessionDep, id: int = Path(..., description=f"{PLACEHOLDER_PREFIX}ds_id")):
# {
# 'sheet':'', sheet name
Expand Down Expand Up @@ -438,7 +438,7 @@ def inner():
)


@router.post("/uploadDsSchema/{id}")
@router.post("/uploadDsSchema/{id}", response_model=None, summary=f"{PLACEHOLDER_PREFIX}ds_upload_ds_schema")
async def upload_ds_schema(session: SessionDep, id: int = Path(..., description=f"{PLACEHOLDER_PREFIX}ds_id"),
file: UploadFile = File(...)):
ALLOWED_EXTENSIONS = {"xlsx", "xls"}
Expand Down
5 changes: 4 additions & 1 deletion backend/apps/swagger/i18n.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,10 @@ def load_translation(lang: str) -> Dict[str, str]:
"name": "CustomPrompt",
"description": f"{PLACEHOLDER_PREFIX}custom_prompt_api"
},

{
"name": "mcp",
"description": f"{PLACEHOLDER_PREFIX}mcp_api"
},
]


Expand Down
4 changes: 4 additions & 0 deletions backend/apps/swagger/locales/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@
"ds_preview_data": "Preview Data",
"ds_upload_excel": "Upload Excel",
"ds_excel": "File",
"ds_export_ds_schema": "Export Comment",
"ds_upload_ds_schema": "Upload Comment",

"mcp_api": "MCP Tools(It is not recommended to call via API)",

"system": "System Management",
"system_user_api": "User APIs",
Expand Down
4 changes: 4 additions & 0 deletions backend/apps/swagger/locales/zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@
"ds_preview_data": "预览数据",
"ds_upload_excel": "上传Excel",
"ds_excel": "文件",
"ds_export_ds_schema": "导出备注信息",
"ds_upload_ds_schema": "导入备注信息",

"mcp_api": "MCP Tools(不建议api方式调用)",

"system": "系统管理",
"system_user_api": "用户接口",
Expand Down