Skip to content

Commit af6af0c

Browse files
authored
Update swagger documentation to be better aligned with code. (#313)
Update yarn packages.
1 parent a97b59b commit af6af0c

File tree

20 files changed

+1778
-1423
lines changed

20 files changed

+1778
-1423
lines changed

src/routes/leaderboard.ts

Lines changed: 98 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,84 @@ import { Player } from "../types/leaderboard/Player.js";
2424
*
2525
* components:
2626
* schemas:
27+
* Player:
28+
* type: object
29+
* properties:
30+
* steamId:
31+
* type: string
32+
* name:
33+
* type: string
34+
* kills:
35+
* type: integer
36+
* deaths:
37+
* type: integer
38+
* assists:
39+
* type: integer
40+
* k1:
41+
* type: integer
42+
* k2:
43+
* type: integer
44+
* k3:
45+
* type: integer
46+
* k4:
47+
* type: integer
48+
* k5:
49+
* type: integer
50+
* v1:
51+
* type: integer
52+
* v2:
53+
* type: integer
54+
* v3:
55+
* type: integer
56+
* v4:
57+
* type: integer
58+
* v5:
59+
* type: integer
60+
* trp:
61+
* type: integer
62+
* fba:
63+
* type: integer
64+
* total_damage:
65+
* type: integer
66+
* hsk:
67+
* type: integer
68+
* hsp:
69+
* type: number
70+
* average_rating:
71+
* type: number
72+
* wins:
73+
* type: integer
74+
* total_maps:
75+
* type: integer
76+
* enemies_flashed:
77+
* type: integer
78+
* friendlies_flashed:
79+
* type: integer
80+
* util_damage:
81+
* type: integer
82+
* TeamStanding:
83+
* type: object
84+
* properties:
85+
* name:
86+
* type: string
87+
* wins:
88+
* type: integer
89+
* losses:
90+
* type: integer
91+
* rounddiff:
92+
* type: integer
2793
* SimpleResponse:
2894
* type: object
2995
* properties:
3096
* message:
3197
* type: string
98+
* SimpleResponseStatus:
99+
* type: object
100+
* properties:
101+
* message:
102+
* type: string
103+
* status:
104+
* type: integer
32105
* responses:
33106
* BadRequest:
34107
* description: Bad request, information not provided.
@@ -61,7 +134,7 @@ import { Player } from "../types/leaderboard/Player.js";
61134
* schema:
62135
* $ref: '#/components/schemas/SimpleResponse'
63136
*/
64-
137+
65138
/**
66139
* @swagger
67140
*
@@ -78,7 +151,12 @@ import { Player } from "../types/leaderboard/Player.js";
78151
* content:
79152
* application/json:
80153
* schema:
81-
* $ref: '#/components/schemas/SimpleResponse'
154+
* type: object
155+
* properties:
156+
* leaderboard:
157+
* type: array
158+
* items:
159+
* $ref: '#/components/schemas/TeamStanding'
82160
* 500:
83161
* $ref: '#/components/responses/Error'
84162
*/
@@ -108,7 +186,12 @@ import { Player } from "../types/leaderboard/Player.js";
108186
* content:
109187
* application/json:
110188
* schema:
111-
* $ref: '#/components/schemas/SimpleResponse'
189+
* type: object
190+
* properties:
191+
* leaderboard:
192+
* type: array
193+
* items:
194+
* $ref: '#/components/schemas/Player'
112195
* 500:
113196
* $ref: '#/components/responses/Error'
114197
*/
@@ -138,7 +221,12 @@ import { Player } from "../types/leaderboard/Player.js";
138221
* content:
139222
* application/json:
140223
* schema:
141-
* $ref: '#/components/schemas/SimpleResponse'
224+
* type: object
225+
* properties:
226+
* leaderboard:
227+
* type: array
228+
* items:
229+
* $ref: '#/components/schemas/Player'
142230
* 500:
143231
* $ref: '#/components/responses/Error'
144232
*/
@@ -173,7 +261,12 @@ import { Player } from "../types/leaderboard/Player.js";
173261
* content:
174262
* application/json:
175263
* schema:
176-
* $ref: '#/components/schemas/SimpleResponse'
264+
* type: object
265+
* properties:
266+
* leaderboard:
267+
* type: array
268+
* items:
269+
* $ref: '#/components/schemas/TeamStanding'
177270
* 500:
178271
* $ref: '#/components/responses/Error'
179272
*/

0 commit comments

Comments
 (0)