generated from shuntaka9576/python-project-template
-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
openapi.yaml
6582 lines (6579 loc) · 195 KB
/
openapi.yaml
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
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: SweetPotato Server 3 API
version: 0.5.10
description: |-
Advanced Sonolus API server with adds many features (Python)
Development repository is [here](https://github.com/PurplePalette/sonolus-fastapi)
### Sonolus-Version
- 0.5.10
### Features
- supports uploading every sonolus contents
- tests server for chart testing
- users server for get levels only from specific user
- accounts server for make personal special features
- announces section to showing server maintenence infos
- pickups section to showing admin recommendation levels
- random, flick-paradise, vote, mylist and more!
### Note
- This file have many tags, since every generated files were too big and needed to separate.
- Actually many endpoints can inherit another endpoints. it won't be big project.
- openapi-generator-cli python-fastapi gen makes broken models, you need fix below:
- All req/resp fields be snake_case, but sonolus official doc is camelCase
- Union type of SearchOptions be broken.
### Original comments
- フロントエンド専用のエンドポイントは一切持たずマイリストなどを含め全てのリクエストはSonolusアプリ内のリクエストと互換するAPI(つまり全部の処理がGETになる、きっも...)
- ユーザー認証は以前同様に FirebaseAuthorizationでなんとかする。accountsエンドポイントはaccountKeyとかいう概念使ってゴリ押しする、セキュリティ上よろしくないが...まぁゲームだしええやろ!
contact:
name: お窓
url: 'https://discord.gg/KEfVkfC6Q9'
termsOfService: 'https://discord.gg/KEfVkfC6Q9'
license:
name: MIT
url: 'https://opensource.org/licenses/mit-license.php'
servers:
- url: 'http://localhost:5000'
description: Local
paths:
/backgrounds/list:
get:
summary: Get background list
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetBackgroundListResponse'
operationId: getBackgroundList
description: |-
It returns list of background infos registered in this server
Also it can search using query params
parameters:
- $ref: '#/components/parameters/localization'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/keywords'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/order'
- $ref: '#/components/parameters/status'
- $ref: '#/components/parameters/author'
- $ref: '#/components/parameters/random'
tags:
- default_backgrounds
'/backgrounds/{backgroundName}':
parameters:
- schema:
type: string
name: backgroundName
in: path
required: true
get:
summary: Get a background
tags:
- default_backgrounds
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetBackgroundResponse'
'404':
description: Not Found
operationId: getBackground
description: |-
It returns specified background info
It will raise 404 if the background is not registered in this server
parameters:
- $ref: '#/components/parameters/localization'
patch:
summary: Edit a background
operationId: editBackground
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetBackgroundResponse'
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
description: 指定された背景情報を編集します
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EditBackgroundRequest'
tags:
- default_backgrounds
security:
- Authorization: []
delete:
summary: Delete a background
operationId: deleteBackground
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
description: Delete specified background
tags:
- default_backgrounds
security:
- Authorization: []
/backgrounds:
parameters: []
post:
summary: Add a background
operationId: addBackground
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetBackgroundResponse'
'400':
description: Bad Request
'401':
description: Unauthorized
'409':
description: Conflict
description: 指定された背景情報をサーバーに登録します
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddBackgroundRequest'
description: ''
tags:
- default_backgrounds
security:
- Authorization: []
/effects/list:
get:
summary: Get effect list
tags:
- default_effects
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetEffectListResponse'
operationId: getEffectList
description: |-
It returns list of effect infos registered in this server
Also it can search using query params
parameters:
- $ref: '#/components/parameters/localization'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/keywords'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/order'
- $ref: '#/components/parameters/status'
- $ref: '#/components/parameters/author'
- $ref: '#/components/parameters/random'
'/effects/{effectName}':
parameters:
- schema:
type: string
name: effectName
in: path
required: true
get:
summary: Get an effect
tags:
- default_effects
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetEffectResponse'
'404':
description: Not Found
operationId: getEffect
description: |-
It returns specified effect info
It will raise 404 if the effect is not registered in this server
parameters:
- $ref: '#/components/parameters/localization'
patch:
summary: Edit an effect
operationId: editEffect
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetEffectResponse'
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
description: 指定されたeffectを編集します
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EditEffectRequest'
tags:
- default_effects
security:
- Authorization: []
delete:
summary: Delete an effect
operationId: deleteEffect
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
description: delete specified effect
tags:
- default_effects
security:
- Authorization: []
/effects:
parameters: []
post:
summary: Add an effect
operationId: addEffect
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetEffectResponse'
'400':
description: Bad Request
'401':
description: Unauthorized
'409':
description: Conflict
description: 指定されたeffectをサーバーに登録します
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddEffectRequest'
tags:
- default_effects
security:
- Authorization: []
/engines/list:
get:
summary: Get engine list
tags:
- default_engines
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetEngineListResponse'
operationId: getEngineList
description: |-
It returns list of engine infos registered in this server
Also it can search using query params
parameters:
- $ref: '#/components/parameters/localization'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/keywords'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/order'
- $ref: '#/components/parameters/status'
- $ref: '#/components/parameters/author'
- $ref: '#/components/parameters/random'
'/engines/{engineName}':
parameters:
- schema:
type: string
name: engineName
in: path
required: true
get:
summary: Get an engine
tags:
- default_engines
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetEngineResponse'
'404':
description: Not Found
operationId: getEngine
description: |-
It returns specified engine info
It will raise 404 if the engine is not registered in this server
parameters:
- $ref: '#/components/parameters/localization'
patch:
summary: Edit an engine
operationId: editEngine
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetEngineResponse'
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
description: 指定されたengineを編集します
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EditEngineRequest'
tags:
- default_engines
security:
- Authorization: []
delete:
summary: Delete an engine
operationId: deleteEngine
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
tags:
- default_engines
description: delete a engine
security:
- Authorization: []
/engines:
parameters: []
post:
summary: Add an engine
operationId: addEngine
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetEngineResponse'
'400':
description: Bad Request
'401':
description: Unauthorized
'409':
description: Conflict
description: 指定されたゲームエンジンをサーバーに登録します
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddEngineRequest'
tags:
- default_engines
security:
- Authorization: []
/levels/announce:
get:
summary: Get announce infos
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetLevelResponse'
'404':
description: Not Found
operationId: getAnnounceList
description: 現在のアナウンス一覧を取得します
tags:
- default_levels_specials
parameters:
- $ref: '#/components/parameters/localization'
'/levels/announce_{announceName}':
parameters:
- schema:
type: string
name: announceName
in: path
required: true
get:
summary: Get an announce info
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetLevelResponse'
'404':
description: Not Found
operationId: getAnnounce
description: 指定されたアナウンス情報を表示します
tags:
- default_levels_specials
parameters:
- $ref: '#/components/parameters/localization'
/levels/pickups:
get:
summary: Get pickup levels
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetLevelResponse'
operationId: getPickups
description: 管理者の指定したおすすめ譜面などを返すエンドポイント
tags:
- default_levels_specials
parameters:
- $ref: '#/components/parameters/localization'
/levels/debut:
get:
summary: Get debut levels
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetLevelResponse'
operationId: getFreshReleases
description: 新規譜面作者の譜面のみを返すエンドポイント
tags:
- default_levels_specials
parameters:
- $ref: '#/components/parameters/localization'
parameters: []
/levels/list:
get:
summary: Get level list
tags:
- default_levels
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetLevelListResponse'
examples:
example-1:
value:
pageCount: 1
items:
- name: s7x62wxj
version: 1
rating: 25
engine:
name: string
version: 1
title: string
titleEn: string
subtitle: string
subtitleEn: string
author: string
authorEn: string
description: 説明無し
descriptionEn: No description
thumbnail:
type: LevelData
hash: string
url: string
data:
type: LevelData
hash: string
url: string
configuration:
type: LevelData
hash: string
url: string
skin:
name: string
version: 1
title: string
titleEn: string
subtitle: string
subtitleEn: string
author: string
authorEn: string
description: No description
descriptionEn: No description
thumbnail:
type: LevelData
hash: string
url: string
data:
type: LevelData
hash: string
url: string
texture:
type: LevelData
hash: string
url: string
createdTime: 0
updatedTime: 0
userId: string
public: false
background:
name: string
version: 1
title: string
titleEn: string
subtitle: string
subtitleEn: string
author: string
authorEn: string
description: No description
descriptionEn: No description
thumbnail:
type: LevelData
hash: string
url: string
data:
type: LevelData
hash: string
url: string
image:
type: LevelData
hash: string
url: string
configuration:
type: LevelData
hash: string
url: string
createdTime: 0
updatedTime: 0
userId: string
public: false
effect:
name: string
version: 1
title: string
titleEn: string
subtitle: string
subtitleEn: string
author: string
authorEn: string
description: No description
descriptionEn: No description
thumbnail:
type: LevelData
hash: string
url: string
data:
type: LevelData
hash: string
url: string
createdTime: 0
updatedTime: 0
userId: string
public: false
particle:
name: string
version: 1
title: string
titleEn: string
subtitle: string
subtitleEn: string
author: string
authorEn: string
description: No description
descriptionEn: No description
thumbnail:
type: LevelData
hash: string
url: string
data:
type: LevelData
hash: string
url: string
texture:
type: LevelData
hash: string
url: string
createdTime: 0
updatedTime: 0
userId: string
public: false
createdTime: 0
updatedTime: 0
userId: string
public: false
useSkin:
useDefault: true
item:
name: string
version: 1
title: string
titleEn: string
subtitle: string
subtitleEn: string
author: string
authorEn: string
description: No description
descriptionEn: No description
thumbnail:
type: LevelData
hash: string
url: string
data:
type: LevelData
hash: string
url: string
texture:
type: LevelData
hash: string
url: string
createdTime: 0
updatedTime: 0
userId: string
public: false
useBackground:
useDefault: true
item:
name: string
version: 1
title: string
titleEn: string
subtitle: string
subtitleEn: string
author: string
authorEn: string
description: No description
descriptionEn: No description
thumbnail:
type: LevelData
hash: string
url: string
data:
type: LevelData
hash: string
url: string
image:
type: LevelData
hash: string
url: string
configuration:
type: LevelData
hash: string
url: string
createdTime: 0
updatedTime: 0
userId: string
public: false
useEffect:
useDefault: true
item:
name: string
version: 1
title: string
titleEn: string
subtitle: string
subtitleEn: string
author: string
authorEn: string
description: No description
descriptionEn: No description
thumbnail:
type: LevelData
hash: string
url: string
data:
type: LevelData
hash: string
url: string
createdTime: 0
updatedTime: 0
userId: string
public: false
useParticle:
useDefault: true
item:
name: string
version: 1
title: string
titleEn: string
subtitle: string
subtitleEn: string
author: string
authorEn: string
description: No description
descriptionEn: No description
thumbnail:
type: LevelData
hash: string
url: string
data:
type: LevelData
hash: string
url: string
texture:
type: LevelData
hash: string
url: string
createdTime: 0
updatedTime: 0
userId: string
public: false
title: テスト用譜面
titleEn: This is test level
artists: つくよみちゃん
artistsEn: Tsukuyomi-chan
author: お窓
authorEn: Omado
description: 説明文無し
descriptionEn: No description
cover:
type: LevelData
hash: string
url: string
bgm:
type: LevelData
hash: string
url: string
preview:
type: LevelData
hash: string
url: string
data:
type: LevelData
hash: string
url: string
public: true
genre: general
userId: fa423sfa242
createdTime: 1644040400
updatedTime: 1644040400
length: 91
bpm: 150
notes: 1204
likes: 0
mylists: 0
search:
options:
- query: string
name: string
type: text
placeholder: string
operationId: getLevelList
description: |-
It returns list of level infos registered in this server
Also it can search using query params
parameters:
- $ref: '#/components/parameters/localization'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/keywords'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/order'
- $ref: '#/components/parameters/status'
- $ref: '#/components/parameters/author'
- $ref: '#/components/parameters/rating_min'
- $ref: '#/components/parameters/rating_max'
- $ref: '#/components/parameters/genre'
- $ref: '#/components/parameters/length'
- $ref: '#/components/parameters/random'
'/levels/{levelName}':
parameters:
- schema:
type: string
name: levelName
in: path
required: true
get:
summary: Get a level
tags:
- default_levels
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetLevelResponse'
'404':
description: Not Found
operationId: getLevel
description: |-
It returns specified level info
It will raise 404 if the level is not registered in this server
parameters:
- $ref: '#/components/parameters/localization'
patch:
summary: Edit a level
operationId: editLevel
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetLevelResponse'
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
description: 指定されたlevelを編集します
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EditLevelRequest'
tags:
- default_levels
security:
- Authorization: []
delete:
summary: Delete a level
operationId: deleteLevel
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
description: 指定されたレベルを削除します
tags:
- default_levels
security:
- Authorization: []
/levels:
parameters: []
post:
summary: Add a level
operationId: addLevel
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetLevelResponse'
'400':
description: Bad Request
'401':
description: Unauthorized
'409':
description: Conflict
description: 指定された譜面情報をサーバーに登録します
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddLevelRequest'
tags:
- default_levels
security:
- Authorization: []
/particles/list:
get:
summary: Get particle list
tags:
- default_particles
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetParticleListResponse'
operationId: getParticleList
description: |-
It returns list of particle infos registered in this server
Also it can search using query params
parameters:
- $ref: '#/components/parameters/localization'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/keywords'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/order'
- $ref: '#/components/parameters/status'
- $ref: '#/components/parameters/author'
- $ref: '#/components/parameters/random'
'/particles/{particleName}':
parameters:
- schema:
type: string
name: particleName
in: path
required: true
get:
summary: Get a particle
tags:
- default_particles
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetParticleResponse'
'404':
description: Not Found
operationId: getParticle
description: |-
It returns specified particle info
It will raise 404 if the particle is not registered in this server
parameters:
- $ref: '#/components/parameters/localization'
patch:
summary: Edit a particle
operationId: editParticle
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetParticleResponse'
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
description: 指定したparticleを編集します
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EditParticleRequest'
tags:
- default_particles
security:
- Authorization: []
delete:
summary: Delete a particle
operationId: deleteParticle
responses:
'200':
description: OK