diff options
Diffstat (limited to 'docs/swagger.yaml')
| -rw-r--r-- | docs/swagger.yaml | 53 |
1 files changed, 30 insertions, 23 deletions
diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 88f2d7f..fa1a26d 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml | |||
| @@ -7,6 +7,15 @@ definitions: | |||
| 7 | name: | 7 | name: |
| 8 | type: string | 8 | type: string |
| 9 | type: object | 9 | type: object |
| 10 | models.ChapterMapsResponse: | ||
| 11 | properties: | ||
| 12 | chapter: | ||
| 13 | $ref: '#/definitions/models.Chapter' | ||
| 14 | maps: | ||
| 15 | items: | ||
| 16 | $ref: '#/definitions/models.MapShort' | ||
| 17 | type: array | ||
| 18 | type: object | ||
| 10 | models.ChaptersResponse: | 19 | models.ChaptersResponse: |
| 11 | properties: | 20 | properties: |
| 12 | chapters: | 21 | chapters: |
| @@ -195,7 +204,7 @@ paths: | |||
| 195 | /chapters/{id}: | 204 | /chapters/{id}: |
| 196 | get: | 205 | get: |
| 197 | parameters: | 206 | parameters: |
| 198 | - description: Game ID | 207 | - description: Chapter ID |
| 199 | in: path | 208 | in: path |
| 200 | name: id | 209 | name: id |
| 201 | required: true | 210 | required: true |
| @@ -210,15 +219,15 @@ paths: | |||
| 210 | - $ref: '#/definitions/models.Response' | 219 | - $ref: '#/definitions/models.Response' |
| 211 | - properties: | 220 | - properties: |
| 212 | data: | 221 | data: |
| 213 | $ref: '#/definitions/models.ChaptersResponse' | 222 | $ref: '#/definitions/models.ChapterMapsResponse' |
| 214 | type: object | 223 | type: object |
| 215 | "400": | 224 | "400": |
| 216 | description: Bad Request | 225 | description: Bad Request |
| 217 | schema: | 226 | schema: |
| 218 | $ref: '#/definitions/models.Response' | 227 | $ref: '#/definitions/models.Response' |
| 219 | summary: Get chapters from the specified game id. | 228 | summary: Get maps from the specified chapter id. |
| 220 | tags: | 229 | tags: |
| 221 | - chapters | 230 | - games & chapters |
| 222 | /demo: | 231 | /demo: |
| 223 | get: | 232 | get: |
| 224 | produces: | 233 | produces: |
| @@ -286,11 +295,15 @@ paths: | |||
| 286 | $ref: '#/definitions/models.Response' | 295 | $ref: '#/definitions/models.Response' |
| 287 | summary: Get games from the leaderboards. | 296 | summary: Get games from the leaderboards. |
| 288 | tags: | 297 | tags: |
| 289 | - games | 298 | - games & chapters |
| 290 | /login: | 299 | /games/{id}: |
| 291 | get: | 300 | get: |
| 292 | consumes: | 301 | parameters: |
| 293 | - application/json | 302 | - description: Game ID |
| 303 | in: path | ||
| 304 | name: id | ||
| 305 | required: true | ||
| 306 | type: integer | ||
| 294 | produces: | 307 | produces: |
| 295 | - application/json | 308 | - application/json |
| 296 | responses: | 309 | responses: |
| @@ -301,23 +314,19 @@ paths: | |||
| 301 | - $ref: '#/definitions/models.Response' | 314 | - $ref: '#/definitions/models.Response' |
| 302 | - properties: | 315 | - properties: |
| 303 | data: | 316 | data: |
| 304 | $ref: '#/definitions/models.LoginResponse' | 317 | $ref: '#/definitions/models.ChaptersResponse' |
| 305 | type: object | 318 | type: object |
| 306 | "400": | 319 | "400": |
| 307 | description: Bad Request | 320 | description: Bad Request |
| 308 | schema: | 321 | schema: |
| 309 | $ref: '#/definitions/models.Response' | 322 | $ref: '#/definitions/models.Response' |
| 310 | summary: Get (redirect) login page for Steam auth. | 323 | summary: Get chapters from the specified game id. |
| 311 | tags: | 324 | tags: |
| 312 | - login | 325 | - games & chapters |
| 313 | /maps/{id}: | 326 | /login: |
| 314 | get: | 327 | get: |
| 315 | parameters: | 328 | consumes: |
| 316 | - description: Chapter ID | 329 | - application/json |
| 317 | in: path | ||
| 318 | name: id | ||
| 319 | required: true | ||
| 320 | type: integer | ||
| 321 | produces: | 330 | produces: |
| 322 | - application/json | 331 | - application/json |
| 323 | responses: | 332 | responses: |
| @@ -328,17 +337,15 @@ paths: | |||
| 328 | - $ref: '#/definitions/models.Response' | 337 | - $ref: '#/definitions/models.Response' |
| 329 | - properties: | 338 | - properties: |
| 330 | data: | 339 | data: |
| 331 | items: | 340 | $ref: '#/definitions/models.LoginResponse' |
| 332 | $ref: '#/definitions/models.MapShort' | ||
| 333 | type: array | ||
| 334 | type: object | 341 | type: object |
| 335 | "400": | 342 | "400": |
| 336 | description: Bad Request | 343 | description: Bad Request |
| 337 | schema: | 344 | schema: |
| 338 | $ref: '#/definitions/models.Response' | 345 | $ref: '#/definitions/models.Response' |
| 339 | summary: Get maps from the specified chapter id. | 346 | summary: Get (redirect) login page for Steam auth. |
| 340 | tags: | 347 | tags: |
| 341 | - maps | 348 | - login |
| 342 | /maps/{id}/leaderboards: | 349 | /maps/{id}/leaderboards: |
| 343 | get: | 350 | get: |
| 344 | parameters: | 351 | parameters: |