Skip to content

Commit 0ef1a26

Browse files
lan-yonghuilan-yonghui
authored
pref: Remove Swagger description information (#7214)
1 parent 00701a3 commit 0ef1a26

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+345
-1797
lines changed

Diff for: ‎backend/app/api/v1/app.go

+2-10
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ import (
1111

1212
// @Tags App
1313
// @Summary List apps
14-
// @Description 获取应用列表
1514
// @Accept json
1615
// @Param request body request.AppSearch true "request"
1716
// @Success 200
@@ -32,7 +31,6 @@ func (b *BaseApi) SearchApp(c *gin.Context) {
3231

3332
// @Tags App
3433
// @Summary Sync app list
35-
// @Description 同步应用列表
3634
// @Success 200
3735
// @Security ApiKeyAuth
3836
// @Router /apps/sync [post]
@@ -63,7 +61,6 @@ func (b *BaseApi) SyncApp(c *gin.Context) {
6361

6462
// @Tags App
6563
// @Summary Search app by key
66-
// @Description 通过 key 获取应用信息
6764
// @Accept json
6865
// @Param key path string true "app key"
6966
// @Success 200 {object} response.AppDTO
@@ -85,11 +82,10 @@ func (b *BaseApi) GetApp(c *gin.Context) {
8582

8683
// @Tags App
8784
// @Summary Search app detail by appid
88-
// @Description 通过 appid 获取应用详情
8985
// @Accept json
9086
// @Param appId path integer true "app id"
91-
// @Param version path string true "app 版本"
92-
// @Param version path string true "app 类型"
87+
// @Param version path string true "app version"
88+
// @Param version path string true "app type"
9389
// @Success 200 {object} response.AppDetailDTO
9490
// @Security ApiKeyAuth
9591
// @Router /apps/detail/:appId/:version/:type [get]
@@ -111,7 +107,6 @@ func (b *BaseApi) GetAppDetail(c *gin.Context) {
111107

112108
// @Tags App
113109
// @Summary Get app detail by id
114-
// @Description 通过 id 获取应用详情
115110
// @Accept json
116111
// @Param appId path integer true "id"
117112
// @Success 200 {object} response.AppDetailDTO
@@ -133,7 +128,6 @@ func (b *BaseApi) GetAppDetailByID(c *gin.Context) {
133128

134129
// @Tags App
135130
// @Summary Get Ignore App
136-
// @Description 获取忽略的应用版本
137131
// @Accept json
138132
// @Success 200 {object} response.IgnoredApp
139133
// @Security ApiKeyAuth
@@ -149,7 +143,6 @@ func (b *BaseApi) GetIgnoredApp(c *gin.Context) {
149143

150144
// @Tags App
151145
// @Summary Install app
152-
// @Description 安装应用
153146
// @Accept json
154147
// @Param request body request.AppInstallCreate true "request"
155148
// @Success 200 {object} model.AppInstall
@@ -183,7 +176,6 @@ func (b *BaseApi) GetAppTags(c *gin.Context) {
183176

184177
// @Tags App
185178
// @Summary Get app list update
186-
// @Description 获取应用更新版本
187179
// @Success 200
188180
// @Security ApiKeyAuth
189181
// @Router /apps/checkupdate [get]

Diff for: ‎backend/app/api/v1/app_install.go

-15
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ import (
1111

1212
// @Tags App
1313
// @Summary Page app installed
14-
// @Description 分页获取已安装应用列表
1514
// @Accept json
1615
// @Param request body request.AppInstalledSearch true "request"
1716
// @Success 200
@@ -44,7 +43,6 @@ func (b *BaseApi) SearchAppInstalled(c *gin.Context) {
4443

4544
// @Tags App
4645
// @Summary List app installed
47-
// @Description 获取已安装应用列表
4846
// @Accept json
4947
// @Success 200 array dto.AppInstallInfo
5048
// @Security ApiKeyAuth
@@ -60,7 +58,6 @@ func (b *BaseApi) ListAppInstalled(c *gin.Context) {
6058

6159
// @Tags App
6260
// @Summary Check app installed
63-
// @Description 检查应用安装情况
6461
// @Accept json
6562
// @Param request body request.AppInstalledInfo true "request"
6663
// @Success 200 {object} response.AppInstalledCheck
@@ -81,7 +78,6 @@ func (b *BaseApi) CheckAppInstalled(c *gin.Context) {
8178

8279
// @Tags App
8380
// @Summary Search app port by key
84-
// @Description 获取应用端口
8581
// @Accept json
8682
// @Param request body dto.OperationWithNameAndType true "request"
8783
// @Success 200 {integer} port
@@ -102,7 +98,6 @@ func (b *BaseApi) LoadPort(c *gin.Context) {
10298

10399
// @Tags App
104100
// @Summary Search app password by key
105-
// @Description 获取应用连接信息
106101
// @Accept json
107102
// @Param request body dto.OperationWithNameAndType true "request"
108103
// @Success 200 {string} response.DatabaseConn
@@ -123,7 +118,6 @@ func (b *BaseApi) LoadConnInfo(c *gin.Context) {
123118

124119
// @Tags App
125120
// @Summary Check before delete
126-
// @Description 删除前检查
127121
// @Accept json
128122
// @Param appInstallId path integer true "App install id"
129123
// @Success 200 {array} dto.AppResource
@@ -146,7 +140,6 @@ func (b *BaseApi) DeleteCheck(c *gin.Context) {
146140
// Sync app installed
147141
// @Tags App
148142
// @Summary Sync app installed
149-
// @Description 同步已安装应用列表
150143
// @Success 200
151144
// @Security ApiKeyAuth
152145
// @Router /apps/installed/sync [post]
@@ -161,7 +154,6 @@ func (b *BaseApi) SyncInstalled(c *gin.Context) {
161154

162155
// @Tags App
163156
// @Summary Operate installed app
164-
// @Description 操作已安装应用
165157
// @Accept json
166158
// @Param request body request.AppInstalledOperate true "request"
167159
// @Success 200
@@ -182,7 +174,6 @@ func (b *BaseApi) OperateInstalled(c *gin.Context) {
182174

183175
// @Tags App
184176
// @Summary Search app service by key
185-
// @Description 通过 key 获取应用 service
186177
// @Accept json
187178
// @Param key path string true "request"
188179
// @Success 200 {array} response.AppService
@@ -200,7 +191,6 @@ func (b *BaseApi) GetServices(c *gin.Context) {
200191

201192
// @Tags App
202193
// @Summary Search app update version by install id
203-
// @Description 通过 install id 获取应用更新版本
204194
// @Accept json
205195
// @Param appInstallId path integer true "request"
206196
// @Success 200 {array} dto.AppVersion
@@ -221,7 +211,6 @@ func (b *BaseApi) GetUpdateVersions(c *gin.Context) {
221211

222212
// @Tags App
223213
// @Summary Change app port
224-
// @Description 修改应用端口
225214
// @Accept json
226215
// @Param request body request.PortUpdate true "request"
227216
// @Success 200
@@ -242,7 +231,6 @@ func (b *BaseApi) ChangeAppPort(c *gin.Context) {
242231

243232
// @Tags App
244233
// @Summary Search default config by key
245-
// @Description 通过 key 获取应用默认配置
246234
// @Accept json
247235
// @Param request body dto.OperationWithNameAndType true "request"
248236
// @Success 200 {string} content
@@ -264,7 +252,6 @@ func (b *BaseApi) GetDefaultConfig(c *gin.Context) {
264252

265253
// @Tags App
266254
// @Summary Search params by appInstallId
267-
// @Description 通过 install id 获取应用参数
268255
// @Accept json
269256
// @Param appInstallId path string true "request"
270257
// @Success 200 {object} response.AppParam
@@ -286,7 +273,6 @@ func (b *BaseApi) GetParams(c *gin.Context) {
286273

287274
// @Tags App
288275
// @Summary Change app params
289-
// @Description 修改应用参数
290276
// @Accept json
291277
// @Param request body request.AppInstalledUpdate true "request"
292278
// @Success 200
@@ -307,7 +293,6 @@ func (b *BaseApi) UpdateInstalled(c *gin.Context) {
307293

308294
// @Tags App
309295
// @Summary ignore App Update
310-
// @Description 忽略应用升级版本
311296
// @Accept json
312297
// @Param request body request.AppInstalledIgnoreUpgrade true "request"
313298
// @Success 200

Diff for: ‎backend/app/api/v1/auth.go

+3-10
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,8 @@ type BaseApi struct{}
1717

1818
// @Tags Auth
1919
// @Summary User login
20-
// @Description 用户登录
2120
// @Accept json
22-
// @Param EntranceCode header string true "安全入口 base64 加密串"
21+
// @Param EntranceCode header string true "Secure entrance base64 encrypted string"
2322
// @Param request body dto.Login true "request"
2423
// @Success 200 {object} dto.UserLoginInfo
2524
// @Router /auth/login [post]
@@ -59,12 +58,11 @@ func (b *BaseApi) Login(c *gin.Context) {
5958

6059
// @Tags Auth
6160
// @Summary User login with mfa
62-
// @Description 用户 mfa 登录
6361
// @Accept json
6462
// @Param request body dto.MFALogin true "request"
6563
// @Success 200 {object} dto.UserLoginInfo
6664
// @Router /auth/mfalogin [post]
67-
// @Header 200 {string} EntranceCode "安全入口"
65+
// @Header 200 {string} EntranceCode
6866
func (b *BaseApi) MFALogin(c *gin.Context) {
6967
var req dto.MFALogin
7068
if err := helper.CheckBindAndValidate(&req, c); err != nil {
@@ -87,7 +85,6 @@ func (b *BaseApi) MFALogin(c *gin.Context) {
8785

8886
// @Tags Auth
8987
// @Summary User logout
90-
// @Description 用户登出
9188
// @Success 200
9289
// @Security ApiKeyAuth
9390
// @Router /auth/logout [post]
@@ -101,7 +98,6 @@ func (b *BaseApi) LogOut(c *gin.Context) {
10198

10299
// @Tags Auth
103100
// @Summary Load captcha
104-
// @Description 加载验证码
105101
// @Success 200 {object} dto.CaptchaResponse
106102
// @Router /auth/captcha [get]
107103
func (b *BaseApi) Captcha(c *gin.Context) {
@@ -124,16 +120,14 @@ func (b *BaseApi) GetResponsePage(c *gin.Context) {
124120

125121
// @Tags Auth
126122
// @Summary Check System isDemo
127-
// @Description 判断是否为demo环境
128123
// @Success 200
129124
// @Router /auth/demo [get]
130125
func (b *BaseApi) CheckIsDemo(c *gin.Context) {
131126
helper.SuccessWithData(c, global.CONF.System.IsDemo)
132127
}
133128

134129
// @Tags Auth
135-
// @Summary Check System isDemo
136-
// @Description 判断是否为国际版
130+
// @Summary Check System isIntl
137131
// @Success 200
138132
// @Router /auth/intl [get]
139133
func (b *BaseApi) CheckIsIntl(c *gin.Context) {
@@ -142,7 +136,6 @@ func (b *BaseApi) CheckIsIntl(c *gin.Context) {
142136

143137
// @Tags Auth
144138
// @Summary Load System Language
145-
// @Description 获取系统语言设置
146139
// @Success 200
147140
// @Router /auth/language [get]
148141
func (b *BaseApi) GetLanguage(c *gin.Context) {

Diff for: ‎backend/app/api/v1/backup.go

-15
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ import (
1313

1414
// @Tags Backup Account
1515
// @Summary Create backup account
16-
// @Description 创建备份账号
1716
// @Accept json
1817
// @Param request body dto.BackupOperate true "request"
1918
// @Success 200
@@ -51,7 +50,6 @@ func (b *BaseApi) CreateBackup(c *gin.Context) {
5150

5251
// @Tags Backup Account
5352
// @Summary Refresh OneDrive token
54-
// @Description 刷新 OneDrive token
5553
// @Success 200
5654
// @Security ApiKeyAuth
5755
// @Router /settings/backup/refresh/onedrive [post]
@@ -62,7 +60,6 @@ func (b *BaseApi) RefreshOneDriveToken(c *gin.Context) {
6260

6361
// @Tags Backup Account
6462
// @Summary List buckets
65-
// @Description 获取 bucket 列表
6663
// @Accept json
6764
// @Param request body dto.ForBuckets true "request"
6865
// @Success 200 {array} string
@@ -100,7 +97,6 @@ func (b *BaseApi) ListBuckets(c *gin.Context) {
10097

10198
// @Tags Backup Account
10299
// @Summary Load OneDrive info
103-
// @Description 获取 OneDrive 信息
104100
// @Accept json
105101
// @Success 200 {object} dto.OneDriveInfo
106102
// @Security ApiKeyAuth
@@ -116,7 +112,6 @@ func (b *BaseApi) LoadOneDriveInfo(c *gin.Context) {
116112

117113
// @Tags Backup Account
118114
// @Summary Delete backup account
119-
// @Description 删除备份账号
120115
// @Accept json
121116
// @Param request body dto.OperateByID true "request"
122117
// @Success 200
@@ -138,7 +133,6 @@ func (b *BaseApi) DeleteBackup(c *gin.Context) {
138133

139134
// @Tags Backup Account
140135
// @Summary Page backup records
141-
// @Description 获取备份记录列表分页
142136
// @Accept json
143137
// @Param request body dto.RecordSearch true "request"
144138
// @Success 200
@@ -164,7 +158,6 @@ func (b *BaseApi) SearchBackupRecords(c *gin.Context) {
164158

165159
// @Tags Backup Account
166160
// @Summary Page backup records by cronjob
167-
// @Description 通过计划任务获取备份记录列表分页
168161
// @Accept json
169162
// @Param request body dto.RecordSearchByCronjob true "request"
170163
// @Success 200
@@ -190,7 +183,6 @@ func (b *BaseApi) SearchBackupRecordsByCronjob(c *gin.Context) {
190183

191184
// @Tags Backup Account
192185
// @Summary Download backup record
193-
// @Description 下载备份记录
194186
// @Accept json
195187
// @Param request body dto.DownloadRecord true "request"
196188
// @Success 200
@@ -213,7 +205,6 @@ func (b *BaseApi) DownloadRecord(c *gin.Context) {
213205

214206
// @Tags Backup Account
215207
// @Summary Delete backup record
216-
// @Description 删除备份记录
217208
// @Accept json
218209
// @Param request body dto.BatchDeleteReq true "request"
219210
// @Success 200
@@ -235,7 +226,6 @@ func (b *BaseApi) DeleteBackupRecord(c *gin.Context) {
235226

236227
// @Tags Backup Account
237228
// @Summary Update backup account
238-
// @Description 更新备份账号信息
239229
// @Accept json
240230
// @Param request body dto.BackupOperate true "request"
241231
// @Success 200
@@ -274,7 +264,6 @@ func (b *BaseApi) UpdateBackup(c *gin.Context) {
274264

275265
// @Tags Backup Account
276266
// @Summary List backup accounts
277-
// @Description 获取备份账号列表
278267
// @Success 200 {array} dto.BackupInfo
279268
// @Security ApiKeyAuth
280269
// @Router /settings/backup/search [get]
@@ -290,7 +279,6 @@ func (b *BaseApi) ListBackup(c *gin.Context) {
290279

291280
// @Tags Backup Account
292281
// @Summary List files from backup accounts
293-
// @Description 获取备份账号内文件列表
294282
// @Accept json
295283
// @Param request body dto.BackupSearchFile true "request"
296284
// @Success 200 {array} string
@@ -308,7 +296,6 @@ func (b *BaseApi) LoadFilesFromBackup(c *gin.Context) {
308296

309297
// @Tags Backup Account
310298
// @Summary Backup system data
311-
// @Description 备份系统数据
312299
// @Accept json
313300
// @Param request body dto.CommonBackup true "request"
314301
// @Success 200
@@ -353,7 +340,6 @@ func (b *BaseApi) Backup(c *gin.Context) {
353340

354341
// @Tags Backup Account
355342
// @Summary Recover system data
356-
// @Description 恢复系统数据
357343
// @Accept json
358344
// @Param request body dto.CommonRecover true "request"
359345
// @Success 200
@@ -404,7 +390,6 @@ func (b *BaseApi) Recover(c *gin.Context) {
404390

405391
// @Tags Backup Account
406392
// @Summary Recover system data by upload
407-
// @Description 从上传恢复系统数据
408393
// @Accept json
409394
// @Param request body dto.CommonRecover true "request"
410395
// @Success 200

0 commit comments

Comments
 (0)