Skip to content

Commit a1c4aa3

Browse files
committed
refactor: update parameter names in application functions for clarity
1 parent c1c0c6a commit a1c4aa3

File tree

1 file changed

+32
-14
lines changed

1 file changed

+32
-14
lines changed

ui/src/api/application/application.ts

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Object.defineProperty(prefix, 'value', {
1414
})
1515
/**
1616
* 获取全部应用
17-
* @param 参数
17+
* @param param
18+
* @param loading
1819
*/
1920
const getAllApplication: (param?: any, loading?: Ref<boolean>) => Promise<Result<any[]>> = (
2021
param,
@@ -39,7 +40,8 @@ const getApplication: (
3940

4041
/**
4142
* 创建应用
42-
* @param 参数
43+
* @param data
44+
* @param loading
4345
*/
4446
const postApplication: (
4547
data: ApplicationFormType,
@@ -50,7 +52,9 @@ const postApplication: (
5052

5153
/**
5254
* 修改应用
53-
* @param 参数
55+
* @param application_id
56+
* @param data
57+
* @param loading
5458
*/
5559
const putApplication: (
5660
application_id: string,
@@ -62,7 +66,8 @@ const putApplication: (
6266

6367
/**
6468
* 删除应用
65-
* @param 参数 application_id
69+
* @param application_id
70+
* @param loading
6671
*/
6772
const delApplication: (
6873
application_id: string,
@@ -73,7 +78,8 @@ const delApplication: (
7378

7479
/**
7580
* 应用详情
76-
* @param 参数 application_id
81+
* @param application_id
82+
* @param loading
7783
*/
7884
const getApplicationDetail: (
7985
application_id: string,
@@ -84,7 +90,8 @@ const getApplicationDetail: (
8490

8591
/**
8692
* 获取AccessToken
87-
* @param 参数 application_id
93+
* @param application_id
94+
* @param loading
8895
*/
8996
const getAccessToken: (application_id: string, loading?: Ref<boolean>) => Promise<Result<any>> = (
9097
application_id,
@@ -107,10 +114,12 @@ const getApplicationSetting: (
107114

108115
/**
109116
* 修改AccessToken
110-
* @param 参数 application_id
111117
* data {
112118
* "is_active": true
113119
* }
120+
* @param application_id
121+
* @param data
122+
* @param loading
114123
*/
115124
const putAccessToken: (
116125
application_id: string,
@@ -122,7 +131,6 @@ const putAccessToken: (
122131

123132
/**
124133
* 替换社区版-修改AccessToken
125-
* @param 参数 application_id
126134
* data {
127135
* "show_source": boolean,
128136
* "show_history": boolean,
@@ -131,6 +139,9 @@ const putAccessToken: (
131139
* "avatar": file,
132140
* "float_icon": file,
133141
* }
142+
* @param application_id
143+
* @param data
144+
* @param loading
134145
*/
135146
const putXpackAccessToken: (
136147
application_id: string,
@@ -170,7 +181,9 @@ const importApplication: (
170181

171182
/**
172183
* 统计
173-
* @param 参数 application_id, data
184+
* @param application_id
185+
* @param data
186+
* @param loading
174187
*/
175188
const getStatistics: (
176189
application_id: string,
@@ -193,9 +206,10 @@ const open: (application_id: string, loading?: Ref<boolean>) => Promise<Result<s
193206
}
194207
/**
195208
* 对话
196-
* @param 参数
197209
* chat_id: string
198210
* data
211+
* @param chat_id
212+
* @param data
199213
*/
200214
const chat: (chat_id: string, data: any) => Promise<any> = (chat_id, data) => {
201215
const prefix = (window.MaxKB?.prefix ? window.MaxKB?.prefix : '/admin') + '/api'
@@ -248,6 +262,7 @@ const updatePlatformConfig: (
248262
/**
249263
* 应用发布
250264
* @param application_id
265+
* @param data
251266
* @param loading
252267
* @returns
253268
*/
@@ -284,7 +299,7 @@ const playDemoText: (application_id: string, data: any, loading?: Ref<boolean>)
284299
* 文本转语音
285300
*/
286301
const postTextToSpeech: (
287-
application_id: String,
302+
application_id: string,
288303
data: any,
289304
loading?: Ref<boolean>,
290305
) => Promise<Result<any>> = (application_id, data, loading) => {
@@ -300,7 +315,7 @@ const postTextToSpeech: (
300315
* 语音转文本
301316
*/
302317
const speechToText: (
303-
application_id: String,
318+
application_id: string,
304319
data: any,
305320
loading?: Ref<boolean>,
306321
) => Promise<Result<any>> = (application_id, data, loading) => {
@@ -311,7 +326,7 @@ const speechToText: (
311326
* mcp 节点
312327
*/
313328
const getMcpTools: (
314-
application_id: String,
329+
application_id: string,
315330
mcp_servers: any,
316331
loading?: Ref<boolean>,
317332
) => Promise<Result<any>> = (application_id, mcp_servers, loading) => {
@@ -320,7 +335,10 @@ const getMcpTools: (
320335

321336
/**
322337
* 上传文件
323-
* @param 参数 file:file
338+
* @param file
339+
* @param sourceId
340+
* @param resourceType
341+
* @param loading
324342
*/
325343
const postUploadFile: (
326344
file: any,

0 commit comments

Comments
 (0)