This repository was archived by the owner on Apr 28, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathopenapi2.yaml
More file actions
623 lines (623 loc) · 18.3 KB
/
openapi2.yaml
File metadata and controls
623 lines (623 loc) · 18.3 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
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
swagger: '2.0'
openapi: '3.0'
info:
title: Chimu API
version: ''
description: |-
## API V1
Spec file you can find [here](https://api.chimu.moe/docs/swagger.json)
#### If you find some mistake in API, please notify ASAP administration in our [discord](https://discord.com/invite/9JnqPSrPpz) channel!
host: api.chimu.moe
basePath: /
schemes:
- https
paths:
/v1/map/{map_id}:
get:
responses:
'200':
description: OK
headers: {}
examples:
application/json:
BeatmapId: 53
ParentSetId: 3
DiffName: '-Crusin-'
FileMD5: 1d23c37a2fda439be752ae2bca06c0cd
Mode: 0
BPM: 172
AR: 4
OD: 4
CS: 5
HP: 3
TotalLength: 83
HitLength: 77
Playcount: 101574
Passcount: 47994
MaxCombo: 124
DifficultyRating: 1.86918
OsuFile: Ni-Ni - 1,2,3,4, 007 [Wipeout Series] (MCXD) [-Crusin-].osu
DownloadPath: /d/3
'400':
description: Bad Request
headers: {}
examples:
application/json:
error_message: One of the query values isn't correct, please check your encoding settings
error_code: oneOfQueryIsntCorrect
'404':
description: Not Found
headers: {}
examples:
application/json:
error_message: Map not found, please try to search another one :/
error_code: map_not_found
summary: Get beatmap
operationId: Get beatmap
description: |-
Gets a beatmap.
if it fails it returns a simple JSON Serialized error including
a message and error code.
tags: ['Chimu API']
parameters:
- name: map_id
in: path
description: Beatmap Id
required: true
x-example: '53'
type: number
produces:
- application/json
/v1/set/{set_id}:
get:
responses:
'200':
description: OK
headers: {}
examples:
application/json:
SetId: 1
ChildrenBeatmaps:
- BeatmapId: 75
ParentSetId: 1
DiffName: Normal
FileMD5: a5b99395a42bd55bc5eb1d2411cbdf8b
Mode: 0
BPM: 119.999
AR: 6
OD: 6
CS: 4
HP: 6
TotalLength: 142
HitLength: 109
Playcount: 467474
Passcount: 57119
MaxCombo: 314
DifficultyRating: 2.40729
OsuFile: Kenji Ninuma - DISCO PRINCE (peppy) [Normal].osu
DownloadPath: /d/1
RankedStatus: 1
ApprovedDate: '2007-10-06T17:46:31'
LastUpdate: '2007-10-06T17:46:31'
LastChecked: '2021-01-19T09:43:57'
Artist: Kenji Ninuma
Title: DISCO PRINCE
Creator: peppy
Source: ''
Tags: katamari
HasVideo: false
Genre: 2
Language: 3
Favourites: 789
Disabled: false
'400':
description: Bad Request
headers: {}
examples:
application/json:
error_message: One of the query values isn't correct, please check your encoding settings
error_code: oneOfQueryIsntCorrect
'404':
description: Not Found
headers: {}
examples:
application/json:
error_message: Set not found, please try to search another one :/
error_code: set_not_found
summary: Get beatmap set
operationId: Get beatmap set
description: |-
Gets a beatmap set.
if it fails it returns a simple JSON Serialized error including
a message and error code.
tags: ['Chimu API']
parameters:
- name: set_id
in: path
description: Beatmap set Id
required: true
x-example: '1'
type: number
produces:
- application/json
/v1/download/{set_id}:
get:
responses:
'200':
description: OK
headers: {}
examples:
application/octet-stream: ''
'404':
description: Not Found
headers: {}
examples:
application/json:
error_message: Set not found, please try to search another one :/
error_code: set_not_found
'500':
description: |-
Internal Server Error
Error code have variety, as unknown_error, cant_download_map
headers: {}
examples:
application/json:
error_message: >-
Something strange happend on our systems, please notify
about this on our Discord channel :<
error_code: server_error
summary: Download beatmap set
operationId: Download beatmap set
description: |-
Downloads a beatmap set using given set id</br>
<i>NOTE:</i> Chimu currently responses only with noVideo maps!
tags: ['Chimu API']
parameters:
- name: set_id
in: path
description: Beatmap set Id
required: true
x-example: '1'
type: number
produces:
- application/octet-stream
- application/json
/v1/search:
get:
responses:
'500':
description: Internal Server Error
headers: {}
examples:
application/json:
error_message: >-
Something strange happend on our systems, please notify
about this on our Discord channel :<
error_code: server_error
'200':
description: OK
headers: {}
examples:
application/json:
data:
- SetId: 1
ChildrenBeatmaps:
- BeatmapId: 75
ParentSetId: 1
DiffName: Normal
FileMD5: a5b99395a42bd55bc5eb1d2411cbdf8b
Mode: 0
BPM: 119.999
AR: 6
OD: 6
CS: 4
HP: 6
TotalLength: 142
HitLength: 109
Playcount: 467474
Passcount: 57119
MaxCombo: 314
DifficultyRating: 2.40729
OsuFile: Kenji Ninuma - DISCO PRINCE (peppy) [Normal].osu
DownloadPath: /d/1
RankedStatus: 1
ApprovedDate: '2007-10-06T17:46:31'
LastUpdate: '2007-10-06T17:46:31'
LastChecked: '2021-01-19T09:43:57'
Artist: Kenji Ninuma
Title: DISCO PRINCE
Creator: peppy
Source: ''
Tags: katamari
HasVideo: false
Genre: 2
Language: 3
Favourites: 789
Disabled: false
summary: Search
operationId: Search
description: Search for a beatmap set
tags: ['Chimu API']
parameters:
- name: query
in: query
description: Search query
required: false
x-example: peppy
type: string
- name: amount
in: query
description: Amount of resulting beatmaps
required: false
x-example: '100'
type: number
- name: offset
in: query
description: Offset E.G amount + 100 would result in the next page
required: false
x-example: '0'
type: number
- name: status
in: query
description: Ranked statuses of the Beatmap Set
required: false
x-example: '0'
type: string
- name: mode
in: query
description: Required playmodes of the beatmap
required: false
x-example: '0'
type: string
- name: min_ar
in: query
description: Minimum AR
required: false
x-example: '0'
type: number
- name: max_ar
in: query
description: Maximum AR
required: false
x-example: '0'
type: number
- name: min_od
in: query
description: Minimum OD
required: false
x-example: '0'
type: number
- name: max_od
in: query
description: Maximum OD
required: false
x-example: '0'
type: number
- name: min_cs
in: query
description: Minimum CS
required: false
x-example: '0'
type: number
- name: max_cs
in: query
description: Maximum CS
required: false
x-example: '0'
type: number
- name: min_hp
in: query
description: Minimum HP
required: false
x-example: '0'
type: number
- name: max_hp
in: query
description: Maximum HP
required: false
x-example: '0'
type: number
- name: min_diff
in: query
description: Minimum Difficulty
required: false
x-example: '0'
type: number
- name: max_diff
in: query
description: Maximum Difficulty
required: false
x-example: '0'
type: number
- name: min_bpm
in: query
description: Minimum BPM
required: false
x-example: '0'
type: number
- name: max_bpm
in: query
description: Maximum BPM
required: false
x-example: '0'
type: number
- name: min_length
in: query
description: Minimum Beatmap length (in seconds)
required: false
x-example: '0'
type: number
- name: max_length
in: query
description: Maximum Beatmap length (in seconds)
required: false
x-example: '0'
type: number
- name: genre
in: query
description: Genre
required: false
x-example: '0'
type: number
- name: language
in: query
description: Language
required: false
x-example: '0'
type: number
produces:
- application/json
/cheesegull/b/{map_id}:
get:
responses:
'200':
description: OK
headers: {}
examples:
application/json:
BeatmapID: 53
ParentSetID: 3
DiffName: '-Crusin-'
FileMD5: 1d23c37a2fda439be752ae2bca06c0cd
Mode: 0
BPM: 172
AR: 4
OD: 4
CS: 5
HP: 3
TotalLength: 83
HitLength: 77
Playcount: 101574
Passcount: 47994
MaxCombo: 124
DifficultyRating: 1.86918
'400':
description: Bad Request
headers: {}
examples:
application/json:
error_message: One of the query values isn't correct, please check your encoding settings
error_code: oneOfQueryIsntCorrect
'404':
description: Not Found
headers: {}
examples:
application/json:
error_message: Map not found, please try to search another one :/
error_code: map_not_found
summary: Cheesegull> Get beatmap
operationId: Cheesegull> Get beatmap
description: Gets a beatmap.
tags: ['Cheesegull API']
parameters:
- name: map_id
in: path
description: Beatmap Id
required: true
x-example: '53'
type: number
produces:
- application/json
/cheesegull/md5/{map_md5}:
get:
responses:
'200':
description: OK
headers: {}
examples:
application/json:
BeatmapID: 53
ParentSetID: 3
DiffName: '-Crusin-'
FileMD5: 1d23c37a2fda439be752ae2bca06c0cd
Mode: 0
BPM: 172
AR: 4
OD: 4
CS: 5
HP: 3
TotalLength: 83
HitLength: 77
Playcount: 101574
Passcount: 47994
MaxCombo: 124
DifficultyRating: 1.86918
'400':
description: Bad Request
headers: {}
examples:
application/json:
error_message: One of the query values isn't correct, please check your encoding settings
error_code: oneOfQueryIsntCorrect
'404':
description: Not Found
headers: {}
examples:
application/json:
error_message: Map not found, please try to search another one :/
error_code: map_not_found
summary: Cheesegull> Get beatmap
operationId: Cheesegull> Get beatmap
description: Gets a beatmap with specified md5 hash.
tags: ['Cheesegull API']
parameters:
- name: map_md5
in: path
description: Beatmap md5
required: true
x-example: 1d23c37a2fda439be752ae2bca06c0cd
type: string
produces:
- application/json
/cheesegull/s/{set_id}:
get:
responses:
'200':
description: OK
headers: {}
examples:
application/json:
SetID: 1
ChildrenBeatmaps:
- BeatmapID: 75
ParentSetID: 1
DiffName: Normal
FileMD5: a5b99395a42bd55bc5eb1d2411cbdf8b
Mode: 0
BPM: 119.999
AR: 6
OD: 6
CS: 4
HP: 6
TotalLength: 142
HitLength: 109
Playcount: 467474
Passcount: 57119
MaxCombo: 314
DifficultyRating: 2.40729
RankedStatus: 1
ApprovedDate: '2007-10-06T17:46:31Z'
LastUpdate: '2007-10-06T17:46:31Z'
LastChecked: '2021-01-19T09:43:57Z'
Artist: Kenji Ninuma
Title: DISCO PRINCE
Creator: peppy
Source: ''
Tags: katamari
HasVideo: false
Genre: 2
Language: 3
Favourites: 789
'400':
description: Bad Request
headers: {}
examples:
application/json:
error_message: One of the query values isn't correct, please check your encoding settings
error_code: oneOfQueryIsntCorrect
'404':
description: Not Found
headers: {}
examples:
application/json:
error_message: Set not found, please try to search another one :/
error_code: set_not_found
summary: Cheesegull> Get beatmapset
operationId: Cheesegull> Get beatmapset
description: Gets a beatmap set.
tags: ['Cheesegull API']
parameters:
- name: set_id
in: path
description: Beatmapset Id
required: true
x-example: '1'
type: number
produces:
- application/json
/cheesegull/search:
get:
responses:
'200':
description: OK
headers: {}
examples:
application/json:
- SetID: 1
ChildrenBeatmaps:
- BeatmapID: 75
ParentSetID: 1
DiffName: Normal
FileMD5: a5b99395a42bd55bc5eb1d2411cbdf8b
Mode: 0
BPM: 119.999
AR: 6
OD: 6
CS: 4
HP: 6
TotalLength: 142
HitLength: 109
Playcount: 467474
Passcount: 57119
MaxCombo: 314
DifficultyRating: 2.40729
RankedStatus: 1
ApprovedDate: '2007-10-06T17:46:31Z'
LastUpdate: '2007-10-06T17:46:31Z'
LastChecked: '2021-01-19T09:43:57Z'
Artist: Kenji Ninuma
Title: DISCO PRINCE
Creator: peppy
Source: ''
Tags: katamari
HasVideo: false
Genre: 2
Language: 3
Favourites: 789
summary: Cheesegull> Search
operationId: Cheesegull> Search
description: Search for a beatmap set
tags: ['Cheesegull API']
parameters:
- name: query
in: query
description: Search query
required: false
x-example: peppy disco
type: string
- name: amount
in: query
description: Amount of resulting beatmaps
required: false
x-example: '1'
type: number
- name: offset
in: query
description: Offset E.G amount + 100 would result in the next page
required: false
x-example: '0'
type: number
- name: status
in: query
description: Ranked statuses of the Beatmap Set
required: false
x-example: '0'
type: string
- name: mode
in: query
description: Required playmodes of the beatmap
required: false
x-example: '0'
type: string
produces:
- application/json
# definitions:
# Get beatmap: {}
# Get beatmap set: {}
# Download beatmap set: {}
# Search: {}
# Cheesegull> Get beatmap: {}
# Cheesegull> Get beatmapset: {}
# Cheesegull> Search: {}
securityDefinitions: {}
tags: ['Chimu API', 'Cheesegull API']