Skip to content

Commit feb6710

Browse files
SyriiinSyriiin
committed
Update docs
1 parent f31f86a commit feb6710

File tree

4 files changed

+94
-99
lines changed

4 files changed

+94
-99
lines changed

‎docs/docs/api-reference/difficalcy-catch.json

+23-26
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
],
1313
"responses": {
1414
"200": {
15-
"description": "Success",
15+
"description": "OK",
1616
"content": {
1717
"application/json": {
1818
"schema": {
@@ -37,8 +37,7 @@
3737
"maximum": 2147483647,
3838
"minimum": 0,
3939
"type": "integer",
40-
"format": "int32",
41-
"nullable": true
40+
"format": "int32"
4241
}
4342
},
4443
{
@@ -58,8 +57,7 @@
5857
"maximum": 2147483647,
5958
"minimum": 0,
6059
"type": "integer",
61-
"format": "int32",
62-
"nullable": true
60+
"format": "int32"
6361
}
6462
},
6563
{
@@ -69,8 +67,7 @@
6967
"maximum": 2147483647,
7068
"minimum": 0,
7169
"type": "integer",
72-
"format": "int32",
73-
"nullable": true
70+
"format": "int32"
7471
}
7572
},
7673
{
@@ -94,7 +91,7 @@
9491
],
9592
"responses": {
9693
"200": {
97-
"description": "Success",
94+
"description": "OK",
9895
"content": {
9996
"application/json": {
10097
"schema": {
@@ -118,15 +115,14 @@
118115
"type": "array",
119116
"items": {
120117
"$ref": "#/components/schemas/CatchScore"
121-
},
122-
"nullable": true
118+
}
123119
}
124120
}
125121
}
126122
},
127123
"responses": {
128124
"200": {
129-
"description": "Success",
125+
"description": "OK",
130126
"content": {
131127
"application/json": {
132128
"schema": {
@@ -170,17 +166,27 @@
170166
},
171167
"additionalProperties": false
172168
},
173-
"CatchDifficulty": {
169+
"CatchCalculation": {
174170
"type": "object",
175171
"properties": {
176-
"total": {
172+
"difficulty": {
173+
"$ref": "#/components/schemas/CatchDifficulty"
174+
},
175+
"performance": {
176+
"$ref": "#/components/schemas/CatchPerformance"
177+
},
178+
"accuracy": {
179+
"type": "number",
180+
"format": "double"
181+
},
182+
"combo": {
177183
"type": "number",
178184
"format": "double"
179185
}
180186
},
181187
"additionalProperties": false
182188
},
183-
"CatchPerformance": {
189+
"CatchDifficulty": {
184190
"type": "object",
185191
"properties": {
186192
"total": {
@@ -190,20 +196,10 @@
190196
},
191197
"additionalProperties": false
192198
},
193-
"CatchCalculation": {
199+
"CatchPerformance": {
194200
"type": "object",
195201
"properties": {
196-
"difficulty": {
197-
"$ref": "#/components/schemas/CatchDifficulty"
198-
},
199-
"performance": {
200-
"$ref": "#/components/schemas/CatchPerformance"
201-
},
202-
"accuracy": {
203-
"type": "number",
204-
"format": "double"
205-
},
206-
"combo": {
202+
"total": {
207203
"type": "number",
208204
"format": "double"
209205
}
@@ -217,6 +213,7 @@
217213
"type": "object",
218214
"properties": {
219215
"beatmapId": {
216+
"minLength": 1,
220217
"type": "string"
221218
},
222219
"mods": {

‎docs/docs/api-reference/difficalcy-mania.json

+19-19
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
],
1313
"responses": {
1414
"200": {
15-
"description": "Success",
15+
"description": "OK",
1616
"content": {
1717
"application/json": {
1818
"schema": {
@@ -101,7 +101,7 @@
101101
],
102102
"responses": {
103103
"200": {
104-
"description": "Success",
104+
"description": "OK",
105105
"content": {
106106
"application/json": {
107107
"schema": {
@@ -125,15 +125,14 @@
125125
"type": "array",
126126
"items": {
127127
"$ref": "#/components/schemas/ManiaScore"
128-
},
129-
"nullable": true
128+
}
130129
}
131130
}
132131
}
133132
},
134133
"responses": {
135134
"200": {
136-
"description": "Success",
135+
"description": "OK",
137136
"content": {
138137
"application/json": {
139138
"schema": {
@@ -177,40 +176,40 @@
177176
},
178177
"additionalProperties": false
179178
},
180-
"ManiaDifficulty": {
179+
"ManiaCalculation": {
181180
"type": "object",
182181
"properties": {
183-
"total": {
182+
"difficulty": {
183+
"$ref": "#/components/schemas/ManiaDifficulty"
184+
},
185+
"performance": {
186+
"$ref": "#/components/schemas/ManiaPerformance"
187+
},
188+
"accuracy": {
184189
"type": "number",
185190
"format": "double"
186191
}
187192
},
188193
"additionalProperties": false
189194
},
190-
"ManiaPerformance": {
195+
"ManiaDifficulty": {
191196
"type": "object",
192197
"properties": {
193198
"total": {
194199
"type": "number",
195200
"format": "double"
196-
},
197-
"difficulty": {
198-
"type": "number",
199-
"format": "double"
200201
}
201202
},
202203
"additionalProperties": false
203204
},
204-
"ManiaCalculation": {
205+
"ManiaPerformance": {
205206
"type": "object",
206207
"properties": {
207-
"difficulty": {
208-
"$ref": "#/components/schemas/ManiaDifficulty"
209-
},
210-
"performance": {
211-
"$ref": "#/components/schemas/ManiaPerformance"
208+
"total": {
209+
"type": "number",
210+
"format": "double"
212211
},
213-
"accuracy": {
212+
"difficulty": {
214213
"type": "number",
215214
"format": "double"
216215
}
@@ -224,6 +223,7 @@
224223
"type": "object",
225224
"properties": {
226225
"beatmapId": {
226+
"minLength": 1,
227227
"type": "string"
228228
},
229229
"mods": {

‎docs/docs/api-reference/difficalcy-osu.json

+26-27
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
],
1313
"responses": {
1414
"200": {
15-
"description": "Success",
15+
"description": "OK",
1616
"content": {
1717
"application/json": {
1818
"schema": {
@@ -37,8 +37,7 @@
3737
"maximum": 2147483647,
3838
"minimum": 0,
3939
"type": "integer",
40-
"format": "int32",
41-
"nullable": true
40+
"format": "int32"
4241
}
4342
},
4443
{
@@ -92,7 +91,7 @@
9291
],
9392
"responses": {
9493
"200": {
95-
"description": "Success",
94+
"description": "OK",
9695
"content": {
9796
"application/json": {
9897
"schema": {
@@ -116,15 +115,14 @@
116115
"type": "array",
117116
"items": {
118117
"$ref": "#/components/schemas/OsuScore"
119-
},
120-
"nullable": true
118+
}
121119
}
122120
}
123121
}
124122
},
125123
"responses": {
126124
"200": {
127-
"description": "Success",
125+
"description": "OK",
128126
"content": {
129127
"application/json": {
130128
"schema": {
@@ -168,29 +166,27 @@
168166
},
169167
"additionalProperties": false
170168
},
171-
"OsuDifficulty": {
169+
"OsuCalculation": {
172170
"type": "object",
173171
"properties": {
174-
"total": {
175-
"type": "number",
176-
"format": "double"
172+
"difficulty": {
173+
"$ref": "#/components/schemas/OsuDifficulty"
177174
},
178-
"aim": {
179-
"type": "number",
180-
"format": "double"
175+
"performance": {
176+
"$ref": "#/components/schemas/OsuPerformance"
181177
},
182-
"speed": {
178+
"accuracy": {
183179
"type": "number",
184180
"format": "double"
185181
},
186-
"flashlight": {
182+
"combo": {
187183
"type": "number",
188184
"format": "double"
189185
}
190186
},
191187
"additionalProperties": false
192188
},
193-
"OsuPerformance": {
189+
"OsuDifficulty": {
194190
"type": "object",
195191
"properties": {
196192
"total": {
@@ -205,31 +201,33 @@
205201
"type": "number",
206202
"format": "double"
207203
},
208-
"accuracy": {
209-
"type": "number",
210-
"format": "double"
211-
},
212204
"flashlight": {
213205
"type": "number",
214206
"format": "double"
215207
}
216208
},
217209
"additionalProperties": false
218210
},
219-
"OsuCalculation": {
211+
"OsuPerformance": {
220212
"type": "object",
221213
"properties": {
222-
"difficulty": {
223-
"$ref": "#/components/schemas/OsuDifficulty"
214+
"total": {
215+
"type": "number",
216+
"format": "double"
224217
},
225-
"performance": {
226-
"$ref": "#/components/schemas/OsuPerformance"
218+
"aim": {
219+
"type": "number",
220+
"format": "double"
221+
},
222+
"speed": {
223+
"type": "number",
224+
"format": "double"
227225
},
228226
"accuracy": {
229227
"type": "number",
230228
"format": "double"
231229
},
232-
"combo": {
230+
"flashlight": {
233231
"type": "number",
234232
"format": "double"
235233
}
@@ -243,6 +241,7 @@
243241
"type": "object",
244242
"properties": {
245243
"beatmapId": {
244+
"minLength": 1,
246245
"type": "string"
247246
},
248247
"mods": {

0 commit comments

Comments
 (0)