aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/docs.go67
-rw-r--r--docs/swagger.json67
-rw-r--r--docs/swagger.yaml53
3 files changed, 108 insertions, 79 deletions
diff --git a/docs/docs.go b/docs/docs.go
index 164db20..cd129f0 100644
--- a/docs/docs.go
+++ b/docs/docs.go
@@ -26,13 +26,13 @@ const docTemplate = `{
26 "application/json" 26 "application/json"
27 ], 27 ],
28 "tags": [ 28 "tags": [
29 "chapters" 29 "games \u0026 chapters"
30 ], 30 ],
31 "summary": "Get chapters from the specified game id.", 31 "summary": "Get maps from the specified chapter id.",
32 "parameters": [ 32 "parameters": [
33 { 33 {
34 "type": "integer", 34 "type": "integer",
35 "description": "Game ID", 35 "description": "Chapter ID",
36 "name": "id", 36 "name": "id",
37 "in": "path", 37 "in": "path",
38 "required": true 38 "required": true
@@ -50,7 +50,7 @@ const docTemplate = `{
50 "type": "object", 50 "type": "object",
51 "properties": { 51 "properties": {
52 "data": { 52 "data": {
53 "$ref": "#/definitions/models.ChaptersResponse" 53 "$ref": "#/definitions/models.ChapterMapsResponse"
54 } 54 }
55 } 55 }
56 } 56 }
@@ -146,7 +146,7 @@ const docTemplate = `{
146 "application/json" 146 "application/json"
147 ], 147 ],
148 "tags": [ 148 "tags": [
149 "games" 149 "games \u0026 chapters"
150 ], 150 ],
151 "summary": "Get games from the leaderboards.", 151 "summary": "Get games from the leaderboards.",
152 "responses": { 152 "responses": {
@@ -180,18 +180,24 @@ const docTemplate = `{
180 } 180 }
181 } 181 }
182 }, 182 },
183 "/login": { 183 "/games/{id}": {
184 "get": { 184 "get": {
185 "consumes": [
186 "application/json"
187 ],
188 "produces": [ 185 "produces": [
189 "application/json" 186 "application/json"
190 ], 187 ],
191 "tags": [ 188 "tags": [
192 "login" 189 "games \u0026 chapters"
190 ],
191 "summary": "Get chapters from the specified game id.",
192 "parameters": [
193 {
194 "type": "integer",
195 "description": "Game ID",
196 "name": "id",
197 "in": "path",
198 "required": true
199 }
193 ], 200 ],
194 "summary": "Get (redirect) login page for Steam auth.",
195 "responses": { 201 "responses": {
196 "200": { 202 "200": {
197 "description": "OK", 203 "description": "OK",
@@ -204,7 +210,7 @@ const docTemplate = `{
204 "type": "object", 210 "type": "object",
205 "properties": { 211 "properties": {
206 "data": { 212 "data": {
207 "$ref": "#/definitions/models.LoginResponse" 213 "$ref": "#/definitions/models.ChaptersResponse"
208 } 214 }
209 } 215 }
210 } 216 }
@@ -220,24 +226,18 @@ const docTemplate = `{
220 } 226 }
221 } 227 }
222 }, 228 },
223 "/maps/{id}": { 229 "/login": {
224 "get": { 230 "get": {
231 "consumes": [
232 "application/json"
233 ],
225 "produces": [ 234 "produces": [
226 "application/json" 235 "application/json"
227 ], 236 ],
228 "tags": [ 237 "tags": [
229 "maps" 238 "login"
230 ],
231 "summary": "Get maps from the specified chapter id.",
232 "parameters": [
233 {
234 "type": "integer",
235 "description": "Chapter ID",
236 "name": "id",
237 "in": "path",
238 "required": true
239 }
240 ], 239 ],
240 "summary": "Get (redirect) login page for Steam auth.",
241 "responses": { 241 "responses": {
242 "200": { 242 "200": {
243 "description": "OK", 243 "description": "OK",
@@ -250,10 +250,7 @@ const docTemplate = `{
250 "type": "object", 250 "type": "object",
251 "properties": { 251 "properties": {
252 "data": { 252 "data": {
253 "type": "array", 253 "$ref": "#/definitions/models.LoginResponse"
254 "items": {
255 "$ref": "#/definitions/models.MapShort"
256 }
257 } 254 }
258 } 255 }
259 } 256 }
@@ -751,6 +748,20 @@ const docTemplate = `{
751 } 748 }
752 } 749 }
753 }, 750 },
751 "models.ChapterMapsResponse": {
752 "type": "object",
753 "properties": {
754 "chapter": {
755 "$ref": "#/definitions/models.Chapter"
756 },
757 "maps": {
758 "type": "array",
759 "items": {
760 "$ref": "#/definitions/models.MapShort"
761 }
762 }
763 }
764 },
754 "models.ChaptersResponse": { 765 "models.ChaptersResponse": {
755 "type": "object", 766 "type": "object",
756 "properties": { 767 "properties": {
diff --git a/docs/swagger.json b/docs/swagger.json
index 653d52f..442745f 100644
--- a/docs/swagger.json
+++ b/docs/swagger.json
@@ -19,13 +19,13 @@
19 "application/json" 19 "application/json"
20 ], 20 ],
21 "tags": [ 21 "tags": [
22 "chapters" 22 "games \u0026 chapters"
23 ], 23 ],
24 "summary": "Get chapters from the specified game id.", 24 "summary": "Get maps from the specified chapter id.",
25 "parameters": [ 25 "parameters": [
26 { 26 {
27 "type": "integer", 27 "type": "integer",
28 "description": "Game ID", 28 "description": "Chapter ID",
29 "name": "id", 29 "name": "id",
30 "in": "path", 30 "in": "path",
31 "required": true 31 "required": true
@@ -43,7 +43,7 @@
43 "type": "object", 43 "type": "object",
44 "properties": { 44 "properties": {
45 "data": { 45 "data": {
46 "$ref": "#/definitions/models.ChaptersResponse" 46 "$ref": "#/definitions/models.ChapterMapsResponse"
47 } 47 }
48 } 48 }
49 } 49 }
@@ -139,7 +139,7 @@
139 "application/json" 139 "application/json"
140 ], 140 ],
141 "tags": [ 141 "tags": [
142 "games" 142 "games \u0026 chapters"
143 ], 143 ],
144 "summary": "Get games from the leaderboards.", 144 "summary": "Get games from the leaderboards.",
145 "responses": { 145 "responses": {
@@ -173,18 +173,24 @@
173 } 173 }
174 } 174 }
175 }, 175 },
176 "/login": { 176 "/games/{id}": {
177 "get": { 177 "get": {
178 "consumes": [
179 "application/json"
180 ],
181 "produces": [ 178 "produces": [
182 "application/json" 179 "application/json"
183 ], 180 ],
184 "tags": [ 181 "tags": [
185 "login" 182 "games \u0026 chapters"
183 ],
184 "summary": "Get chapters from the specified game id.",
185 "parameters": [
186 {
187 "type": "integer",
188 "description": "Game ID",
189 "name": "id",
190 "in": "path",
191 "required": true
192 }
186 ], 193 ],
187 "summary": "Get (redirect) login page for Steam auth.",
188 "responses": { 194 "responses": {
189 "200": { 195 "200": {
190 "description": "OK", 196 "description": "OK",
@@ -197,7 +203,7 @@
197 "type": "object", 203 "type": "object",
198 "properties": { 204 "properties": {
199 "data": { 205 "data": {
200 "$ref": "#/definitions/models.LoginResponse" 206 "$ref": "#/definitions/models.ChaptersResponse"
201 } 207 }
202 } 208 }
203 } 209 }
@@ -213,24 +219,18 @@
213 } 219 }
214 } 220 }
215 }, 221 },
216 "/maps/{id}": { 222 "/login": {
217 "get": { 223 "get": {
224 "consumes": [
225 "application/json"
226 ],
218 "produces": [ 227 "produces": [
219 "application/json" 228 "application/json"
220 ], 229 ],
221 "tags": [ 230 "tags": [
222 "maps" 231 "login"
223 ],
224 "summary": "Get maps from the specified chapter id.",
225 "parameters": [
226 {
227 "type": "integer",
228 "description": "Chapter ID",
229 "name": "id",
230 "in": "path",
231 "required": true
232 }
233 ], 232 ],
233 "summary": "Get (redirect) login page for Steam auth.",
234 "responses": { 234 "responses": {
235 "200": { 235 "200": {
236 "description": "OK", 236 "description": "OK",
@@ -243,10 +243,7 @@
243 "type": "object", 243 "type": "object",
244 "properties": { 244 "properties": {
245 "data": { 245 "data": {
246 "type": "array", 246 "$ref": "#/definitions/models.LoginResponse"
247 "items": {
248 "$ref": "#/definitions/models.MapShort"
249 }
250 } 247 }
251 } 248 }
252 } 249 }
@@ -744,6 +741,20 @@
744 } 741 }
745 } 742 }
746 }, 743 },
744 "models.ChapterMapsResponse": {
745 "type": "object",
746 "properties": {
747 "chapter": {
748 "$ref": "#/definitions/models.Chapter"
749 },
750 "maps": {
751 "type": "array",
752 "items": {
753 "$ref": "#/definitions/models.MapShort"
754 }
755 }
756 }
757 },
747 "models.ChaptersResponse": { 758 "models.ChaptersResponse": {
748 "type": "object", 759 "type": "object",
749 "properties": { 760 "properties": {
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:
generated by cgit v1.2.3 (git 2.39.1) at 2025-11-09 18:17:08 +0000