aboutsummaryrefslogtreecommitdiff
path: root/docs/swagger.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/swagger.yaml')
-rw-r--r--docs/swagger.yaml107
1 files changed, 52 insertions, 55 deletions
diff --git a/docs/swagger.yaml b/docs/swagger.yaml
index 0dd514d..462679e 100644
--- a/docs/swagger.yaml
+++ b/docs/swagger.yaml
@@ -1,6 +1,6 @@
1basePath: /v1 1basePath: /v1
2definitions: 2definitions:
3 controllers.ChapterMapsResponse: 3 handlers.ChapterMapsResponse:
4 properties: 4 properties:
5 chapter: 5 chapter:
6 $ref: '#/definitions/models.Chapter' 6 $ref: '#/definitions/models.Chapter'
@@ -9,7 +9,7 @@ definitions:
9 $ref: '#/definitions/models.MapShort' 9 $ref: '#/definitions/models.MapShort'
10 type: array 10 type: array
11 type: object 11 type: object
12 controllers.ChaptersResponse: 12 handlers.ChaptersResponse:
13 properties: 13 properties:
14 chapters: 14 chapters:
15 items: 15 items:
@@ -18,7 +18,7 @@ definitions:
18 game: 18 game:
19 $ref: '#/definitions/models.Game' 19 $ref: '#/definitions/models.Game'
20 type: object 20 type: object
21 controllers.CreateMapSummaryRequest: 21 handlers.CreateMapSummaryRequest:
22 properties: 22 properties:
23 category_id: 23 category_id:
24 type: integer 24 type: integer
@@ -39,21 +39,21 @@ definitions:
39 - score_count 39 - score_count
40 - user_name 40 - user_name
41 type: object 41 type: object
42 controllers.DeleteMapSummaryRequest: 42 handlers.DeleteMapSummaryRequest:
43 properties: 43 properties:
44 route_id: 44 route_id:
45 type: integer 45 type: integer
46 required: 46 required:
47 - route_id 47 - route_id
48 type: object 48 type: object
49 controllers.EditMapImageRequest: 49 handlers.EditMapImageRequest:
50 properties: 50 properties:
51 image: 51 image:
52 type: string 52 type: string
53 required: 53 required:
54 - image 54 - image
55 type: object 55 type: object
56 controllers.EditMapSummaryRequest: 56 handlers.EditMapSummaryRequest:
57 properties: 57 properties:
58 description: 58 description:
59 type: string 59 type: string
@@ -74,28 +74,34 @@ definitions:
74 - score_count 74 - score_count
75 - user_name 75 - user_name
76 type: object 76 type: object
77 controllers.LoginResponse: 77 handlers.LoginResponse:
78 properties: 78 properties:
79 token: 79 token:
80 type: string 80 type: string
81 type: object 81 type: object
82 controllers.MapSummaryResponse: 82 handlers.MapLeaderboardsResponse:
83 properties:
84 map:
85 $ref: '#/definitions/models.Map'
86 records: {}
87 type: object
88 handlers.MapSummaryResponse:
83 properties: 89 properties:
84 map: 90 map:
85 $ref: '#/definitions/models.Map' 91 $ref: '#/definitions/models.Map'
86 summary: 92 summary:
87 $ref: '#/definitions/models.MapSummary' 93 $ref: '#/definitions/models.MapSummary'
88 type: object 94 type: object
89 controllers.ProfileRankings: 95 handlers.ProfileRankings:
90 properties: 96 properties:
91 cooperative: 97 cooperative:
92 $ref: '#/definitions/controllers.ProfileRankingsDetails' 98 $ref: '#/definitions/handlers.ProfileRankingsDetails'
93 overall: 99 overall:
94 $ref: '#/definitions/controllers.ProfileRankingsDetails' 100 $ref: '#/definitions/handlers.ProfileRankingsDetails'
95 singleplayer: 101 singleplayer:
96 $ref: '#/definitions/controllers.ProfileRankingsDetails' 102 $ref: '#/definitions/handlers.ProfileRankingsDetails'
97 type: object 103 type: object
98 controllers.ProfileRankingsDetails: 104 handlers.ProfileRankingsDetails:
99 properties: 105 properties:
100 completion_count: 106 completion_count:
101 type: integer 107 type: integer
@@ -104,18 +110,18 @@ definitions:
104 rank: 110 rank:
105 type: integer 111 type: integer
106 type: object 112 type: object
107 controllers.ProfileRecords: 113 handlers.ProfileRecords:
108 properties: 114 properties:
109 portal2_cooperative: 115 portal2_cooperative:
110 items: 116 items:
111 $ref: '#/definitions/controllers.ProfileRecordsDetails' 117 $ref: '#/definitions/handlers.ProfileRecordsDetails'
112 type: array 118 type: array
113 portal2_singleplayer: 119 portal2_singleplayer:
114 items: 120 items:
115 $ref: '#/definitions/controllers.ProfileRecordsDetails' 121 $ref: '#/definitions/handlers.ProfileRecordsDetails'
116 type: array 122 type: array
117 type: object 123 type: object
118 controllers.ProfileRecordsDetails: 124 handlers.ProfileRecordsDetails:
119 properties: 125 properties:
120 map_id: 126 map_id:
121 type: integer 127 type: integer
@@ -123,10 +129,10 @@ definitions:
123 type: string 129 type: string
124 scores: 130 scores:
125 items: 131 items:
126 $ref: '#/definitions/controllers.ProfileScores' 132 $ref: '#/definitions/handlers.ProfileScores'
127 type: array 133 type: array
128 type: object 134 type: object
129 controllers.ProfileResponse: 135 handlers.ProfileResponse:
130 properties: 136 properties:
131 avatar_link: 137 avatar_link:
132 type: string 138 type: string
@@ -137,9 +143,9 @@ definitions:
137 profile: 143 profile:
138 type: boolean 144 type: boolean
139 rankings: 145 rankings:
140 $ref: '#/definitions/controllers.ProfileRankings' 146 $ref: '#/definitions/handlers.ProfileRankings'
141 records: 147 records:
142 $ref: '#/definitions/controllers.ProfileRecords' 148 $ref: '#/definitions/handlers.ProfileRecords'
143 steam_id: 149 steam_id:
144 type: string 150 type: string
145 titles: 151 titles:
@@ -149,7 +155,7 @@ definitions:
149 user_name: 155 user_name:
150 type: string 156 type: string
151 type: object 157 type: object
152 controllers.ProfileScores: 158 handlers.ProfileScores:
153 properties: 159 properties:
154 date: 160 date:
155 type: string 161 type: string
@@ -160,7 +166,7 @@ definitions:
160 score_time: 166 score_time:
161 type: integer 167 type: integer
162 type: object 168 type: object
163 controllers.RankingsResponse: 169 handlers.RankingsResponse:
164 properties: 170 properties:
165 rankings_mp: 171 rankings_mp:
166 items: 172 items:
@@ -171,14 +177,14 @@ definitions:
171 $ref: '#/definitions/models.UserRanking' 177 $ref: '#/definitions/models.UserRanking'
172 type: array 178 type: array
173 type: object 179 type: object
174 controllers.RecordResponse: 180 handlers.RecordResponse:
175 properties: 181 properties:
176 score_count: 182 score_count:
177 type: integer 183 type: integer
178 score_time: 184 score_time:
179 type: integer 185 type: integer
180 type: object 186 type: object
181 controllers.SearchResponse: 187 handlers.SearchResponse:
182 properties: 188 properties:
183 maps: 189 maps:
184 items: 190 items:
@@ -247,10 +253,6 @@ definitions:
247 score_count: 253 score_count:
248 type: integer 254 type: integer
249 type: object 255 type: object
250 models.MapRecords:
251 properties:
252 records: {}
253 type: object
254 models.MapRoute: 256 models.MapRoute:
255 properties: 257 properties:
256 category: 258 category:
@@ -340,7 +342,7 @@ paths:
340 - $ref: '#/definitions/models.Response' 342 - $ref: '#/definitions/models.Response'
341 - properties: 343 - properties:
342 data: 344 data:
343 $ref: '#/definitions/controllers.ChapterMapsResponse' 345 $ref: '#/definitions/handlers.ChapterMapsResponse'
344 type: object 346 type: object
345 "400": 347 "400":
346 description: Bad Request 348 description: Bad Request
@@ -414,7 +416,7 @@ paths:
414 - $ref: '#/definitions/models.Response' 416 - $ref: '#/definitions/models.Response'
415 - properties: 417 - properties:
416 data: 418 data:
417 $ref: '#/definitions/controllers.ChaptersResponse' 419 $ref: '#/definitions/handlers.ChaptersResponse'
418 type: object 420 type: object
419 "400": 421 "400":
420 description: Bad Request 422 description: Bad Request
@@ -437,7 +439,7 @@ paths:
437 - $ref: '#/definitions/models.Response' 439 - $ref: '#/definitions/models.Response'
438 - properties: 440 - properties:
439 data: 441 data:
440 $ref: '#/definitions/controllers.LoginResponse' 442 $ref: '#/definitions/handlers.LoginResponse'
441 type: object 443 type: object
442 "400": 444 "400":
443 description: Bad Request 445 description: Bad Request
@@ -464,7 +466,7 @@ paths:
464 name: request 466 name: request
465 required: true 467 required: true
466 schema: 468 schema:
467 $ref: '#/definitions/controllers.EditMapImageRequest' 469 $ref: '#/definitions/handlers.EditMapImageRequest'
468 produces: 470 produces:
469 - application/json 471 - application/json
470 responses: 472 responses:
@@ -475,7 +477,7 @@ paths:
475 - $ref: '#/definitions/models.Response' 477 - $ref: '#/definitions/models.Response'
476 - properties: 478 - properties:
477 data: 479 data:
478 $ref: '#/definitions/controllers.EditMapImageRequest' 480 $ref: '#/definitions/handlers.EditMapImageRequest'
479 type: object 481 type: object
480 "400": 482 "400":
481 description: Bad Request 483 description: Bad Request
@@ -502,12 +504,7 @@ paths:
502 - $ref: '#/definitions/models.Response' 504 - $ref: '#/definitions/models.Response'
503 - properties: 505 - properties:
504 data: 506 data:
505 allOf: 507 $ref: '#/definitions/handlers.MapLeaderboardsResponse'
506 - $ref: '#/definitions/models.Map'
507 - properties:
508 data:
509 $ref: '#/definitions/models.MapRecords'
510 type: object
511 type: object 508 type: object
512 "400": 509 "400":
513 description: Bad Request 510 description: Bad Request
@@ -558,7 +555,7 @@ paths:
558 - $ref: '#/definitions/models.Response' 555 - $ref: '#/definitions/models.Response'
559 - properties: 556 - properties:
560 data: 557 data:
561 $ref: '#/definitions/controllers.RecordResponse' 558 $ref: '#/definitions/handlers.RecordResponse'
562 type: object 559 type: object
563 "400": 560 "400":
564 description: Bad Request 561 description: Bad Request
@@ -589,7 +586,7 @@ paths:
589 name: request 586 name: request
590 required: true 587 required: true
591 schema: 588 schema:
592 $ref: '#/definitions/controllers.DeleteMapSummaryRequest' 589 $ref: '#/definitions/handlers.DeleteMapSummaryRequest'
593 produces: 590 produces:
594 - application/json 591 - application/json
595 responses: 592 responses:
@@ -600,7 +597,7 @@ paths:
600 - $ref: '#/definitions/models.Response' 597 - $ref: '#/definitions/models.Response'
601 - properties: 598 - properties:
602 data: 599 data:
603 $ref: '#/definitions/controllers.DeleteMapSummaryRequest' 600 $ref: '#/definitions/handlers.DeleteMapSummaryRequest'
604 type: object 601 type: object
605 "400": 602 "400":
606 description: Bad Request 603 description: Bad Request
@@ -626,7 +623,7 @@ paths:
626 - $ref: '#/definitions/models.Response' 623 - $ref: '#/definitions/models.Response'
627 - properties: 624 - properties:
628 data: 625 data:
629 $ref: '#/definitions/controllers.MapSummaryResponse' 626 $ref: '#/definitions/handlers.MapSummaryResponse'
630 type: object 627 type: object
631 "400": 628 "400":
632 description: Bad Request 629 description: Bad Request
@@ -652,7 +649,7 @@ paths:
652 name: request 649 name: request
653 required: true 650 required: true
654 schema: 651 schema:
655 $ref: '#/definitions/controllers.CreateMapSummaryRequest' 652 $ref: '#/definitions/handlers.CreateMapSummaryRequest'
656 produces: 653 produces:
657 - application/json 654 - application/json
658 responses: 655 responses:
@@ -663,7 +660,7 @@ paths:
663 - $ref: '#/definitions/models.Response' 660 - $ref: '#/definitions/models.Response'
664 - properties: 661 - properties:
665 data: 662 data:
666 $ref: '#/definitions/controllers.CreateMapSummaryRequest' 663 $ref: '#/definitions/handlers.CreateMapSummaryRequest'
667 type: object 664 type: object
668 "400": 665 "400":
669 description: Bad Request 666 description: Bad Request
@@ -689,7 +686,7 @@ paths:
689 name: request 686 name: request
690 required: true 687 required: true
691 schema: 688 schema:
692 $ref: '#/definitions/controllers.EditMapSummaryRequest' 689 $ref: '#/definitions/handlers.EditMapSummaryRequest'
693 produces: 690 produces:
694 - application/json 691 - application/json
695 responses: 692 responses:
@@ -700,7 +697,7 @@ paths:
700 - $ref: '#/definitions/models.Response' 697 - $ref: '#/definitions/models.Response'
701 - properties: 698 - properties:
702 data: 699 data:
703 $ref: '#/definitions/controllers.EditMapSummaryRequest' 700 $ref: '#/definitions/handlers.EditMapSummaryRequest'
704 type: object 701 type: object
705 "400": 702 "400":
706 description: Bad Request 703 description: Bad Request
@@ -729,7 +726,7 @@ paths:
729 - $ref: '#/definitions/models.Response' 726 - $ref: '#/definitions/models.Response'
730 - properties: 727 - properties:
731 data: 728 data:
732 $ref: '#/definitions/controllers.ProfileResponse' 729 $ref: '#/definitions/handlers.ProfileResponse'
733 type: object 730 type: object
734 "400": 731 "400":
735 description: Bad Request 732 description: Bad Request
@@ -761,7 +758,7 @@ paths:
761 - $ref: '#/definitions/models.Response' 758 - $ref: '#/definitions/models.Response'
762 - properties: 759 - properties:
763 data: 760 data:
764 $ref: '#/definitions/controllers.ProfileResponse' 761 $ref: '#/definitions/handlers.ProfileResponse'
765 type: object 762 type: object
766 "400": 763 "400":
767 description: Bad Request 764 description: Bad Request
@@ -818,7 +815,7 @@ paths:
818 - $ref: '#/definitions/models.Response' 815 - $ref: '#/definitions/models.Response'
819 - properties: 816 - properties:
820 data: 817 data:
821 $ref: '#/definitions/controllers.RankingsResponse' 818 $ref: '#/definitions/handlers.RankingsResponse'
822 type: object 819 type: object
823 "400": 820 "400":
824 description: Bad Request 821 description: Bad Request
@@ -844,7 +841,7 @@ paths:
844 - $ref: '#/definitions/models.Response' 841 - $ref: '#/definitions/models.Response'
845 - properties: 842 - properties:
846 data: 843 data:
847 $ref: '#/definitions/controllers.SearchResponse' 844 $ref: '#/definitions/handlers.SearchResponse'
848 type: object 845 type: object
849 "400": 846 "400":
850 description: Bad Request 847 description: Bad Request
@@ -865,7 +862,7 @@ paths:
865 - $ref: '#/definitions/models.Response' 862 - $ref: '#/definitions/models.Response'
866 - properties: 863 - properties:
867 data: 864 data:
868 $ref: '#/definitions/controllers.LoginResponse' 865 $ref: '#/definitions/handlers.LoginResponse'
869 type: object 866 type: object
870 "404": 867 "404":
871 description: Not Found 868 description: Not Found
@@ -885,7 +882,7 @@ paths:
885 - $ref: '#/definitions/models.Response' 882 - $ref: '#/definitions/models.Response'
886 - properties: 883 - properties:
887 data: 884 data:
888 $ref: '#/definitions/controllers.LoginResponse' 885 $ref: '#/definitions/handlers.LoginResponse'
889 type: object 886 type: object
890 "404": 887 "404":
891 description: Not Found 888 description: Not Found
@@ -914,7 +911,7 @@ paths:
914 - $ref: '#/definitions/models.Response' 911 - $ref: '#/definitions/models.Response'
915 - properties: 912 - properties:
916 data: 913 data:
917 $ref: '#/definitions/controllers.ProfileResponse' 914 $ref: '#/definitions/handlers.ProfileResponse'
918 type: object 915 type: object
919 "400": 916 "400":
920 description: Bad Request 917 description: Bad Request