From c071eeca829a18941fc29f4e4eb8b8f93a65b5c4 Mon Sep 17 00:00:00 2001
From: Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com>
Date: Mon, 3 Jul 2023 23:16:42 +0300
Subject: docs: refactor docs

Former-commit-id: 3f3833af352d8758ca509a4fe3badedd5250b1ba
---
 docs/swagger.json | 112 +++++++++++++++++++++++++++---------------------------
 1 file changed, 56 insertions(+), 56 deletions(-)

(limited to 'docs/swagger.json')

diff --git a/docs/swagger.json b/docs/swagger.json
index 3530d2c..ef422ab 100644
--- a/docs/swagger.json
+++ b/docs/swagger.json
@@ -15,13 +15,13 @@
     "paths": {
         "/chapters/{id}": {
             "get": {
+                "description": "Get maps from the specified chapter id.",
                 "produces": [
                     "application/json"
                 ],
                 "tags": [
                     "games \u0026 chapters"
                 ],
-                "summary": "Get maps from the specified chapter id.",
                 "parameters": [
                     {
                         "type": "integer",
@@ -59,45 +59,9 @@
                 }
             }
         },
-        "/demo": {
-            "get": {
-                "produces": [
-                    "application/json"
-                ],
-                "tags": [
-                    "rankings"
-                ],
-                "summary": "Get rankings of every player.",
-                "responses": {
-                    "200": {
-                        "description": "OK",
-                        "schema": {
-                            "allOf": [
-                                {
-                                    "$ref": "#/definitions/models.Response"
-                                },
-                                {
-                                    "type": "object",
-                                    "properties": {
-                                        "data": {
-                                            "$ref": "#/definitions/models.RankingsResponse"
-                                        }
-                                    }
-                                }
-                            ]
-                        }
-                    },
-                    "400": {
-                        "description": "Bad Request",
-                        "schema": {
-                            "$ref": "#/definitions/models.Response"
-                        }
-                    }
-                }
-            }
-        },
         "/demos": {
             "get": {
+                "description": "Get demo with specified demo uuid.",
                 "consumes": [
                     "application/json"
                 ],
@@ -107,10 +71,9 @@
                 "tags": [
                     "demo"
                 ],
-                "summary": "Get demo with specified demo uuid.",
                 "parameters": [
                     {
-                        "type": "integer",
+                        "type": "string",
                         "description": "Demo UUID",
                         "name": "uuid",
                         "in": "query",
@@ -135,13 +98,13 @@
         },
         "/games": {
             "get": {
+                "description": "Get games from the leaderboards.",
                 "produces": [
                     "application/json"
                 ],
                 "tags": [
                     "games \u0026 chapters"
                 ],
-                "summary": "Get games from the leaderboards.",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -175,13 +138,13 @@
         },
         "/games/{id}": {
             "get": {
+                "description": "Get chapters from the specified game id.",
                 "produces": [
                     "application/json"
                 ],
                 "tags": [
                     "games \u0026 chapters"
                 ],
-                "summary": "Get chapters from the specified game id.",
                 "parameters": [
                     {
                         "type": "integer",
@@ -221,6 +184,7 @@
         },
         "/login": {
             "get": {
+                "description": "Get (redirect) login page for Steam auth.",
                 "consumes": [
                     "application/json"
                 ],
@@ -230,7 +194,6 @@
                 "tags": [
                     "login"
                 ],
-                "summary": "Get (redirect) login page for Steam auth.",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -261,13 +224,13 @@
         },
         "/maps/{id}/leaderboards": {
             "get": {
+                "description": "Get map leaderboards with specified id.",
                 "produces": [
                     "application/json"
                 ],
                 "tags": [
                     "maps"
                 ],
-                "summary": "Get map leaderboards with specified id.",
                 "parameters": [
                     {
                         "type": "integer",
@@ -319,6 +282,7 @@
         },
         "/maps/{id}/record": {
             "post": {
+                "description": "Post record with demo of a specific map.",
                 "consumes": [
                     "multipart/form-data"
                 ],
@@ -328,7 +292,6 @@
                 "tags": [
                     "maps"
                 ],
-                "summary": "Post record with demo of a specific map.",
                 "parameters": [
                     {
                         "type": "integer",
@@ -394,13 +357,13 @@
         },
         "/maps/{id}/summary": {
             "get": {
+                "description": "Get map summary with specified id.",
                 "produces": [
                     "application/json"
                 ],
                 "tags": [
                     "maps"
                 ],
-                "summary": "Get map summary with specified id.",
                 "parameters": [
                     {
                         "type": "integer",
@@ -438,13 +401,13 @@
                 }
             },
             "put": {
+                "description": "Edit map summary with specified map id.",
                 "produces": [
                     "application/json"
                 ],
                 "tags": [
                     "maps"
                 ],
-                "summary": "Edit map summary with specified map id.",
                 "parameters": [
                     {
                         "type": "string",
@@ -498,13 +461,13 @@
                 }
             },
             "post": {
+                "description": "Create map summary with specified map id.",
                 "produces": [
                     "application/json"
                 ],
                 "tags": [
                     "maps"
                 ],
-                "summary": "Create map summary with specified map id.",
                 "parameters": [
                     {
                         "type": "string",
@@ -558,13 +521,13 @@
                 }
             },
             "delete": {
+                "description": "Delete map summary with specified map id.",
                 "produces": [
                     "application/json"
                 ],
                 "tags": [
                     "maps"
                 ],
-                "summary": "Delete map summary with specified map id.",
                 "parameters": [
                     {
                         "type": "string",
@@ -620,6 +583,7 @@
         },
         "/profile": {
             "get": {
+                "description": "Get profile page of session user.",
                 "consumes": [
                     "application/json"
                 ],
@@ -629,7 +593,6 @@
                 "tags": [
                     "users"
                 ],
-                "summary": "Get profile page of session user.",
                 "parameters": [
                     {
                         "type": "string",
@@ -673,6 +636,7 @@
                 }
             },
             "put": {
+                "description": "Update country code of session user.",
                 "consumes": [
                     "application/json"
                 ],
@@ -682,7 +646,6 @@
                 "tags": [
                     "users"
                 ],
-                "summary": "Update country code of session user.",
                 "parameters": [
                     {
                         "type": "string",
@@ -721,6 +684,7 @@
                 }
             },
             "post": {
+                "description": "Update profile page of session user.",
                 "consumes": [
                     "application/json"
                 ],
@@ -730,7 +694,6 @@
                 "tags": [
                     "users"
                 ],
-                "summary": "Update profile page of session user.",
                 "parameters": [
                     {
                         "type": "string",
@@ -774,15 +737,52 @@
                 }
             }
         },
+        "/rankings": {
+            "get": {
+                "description": "Get rankings of every player.",
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "rankings"
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "allOf": [
+                                {
+                                    "$ref": "#/definitions/models.Response"
+                                },
+                                {
+                                    "type": "object",
+                                    "properties": {
+                                        "data": {
+                                            "$ref": "#/definitions/models.RankingsResponse"
+                                        }
+                                    }
+                                }
+                            ]
+                        }
+                    },
+                    "400": {
+                        "description": "Bad Request",
+                        "schema": {
+                            "$ref": "#/definitions/models.Response"
+                        }
+                    }
+                }
+            }
+        },
         "/search": {
             "get": {
+                "description": "Get all user and map data matching to the query.",
                 "produces": [
                     "application/json"
                 ],
                 "tags": [
                     "search"
                 ],
-                "summary": "Get all user and map data matching to the query.",
                 "parameters": [
                     {
                         "type": "string",
@@ -821,13 +821,13 @@
         },
         "/token": {
             "get": {
+                "description": "Gets the token cookie value from the user.",
                 "produces": [
                     "application/json"
                 ],
                 "tags": [
                     "auth"
                 ],
-                "summary": "Gets the token cookie value from the user.",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -856,13 +856,13 @@
                 }
             },
             "delete": {
+                "description": "Deletes the token cookie from the user.",
                 "produces": [
                     "application/json"
                 ],
                 "tags": [
                     "auth"
                 ],
-                "summary": "Deletes the token cookie from the user.",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -893,6 +893,7 @@
         },
         "/users/{id}": {
             "get": {
+                "description": "Get profile page of another user.",
                 "consumes": [
                     "application/json"
                 ],
@@ -902,7 +903,6 @@
                 "tags": [
                     "users"
                 ],
-                "summary": "Get profile page of another user.",
                 "parameters": [
                     {
                         "type": "integer",
-- 
cgit v1.2.3