aboutsummaryrefslogtreecommitdiff
path: root/backend/docs
diff options
context:
space:
mode:
Diffstat (limited to 'backend/docs')
-rw-r--r--backend/docs/docs.go90
-rw-r--r--backend/docs/swagger.json90
-rw-r--r--backend/docs/swagger.yaml57
3 files changed, 231 insertions, 6 deletions
diff --git a/backend/docs/docs.go b/backend/docs/docs.go
index f652a1e..c4b2801 100644
--- a/backend/docs/docs.go
+++ b/backend/docs/docs.go
@@ -1171,9 +1171,9 @@ const docTemplate = `{
1171 } 1171 }
1172 } 1172 }
1173 }, 1173 },
1174 "/rankings": { 1174 "/rankings/lphub": {
1175 "get": { 1175 "get": {
1176 "description": "Get rankings of every player.", 1176 "description": "Get rankings of every player from LPHUB.",
1177 "produces": [ 1177 "produces": [
1178 "application/json" 1178 "application/json"
1179 ], 1179 ],
@@ -1202,6 +1202,37 @@ const docTemplate = `{
1202 } 1202 }
1203 } 1203 }
1204 }, 1204 },
1205 "/rankings/steam": {
1206 "get": {
1207 "description": "Get rankings of every player from Steam.",
1208 "produces": [
1209 "application/json"
1210 ],
1211 "tags": [
1212 "rankings"
1213 ],
1214 "responses": {
1215 "200": {
1216 "description": "OK",
1217 "schema": {
1218 "allOf": [
1219 {
1220 "$ref": "#/definitions/models.Response"
1221 },
1222 {
1223 "type": "object",
1224 "properties": {
1225 "data": {
1226 "$ref": "#/definitions/handlers.RankingsSteamResponse"
1227 }
1228 }
1229 }
1230 ]
1231 }
1232 }
1233 }
1234 }
1235 },
1205 "/search": { 1236 "/search": {
1206 "get": { 1237 "get": {
1207 "description": "Get all user and map data matching to the query.", 1238 "description": "Get all user and map data matching to the query.",
@@ -1789,6 +1820,29 @@ const docTemplate = `{
1789 } 1820 }
1790 } 1821 }
1791 }, 1822 },
1823 "handlers.RankingsSteamResponse": {
1824 "type": "object",
1825 "properties": {
1826 "rankings_multiplayer": {
1827 "type": "array",
1828 "items": {
1829 "$ref": "#/definitions/handlers.SteamUserRanking"
1830 }
1831 },
1832 "rankings_overall": {
1833 "type": "array",
1834 "items": {
1835 "$ref": "#/definitions/handlers.SteamUserRanking"
1836 }
1837 },
1838 "rankings_singleplayer": {
1839 "type": "array",
1840 "items": {
1841 "$ref": "#/definitions/handlers.SteamUserRanking"
1842 }
1843 }
1844 }
1845 },
1792 "handlers.RecordResponse": { 1846 "handlers.RecordResponse": {
1793 "type": "object", 1847 "type": "object",
1794 "properties": { 1848 "properties": {
@@ -1854,6 +1908,38 @@ const docTemplate = `{
1854 } 1908 }
1855 } 1909 }
1856 }, 1910 },
1911 "handlers.SteamUserRanking": {
1912 "type": "object",
1913 "properties": {
1914 "avatar_link": {
1915 "type": "string"
1916 },
1917 "mp_rank": {
1918 "type": "integer"
1919 },
1920 "mp_score": {
1921 "type": "integer"
1922 },
1923 "overall_rank": {
1924 "type": "integer"
1925 },
1926 "overall_score": {
1927 "type": "integer"
1928 },
1929 "sp_rank": {
1930 "type": "integer"
1931 },
1932 "sp_score": {
1933 "type": "integer"
1934 },
1935 "steam_id": {
1936 "type": "string"
1937 },
1938 "user_name": {
1939 "type": "string"
1940 }
1941 }
1942 },
1857 "models.Category": { 1943 "models.Category": {
1858 "type": "object", 1944 "type": "object",
1859 "properties": { 1945 "properties": {
diff --git a/backend/docs/swagger.json b/backend/docs/swagger.json
index 6de5978..7613d2c 100644
--- a/backend/docs/swagger.json
+++ b/backend/docs/swagger.json
@@ -1165,9 +1165,9 @@
1165 } 1165 }
1166 } 1166 }
1167 }, 1167 },
1168 "/rankings": { 1168 "/rankings/lphub": {
1169 "get": { 1169 "get": {
1170 "description": "Get rankings of every player.", 1170 "description": "Get rankings of every player from LPHUB.",
1171 "produces": [ 1171 "produces": [
1172 "application/json" 1172 "application/json"
1173 ], 1173 ],
@@ -1196,6 +1196,37 @@
1196 } 1196 }
1197 } 1197 }
1198 }, 1198 },
1199 "/rankings/steam": {
1200 "get": {
1201 "description": "Get rankings of every player from Steam.",
1202 "produces": [
1203 "application/json"
1204 ],
1205 "tags": [
1206 "rankings"
1207 ],
1208 "responses": {
1209 "200": {
1210 "description": "OK",
1211 "schema": {
1212 "allOf": [
1213 {
1214 "$ref": "#/definitions/models.Response"
1215 },
1216 {
1217 "type": "object",
1218 "properties": {
1219 "data": {
1220 "$ref": "#/definitions/handlers.RankingsSteamResponse"
1221 }
1222 }
1223 }
1224 ]
1225 }
1226 }
1227 }
1228 }
1229 },
1199 "/search": { 1230 "/search": {
1200 "get": { 1231 "get": {
1201 "description": "Get all user and map data matching to the query.", 1232 "description": "Get all user and map data matching to the query.",
@@ -1783,6 +1814,29 @@
1783 } 1814 }
1784 } 1815 }
1785 }, 1816 },
1817 "handlers.RankingsSteamResponse": {
1818 "type": "object",
1819 "properties": {
1820 "rankings_multiplayer": {
1821 "type": "array",
1822 "items": {
1823 "$ref": "#/definitions/handlers.SteamUserRanking"
1824 }
1825 },
1826 "rankings_overall": {
1827 "type": "array",
1828 "items": {
1829 "$ref": "#/definitions/handlers.SteamUserRanking"
1830 }
1831 },
1832 "rankings_singleplayer": {
1833 "type": "array",
1834 "items": {
1835 "$ref": "#/definitions/handlers.SteamUserRanking"
1836 }
1837 }
1838 }
1839 },
1786 "handlers.RecordResponse": { 1840 "handlers.RecordResponse": {
1787 "type": "object", 1841 "type": "object",
1788 "properties": { 1842 "properties": {
@@ -1848,6 +1902,38 @@
1848 } 1902 }
1849 } 1903 }
1850 }, 1904 },
1905 "handlers.SteamUserRanking": {
1906 "type": "object",
1907 "properties": {
1908 "avatar_link": {
1909 "type": "string"
1910 },
1911 "mp_rank": {
1912 "type": "integer"
1913 },
1914 "mp_score": {
1915 "type": "integer"
1916 },
1917 "overall_rank": {
1918 "type": "integer"
1919 },
1920 "overall_score": {
1921 "type": "integer"
1922 },
1923 "sp_rank": {
1924 "type": "integer"
1925 },
1926 "sp_score": {
1927 "type": "integer"
1928 },
1929 "steam_id": {
1930 "type": "string"
1931 },
1932 "user_name": {
1933 "type": "string"
1934 }
1935 }
1936 },
1851 "models.Category": { 1937 "models.Category": {
1852 "type": "object", 1938 "type": "object",
1853 "properties": { 1939 "properties": {
diff --git a/backend/docs/swagger.yaml b/backend/docs/swagger.yaml
index 853b3b9..22651e3 100644
--- a/backend/docs/swagger.yaml
+++ b/backend/docs/swagger.yaml
@@ -283,6 +283,21 @@ definitions:
283 $ref: '#/definitions/models.UserRanking' 283 $ref: '#/definitions/models.UserRanking'
284 type: array 284 type: array
285 type: object 285 type: object
286 handlers.RankingsSteamResponse:
287 properties:
288 rankings_multiplayer:
289 items:
290 $ref: '#/definitions/handlers.SteamUserRanking'
291 type: array
292 rankings_overall:
293 items:
294 $ref: '#/definitions/handlers.SteamUserRanking'
295 type: array
296 rankings_singleplayer:
297 items:
298 $ref: '#/definitions/handlers.SteamUserRanking'
299 type: array
300 type: object
286 handlers.RecordResponse: 301 handlers.RecordResponse:
287 properties: 302 properties:
288 score_count: 303 score_count:
@@ -325,6 +340,27 @@ definitions:
325 $ref: '#/definitions/models.UserShortWithAvatar' 340 $ref: '#/definitions/models.UserShortWithAvatar'
326 type: array 341 type: array
327 type: object 342 type: object
343 handlers.SteamUserRanking:
344 properties:
345 avatar_link:
346 type: string
347 mp_rank:
348 type: integer
349 mp_score:
350 type: integer
351 overall_rank:
352 type: integer
353 overall_score:
354 type: integer
355 sp_rank:
356 type: integer
357 sp_score:
358 type: integer
359 steam_id:
360 type: string
361 user_name:
362 type: string
363 type: object
328 models.Category: 364 models.Category:
329 properties: 365 properties:
330 id: 366 id:
@@ -1216,9 +1252,9 @@ paths:
1216 $ref: '#/definitions/models.Response' 1252 $ref: '#/definitions/models.Response'
1217 tags: 1253 tags:
1218 - users 1254 - users
1219 /rankings: 1255 /rankings/lphub:
1220 get: 1256 get:
1221 description: Get rankings of every player. 1257 description: Get rankings of every player from LPHUB.
1222 produces: 1258 produces:
1223 - application/json 1259 - application/json
1224 responses: 1260 responses:
@@ -1233,6 +1269,23 @@ paths:
1233 type: object 1269 type: object
1234 tags: 1270 tags:
1235 - rankings 1271 - rankings
1272 /rankings/steam:
1273 get:
1274 description: Get rankings of every player from Steam.
1275 produces:
1276 - application/json
1277 responses:
1278 "200":
1279 description: OK
1280 schema:
1281 allOf:
1282 - $ref: '#/definitions/models.Response'
1283 - properties:
1284 data:
1285 $ref: '#/definitions/handlers.RankingsSteamResponse'
1286 type: object
1287 tags:
1288 - rankings
1236 /search: 1289 /search:
1237 get: 1290 get:
1238 description: Get all user and map data matching to the query. 1291 description: Get all user and map data matching to the query.