swagger.yaml
8.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
swagger: "2.0"
info:
title: ""
description: 字库元数据堡垒
contact:
name: ttt
email: ""
home: ""
version: 0.0.1
consumes:
- application/json
- application/xml
produces:
- application/json
- application/xml
paths:
/files:
get:
tags:
- file
summary: 返回文件服务列表
description: 返回文件服务列表
operationId: file#listFile
parameters:
- name: offset
in: query
description: 查询偏离量
required: false
type: integer
- name: limit
in: query
description: 查询限制
required: false
type: integer
responses:
"200":
description: OK response.
schema:
$ref: '#/definitions/FileListFileResponseBody'
schemes:
- http
post:
tags:
- file
summary: 创建文件服务
description: 创建文件服务
operationId: file#createFile
parameters:
- name: CreateFileRequestBody
in: body
required: true
schema:
$ref: '#/definitions/FileCreateFileRequestBody'
responses:
"200":
description: OK response.
schema:
$ref: '#/definitions/FileCreateFileResponseBody'
schemes:
- http
/files/{fileId}:
get:
tags:
- file
summary: 返回文件服务
description: 返回文件服务
operationId: file#getFile
parameters:
- name: fileId
in: path
description: 文件ID
required: true
type: integer
responses:
"200":
description: OK response.
schema:
$ref: '#/definitions/FileGetFileResponseBody'
schemes:
- http
put:
tags:
- file
summary: 更新文件服务
description: 更新文件服务
operationId: file#updateFile
parameters:
- name: fileId
in: path
description: 文件ID
required: true
type: integer
responses:
"200":
description: OK response.
schema:
$ref: '#/definitions/FileUpdateFileResponseBody'
schemes:
- http
delete:
tags:
- file
summary: 移除文件服务
description: 移除文件服务
operationId: file#removeFile
parameters:
- name: fileId
in: path
description: 文件ID
required: true
type: integer
responses:
"200":
description: OK response.
schema:
$ref: '#/definitions/FileRemoveFileResponseBody'
schemes:
- http
/files/files/edit-data-table:
post:
tags:
- file
summary: 编辑表格数据
description: 编辑表格数据
operationId: file#editDataTable
parameters:
- name: EditDataTableRequestBody
in: body
required: true
schema:
$ref: '#/definitions/FileEditDataTableRequestBody'
responses:
"200":
description: OK response.
schema:
$ref: '#/definitions/FileEditDataTableResponseBody'
schemes:
- http
/files/files/flush-data-table:
post:
tags:
- file
summary: 持久化表格数据
description: 持久化表格数据
operationId: file#flushDataTable
parameters:
- name: FlushDataTableRequestBody
in: body
required: true
schema:
$ref: '#/definitions/FileFlushDataTableRequestBody'
responses:
"200":
description: OK response.
schema:
$ref: '#/definitions/FileFlushDataTableResponseBody'
schemes:
- http
/files/files/generate-main-table:
post:
tags:
- file
summary: 生成主表
description: 生成主表
operationId: file#generateMainTable
parameters:
- name: GenerateMainTableRequestBody
in: body
required: true
schema:
$ref: '#/definitions/FileGenerateMainTableRequestBody'
responses:
"200":
description: OK response.
schema:
$ref: '#/definitions/FileGenerateMainTableResponseBody'
schemes:
- http
/files/files/load-data-table:
post:
tags:
- file
summary: 加载表格数据
description: 加载表格数据
operationId: file#loadDataTable
parameters:
- name: LoadDataTableRequestBody
in: body
required: true
schema:
$ref: '#/definitions/FileLoadDataTableRequestBody'
responses:
"200":
description: OK response.
schema:
$ref: '#/definitions/FileLoadDataTableResponseBody'
schemes:
- http
definitions:
FileCreateFileRequestBody:
title: FileCreateFileRequestBody
type: object
properties:
fileSize:
type: integer
description: 文件大小
required:
- fileSize
name:
type: string
description: 名称
required:
- name
url:
type: string
description: 文件地址
required:
- url
FileCreateFileResponseBody:
title: 'Mediatype identifier: FileCreateFileResponseBody'
type: object
properties:
file:
$ref: '#/definitions/fileResponseBody'
FileEditDataTableRequestBody:
title: FileEditDataTableRequestBody
type: object
properties:
fileId:
type: integer
description: 文件ID
required:
- fileId
FileEditDataTableResponseBody:
title: 'Mediatype identifier: FileEditDataTableResponseBody'
type: object
properties:
file:
$ref: '#/definitions/fileResponseBody'
FileFlushDataTableRequestBody:
title: FileFlushDataTableRequestBody
type: object
properties:
fileId:
type: integer
description: 文件ID
required:
- fileId
FileFlushDataTableResponseBody:
title: 'Mediatype identifier: FileFlushDataTableResponseBody'
type: object
properties:
file:
$ref: '#/definitions/fileResponseBody'
FileGenerateMainTableRequestBody:
title: FileGenerateMainTableRequestBody
type: object
properties:
fileId:
type: integer
description: 文件ID
required:
- fileId
FileGenerateMainTableResponseBody:
title: 'Mediatype identifier: FileGenerateMainTableResponseBody'
type: object
properties:
file:
$ref: '#/definitions/fileResponseBody'
FileGetFileResponseBody:
title: 'Mediatype identifier: FileGetFileResponseBody'
type: object
properties:
file:
$ref: '#/definitions/fileResponseBody'
FileListFileResponseBody:
title: 'Mediatype identifier: FileListFileResponseBody'
type: object
properties:
count:
type: integer
description: 匹配数目
required:
- count
files:
type: array
items:
$ref: '#/definitions/fileResponseBody'
required:
- files
FileLoadDataTableRequestBody:
title: FileLoadDataTableRequestBody
type: object
properties:
fileId:
type: integer
description: 文件ID
required:
- fileId
FileLoadDataTableResponseBody:
title: 'Mediatype identifier: FileLoadDataTableResponseBody'
type: object
properties:
file:
$ref: '#/definitions/fileResponseBody'
FileRemoveFileResponseBody:
title: 'Mediatype identifier: FileRemoveFileResponseBody'
type: object
properties:
file:
$ref: '#/definitions/fileResponseBody'
FileUpdateFileResponseBody:
title: 'Mediatype identifier: FileUpdateFileResponseBody'
type: object
properties:
file:
$ref: '#/definitions/fileResponseBody'
fileResponseBody:
title: fileResponseBody
type: object
properties:
createdAt:
type: string
description: 创建时间
required:
- createdAt
deletedAt:
type: string
description: 删除时间
required:
- deletedAt
fileId:
type: integer
description: 文件ID
required:
- fileId
fileInfo:
type: string
description: 文件信息
required:
- fileInfo
fileType:
type: string
description: 文件类型
required:
- fileType
operator:
type: string
description: 操作人
required:
- operator
sourceFileId:
type: string
description: 源文件Id(FileType为TemporaryFile或VerifiedFile时有值)
required:
- sourceFileId
updatedAt:
type: string
description: 更新时间
required:
- updatedAt
version:
type: integer
description: 版本
required:
- version
description: 文件