Spaces:
Running
Running
Commit
•
ec78582
1
Parent(s):
5b1514b
documentin joke sources
Browse files- static/api.yaml +47 -9
static/api.yaml
CHANGED
|
@@ -74,7 +74,7 @@ paths:
|
|
| 74 |
schema:
|
| 75 |
type: 'string'
|
| 76 |
example: chucknorris
|
| 77 |
-
summary: "Finding joke by language
|
| 78 |
responses:
|
| 79 |
200:
|
| 80 |
description: OK
|
|
@@ -88,6 +88,24 @@ paths:
|
|
| 88 |
application/json:
|
| 89 |
schema:
|
| 90 |
$ref: "#/components/schemas/ErrorObject"
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 91 |
/osu/api/v1/find-song:
|
| 92 |
post:
|
| 93 |
tags:
|
|
@@ -99,7 +117,7 @@ paths:
|
|
| 99 |
schema:
|
| 100 |
type: 'string'
|
| 101 |
example: rickroll
|
| 102 |
-
summary: "Finding beatmap by query
|
| 103 |
responses:
|
| 104 |
200:
|
| 105 |
description: OK
|
|
@@ -130,7 +148,7 @@ paths:
|
|
| 130 |
schema:
|
| 131 |
type: 'integer'
|
| 132 |
example: 1
|
| 133 |
-
summary: "Get beatmap's full song
|
| 134 |
responses:
|
| 135 |
200:
|
| 136 |
description: OK
|
|
@@ -161,7 +179,7 @@ paths:
|
|
| 161 |
schema:
|
| 162 |
type: 'integer'
|
| 163 |
example: 1
|
| 164 |
-
summary: "Get beatmap's song preview
|
| 165 |
responses:
|
| 166 |
200:
|
| 167 |
description: OK
|
|
@@ -179,7 +197,7 @@ paths:
|
|
| 179 |
post:
|
| 180 |
tags:
|
| 181 |
- "System information"
|
| 182 |
-
summary: "Information about server
|
| 183 |
responses:
|
| 184 |
200:
|
| 185 |
description: OK
|
|
@@ -205,7 +223,7 @@ paths:
|
|
| 205 |
type: 'string'
|
| 206 |
example: never gonna give you up
|
| 207 |
|
| 208 |
-
summary: "This method can help with searching videos on YouTube
|
| 209 |
responses:
|
| 210 |
200:
|
| 211 |
description: OK
|
|
@@ -242,7 +260,7 @@ paths:
|
|
| 242 |
type: 'string'
|
| 243 |
example: "worst"
|
| 244 |
|
| 245 |
-
summary: "Download video as audio and providing link for you
|
| 246 |
responses:
|
| 247 |
200:
|
| 248 |
description: OK
|
|
@@ -284,7 +302,7 @@ paths:
|
|
| 284 |
schema:
|
| 285 |
type: 'integer'
|
| 286 |
example: 45
|
| 287 |
-
summary: "Download video as cutted audio and providing link for you
|
| 288 |
responses:
|
| 289 |
200:
|
| 290 |
description: OK
|
|
@@ -405,7 +423,27 @@ components:
|
|
| 405 |
example: 200
|
| 406 |
"result":
|
| 407 |
type: string
|
| 408 |
-
example: ".NET developers are picky when it comes to food.\nThey only like chicken NuGet
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 409 |
SysinfoObject:
|
| 410 |
type: object
|
| 411 |
properties:
|
|
|
|
| 74 |
schema:
|
| 75 |
type: 'string'
|
| 76 |
example: chucknorris
|
| 77 |
+
summary: "Finding joke by language"
|
| 78 |
responses:
|
| 79 |
200:
|
| 80 |
description: OK
|
|
|
|
| 88 |
application/json:
|
| 89 |
schema:
|
| 90 |
$ref: "#/components/schemas/ErrorObject"
|
| 91 |
+
/jokes/api/v1/sources:
|
| 92 |
+
post:
|
| 93 |
+
tags:
|
| 94 |
+
- "Jokes API"
|
| 95 |
+
summary: "Showing all possible jokes sources"
|
| 96 |
+
responses:
|
| 97 |
+
200:
|
| 98 |
+
description: OK
|
| 99 |
+
content:
|
| 100 |
+
application/json:
|
| 101 |
+
schema:
|
| 102 |
+
$ref: "#/components/schemas/JokeSourceObject"
|
| 103 |
+
400:
|
| 104 |
+
description: Bad Request
|
| 105 |
+
content:
|
| 106 |
+
application/json:
|
| 107 |
+
schema:
|
| 108 |
+
$ref: "#/components/schemas/ErrorObject"
|
| 109 |
/osu/api/v1/find-song:
|
| 110 |
post:
|
| 111 |
tags:
|
|
|
|
| 117 |
schema:
|
| 118 |
type: 'string'
|
| 119 |
example: rickroll
|
| 120 |
+
summary: "Finding beatmap by query"
|
| 121 |
responses:
|
| 122 |
200:
|
| 123 |
description: OK
|
|
|
|
| 148 |
schema:
|
| 149 |
type: 'integer'
|
| 150 |
example: 1
|
| 151 |
+
summary: "Get beatmap's full song"
|
| 152 |
responses:
|
| 153 |
200:
|
| 154 |
description: OK
|
|
|
|
| 179 |
schema:
|
| 180 |
type: 'integer'
|
| 181 |
example: 1
|
| 182 |
+
summary: "Get beatmap's song preview"
|
| 183 |
responses:
|
| 184 |
200:
|
| 185 |
description: OK
|
|
|
|
| 197 |
post:
|
| 198 |
tags:
|
| 199 |
- "System information"
|
| 200 |
+
summary: "Information about server"
|
| 201 |
responses:
|
| 202 |
200:
|
| 203 |
description: OK
|
|
|
|
| 223 |
type: 'string'
|
| 224 |
example: never gonna give you up
|
| 225 |
|
| 226 |
+
summary: "This method can help with searching videos on YouTube"
|
| 227 |
responses:
|
| 228 |
200:
|
| 229 |
description: OK
|
|
|
|
| 260 |
type: 'string'
|
| 261 |
example: "worst"
|
| 262 |
|
| 263 |
+
summary: "Download video as audio and providing link for you"
|
| 264 |
responses:
|
| 265 |
200:
|
| 266 |
description: OK
|
|
|
|
| 302 |
schema:
|
| 303 |
type: 'integer'
|
| 304 |
example: 45
|
| 305 |
+
summary: "Download video as cutted audio and providing link for you"
|
| 306 |
responses:
|
| 307 |
200:
|
| 308 |
description: OK
|
|
|
|
| 423 |
example: 200
|
| 424 |
"result":
|
| 425 |
type: string
|
| 426 |
+
example: ".NET developers are picky when it comes to food.\nThey only like chicken NuGet"
|
| 427 |
+
JokeSourceObject:
|
| 428 |
+
type: object
|
| 429 |
+
properties:
|
| 430 |
+
lang1:
|
| 431 |
+
type: array
|
| 432 |
+
items:
|
| 433 |
+
- source 1
|
| 434 |
+
- source 2
|
| 435 |
+
- source 3
|
| 436 |
+
- source 4
|
| 437 |
+
- source 5
|
| 438 |
+
lang2:
|
| 439 |
+
type: array
|
| 440 |
+
items:
|
| 441 |
+
- source 1
|
| 442 |
+
- source 2
|
| 443 |
+
- source 3
|
| 444 |
+
- source 4
|
| 445 |
+
- source 5
|
| 446 |
+
|
| 447 |
SysinfoObject:
|
| 448 |
type: object
|
| 449 |
properties:
|