-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopen-api.yml
More file actions
583 lines (583 loc) · 13.9 KB
/
open-api.yml
File metadata and controls
583 lines (583 loc) · 13.9 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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
openapi: 3.0.0
# servers:
# # Added by API Auto Mocking Plugin
# - description: SwaggerHub API Auto Mocking
# url: https://virtserver.swaggerhub.com/DANILKA108_1/AniWay/1.0.0
info:
version: 1.0.0
title: AniWay
description: The API for AniWay service
security:
- UserAuth:
- reader
- translator
paths:
/user/{userId}:
get:
summary: Get user
tags:
- User
responses:
'200':
description: user
content:
application/json:
schema:
$ref: '#/components/schemas/UserPage'
parameters:
- $ref: '#/components/parameters/UserId'
# /user/{userId}:
# post:
# summary: Create user
# tags:
# - User
# parameters:
# - $ref: '#/components/parameters/UserId'
# requestBody:
# content:
# application/json:
# schema:
# $ref: '#/components/schemas/UserCreation'
# responses:
# '200':
# description: User created successfully
# content:
# application/json:
# schema:
# $ref: '#/components/schemas/AuthData'
# delete:
# summary: Delete user
# security:
# - Auth: [reader_user, translator_user]
# tags:
# - User
# parameters:
# - $ref: '#/components/parameters/UserId'
# responses:
# '200':
# description: User deleted successfully
/user/{userId}/settings:
get:
summary: Get user settings
tags:
- User
parameters:
- $ref: '#/components/parameters/UserId'
responses:
'200':
description: user
content:
application/json:
schema:
$ref: '#/components/schemas/UserSettings'
put:
summary: Update user settings
tags:
- User
parameters:
- $ref: '#/components/parameters/UserId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserSettings'
responses:
'200':
description: User updated successfully
/manga/{mangaId}:
post:
summary: Create manga
security:
- UserAuth: [translator]
tags:
- Manga
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MangaCreation'
responses:
'200':
description: Manga created successfully
content:
application/json:
schema:
type: object
properties:
id:
type: integer
get:
summary: Get manga info
tags:
- Manga
responses:
'200':
description: Manga page
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/MangaPage'
- $ref: '#/components/schemas/MangaPreview'
parameters:
- name: typeOfContent
in: query
required: true
schema:
type: string
enum: ["preview", "page"]
- name: mangaId
in: path
required: true
description: manga ID
schema:
type: number
/comment/{commentId}:
get:
summary: Get comment
tags:
- Comment
responses:
'200':
description: comment
content:
application/json:
schema:
$ref: '#/components/schemas/Comment'
parameters:
- name: commentId
in: path
required: true
description: comment ID
schema:
type: number
#----------------------------------------------
delete:
summary: Delete comment
security:
- UserAuth: [reader]
- AdminAuth: [admin]
tags:
- Comment
parameters:
- $ref: '#/components/parameters/CommentId'
responses:
'200':
description: Comment deleted successfully
post:
summary: Create comment
security:
- UserAuth: [reader]
tags:
- Comment
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Comment'
responses:
'200':
description: Comment created successfully
content:
application/json:
schema:
type: object
properties:
id:
type: integer
put:
summary: Update comment
tags:
- Comment
parameters:
- $ref: '#/components/parameters/CommentId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Comment'
responses:
'200':
description: Comment updated successfully
/badge/{badgeId}:
get:
summary: Get badge
tags:
- Badge
responses:
'200':
description: badge
content:
application/json:
schema:
$ref: '#/components/schemas/Badge'
parameters:
- name: badgeId
in: path
required: true
description: badge ID
schema:
type: number
post:
summary: Create badge
security:
- AdminAuth: [admin]
tags:
- Badge
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Badge'
responses:
'200':
description: Badge created successfully
content:
application/json:
schema:
type: object
properties:
id:
type: integer
delete:
summary: Delete badge
security:
- AdminAuth: [admin]
tags:
- Badge
parameters:
- $ref: '#/components/parameters/BadgeId'
responses:
'200':
description: Badge deleted successfully
/chapter/{chapterId}:
get:
summary: Get chapter
tags:
- Chapter
responses:
'200':
description: chapter
content:
application/json:
schema:
$ref: '#/components/schemas/Chapter'
parameters:
- name: chapterId
in: path
required: true
description: chapter ID
schema:
type: number
put:
summary: Update chapter
tags:
- Chapter
security:
- UserAuth: [translator]
parameters:
- $ref: '#/components/parameters/ChapterId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Chapter'
responses:
'200':
description: Chapter updated successfully
post:
summary: Create chapter
security:
- UserAuth: [translator]
tags:
- Chapter
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Chapter'
responses:
'200':
description: Chapter created successfully
content:
application/json:
schema:
type: object
properties:
id:
type: integer
delete:
summary: Delete chapter
security:
- UserAuth: [tranlator]
tags:
- Chapter
parameters:
- $ref: '#/components/parameters/ChapterId'
responses:
'200':
description: Chapter deleted successfully
#-----------------------------------------------------------
components:
parameters:
UserId:
name: userId
in: path
required: true
description: user ID
schema:
type: number
#=================
CommentId:
name: commentId
in: path
required: true
description: comment ID
schema:
type: number
ChapterId:
name: chapterId
in: path
required: true
description: chapter ID
schema:
type: number
BadgeId:
name: badgeId
in: path
required: true
description: badge ID
schema:
type: number
#================
securitySchemes:
UserAuth:
type: http
scheme: bearer
bearerFormat: JWT
AdminAuth:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
MangaPreview:
type: object
properties:
id:
type: integer
name:
type: string
description:
type: array
items:
type: string
likes_count:
type: integer
views_count:
type: integer
chapters_count:
type: integer
type:
type: string
rating:
type: number
MangaPage:
type: object
properties:
id:
type: integer
name:
type: string
maxLength: 100
description:
type: array
items:
type: string
year:
type: string
status:
type: string
enum:
- "ongoing"
- "finished"
- "freezed"
- "announced"
type:
type: string
enum:
- "manhwa"
- "manhua"
- "manga"
- "cartoon"
bookmarks_count:
type: integer
likes_count:
type: integer
views_count:
type: integer
chapters_count:
type: integer
gengers:
type: array
items:
type: string
similar:
type: array
items:
type: integer
is_in_favorites:
type: boolean
rating:
type: number
comments:
type: array
items:
type: integer
MangaCreation:
type: object
properties:
name:
type: string
maxLength: 100
description:
type: array
items:
type: string
year:
type: string
status:
type: string
enum:
- "ongoing"
- "finished"
- "freezed"
- "announced"
type:
type: string
enum:
- "manhwa"
- "manhua"
- "manga"
- "cartoon"
gengers:
type: array
items:
type: string
Comment:
type: object
properties:
id:
type: integer
userId:
type: integer
message:
type: string
maxLength: 350
mangaId:
type: integer
UserPage:
type: object
properties:
id:
type: integer
nickname:
type: string
minLength: 3
maxLength: 20
xp_level:
type: integer
badge:
type: integer
chapters_read_count:
type: integer
chapters_likes_count:
type: integer
comments_count:
type: integer
favorite:
type: array
items:
type: integer
achievements:
type: array
items:
type: string
comments:
type: array
items:
type: integer
UserCreation:
type: object
properties:
nickname:
type: string
sex:
type: string
enum:
- male
- female
email:
type: string
password:
type: string
maxLength: 100
minLength: 8
AuthData:
type: object
properties:
accessToken:
type: string
refreshToken:
type: string
UserSettings:
type: object
properties:
nickname:
type: string
minLength: 3
maxLength: 20
badge:
type: integer
sex:
type: string
enum:
- male
- female
is_hentai_hidden:
type: boolean
is_yuri_hidden:
type: boolean
is_yaoi_hidden:
type: boolean
Badge:
type: object
properties:
id:
type: integer
name:
type: string
maxLength: 20
required:
- id
- name
Chapter:
type: object
properties:
id:
type: integer
manga_id:
type: integer
name:
type: string
maxLength: 100
number:
type: integer
translator_user:
type: object
properties:
id:
type: integer
nickname:
type: string
user_id:
type: integer