From 3fa9f51360d5856891ede1cdb8be5dd32e2c7ffe Mon Sep 17 00:00:00 2001
From: Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com>
Date: Mon, 18 Sep 2023 12:05:17 +0300
Subject: docs: leaderboard pagination parameters

Former-commit-id: 902316661475df90e1de1365c232a9cabb5760a9
---
 docs/docs.go      | 32 ++++++++++++++++++++++++++++++++
 docs/swagger.json | 32 ++++++++++++++++++++++++++++++++
 docs/swagger.yaml | 21 +++++++++++++++++++++
 3 files changed, 85 insertions(+)

(limited to 'docs')

diff --git a/docs/docs.go b/docs/docs.go
index 4129343..68b2649 100644
--- a/docs/docs.go
+++ b/docs/docs.go
@@ -390,6 +390,18 @@ const docTemplate = `{
                         "name": "id",
                         "in": "path",
                         "required": true
+                    },
+                    {
+                        "type": "integer",
+                        "description": "Page Number (default: 1)",
+                        "name": "page",
+                        "in": "query"
+                    },
+                    {
+                        "type": "integer",
+                        "description": "Number of Records Per Page (default: 20)",
+                        "name": "pageSize",
+                        "in": "query"
                     }
                 ],
                 "responses": {
@@ -1249,6 +1261,9 @@ const docTemplate = `{
                 "map": {
                     "$ref": "#/definitions/models.Map"
                 },
+                "pagination": {
+                    "$ref": "#/definitions/models.Pagination"
+                },
                 "records": {}
             }
         },
@@ -1595,6 +1610,23 @@ const docTemplate = `{
                 }
             }
         },
+        "models.Pagination": {
+            "type": "object",
+            "properties": {
+                "current_page": {
+                    "type": "integer"
+                },
+                "page_size": {
+                    "type": "integer"
+                },
+                "total_pages": {
+                    "type": "integer"
+                },
+                "total_records": {
+                    "type": "integer"
+                }
+            }
+        },
         "models.Response": {
             "type": "object",
             "properties": {
diff --git a/docs/swagger.json b/docs/swagger.json
index 646da0f..2761779 100644
--- a/docs/swagger.json
+++ b/docs/swagger.json
@@ -383,6 +383,18 @@
                         "name": "id",
                         "in": "path",
                         "required": true
+                    },
+                    {
+                        "type": "integer",
+                        "description": "Page Number (default: 1)",
+                        "name": "page",
+                        "in": "query"
+                    },
+                    {
+                        "type": "integer",
+                        "description": "Number of Records Per Page (default: 20)",
+                        "name": "pageSize",
+                        "in": "query"
                     }
                 ],
                 "responses": {
@@ -1242,6 +1254,9 @@
                 "map": {
                     "$ref": "#/definitions/models.Map"
                 },
+                "pagination": {
+                    "$ref": "#/definitions/models.Pagination"
+                },
                 "records": {}
             }
         },
@@ -1588,6 +1603,23 @@
                 }
             }
         },
+        "models.Pagination": {
+            "type": "object",
+            "properties": {
+                "current_page": {
+                    "type": "integer"
+                },
+                "page_size": {
+                    "type": "integer"
+                },
+                "total_pages": {
+                    "type": "integer"
+                },
+                "total_records": {
+                    "type": "integer"
+                }
+            }
+        },
         "models.Response": {
             "type": "object",
             "properties": {
diff --git a/docs/swagger.yaml b/docs/swagger.yaml
index 6b1e6ea..c744146 100644
--- a/docs/swagger.yaml
+++ b/docs/swagger.yaml
@@ -99,6 +99,8 @@ definitions:
     properties:
       map:
         $ref: '#/definitions/models.Map'
+      pagination:
+        $ref: '#/definitions/models.Pagination'
       records: {}
     type: object
   handlers.MapSummaryResponse:
@@ -323,6 +325,17 @@ definitions:
           $ref: '#/definitions/models.MapRoute'
         type: array
     type: object
+  models.Pagination:
+    properties:
+      current_page:
+        type: integer
+      page_size:
+        type: integer
+      total_pages:
+        type: integer
+      total_records:
+        type: integer
+    type: object
   models.Response:
     properties:
       data: {}
@@ -581,6 +594,14 @@ paths:
         name: id
         required: true
         type: integer
+      - description: 'Page Number (default: 1)'
+        in: query
+        name: page
+        type: integer
+      - description: 'Number of Records Per Page (default: 20)'
+        in: query
+        name: pageSize
+        type: integer
       produces:
       - application/json
       responses:
-- 
cgit v1.2.3