diff options
| author | Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com> | 2023-09-18 12:05:17 +0300 |
|---|---|---|
| committer | Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com> | 2023-09-18 12:05:17 +0300 |
| commit | 3fa9f51360d5856891ede1cdb8be5dd32e2c7ffe (patch) | |
| tree | d85a5f3d6ab0dbfe46d3ac945b2340daec1ae309 /docs/swagger.yaml | |
| parent | fix: change default page size to 20 (diff) | |
| download | lphub-3fa9f51360d5856891ede1cdb8be5dd32e2c7ffe.tar.gz lphub-3fa9f51360d5856891ede1cdb8be5dd32e2c7ffe.tar.bz2 lphub-3fa9f51360d5856891ede1cdb8be5dd32e2c7ffe.zip | |
docs: leaderboard pagination parameters
Former-commit-id: 902316661475df90e1de1365c232a9cabb5760a9
Diffstat (limited to 'docs/swagger.yaml')
| -rw-r--r-- | docs/swagger.yaml | 21 |
1 files changed, 21 insertions, 0 deletions
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: | |||
| 99 | properties: | 99 | properties: |
| 100 | map: | 100 | map: |
| 101 | $ref: '#/definitions/models.Map' | 101 | $ref: '#/definitions/models.Map' |
| 102 | pagination: | ||
| 103 | $ref: '#/definitions/models.Pagination' | ||
| 102 | records: {} | 104 | records: {} |
| 103 | type: object | 105 | type: object |
| 104 | handlers.MapSummaryResponse: | 106 | handlers.MapSummaryResponse: |
| @@ -323,6 +325,17 @@ definitions: | |||
| 323 | $ref: '#/definitions/models.MapRoute' | 325 | $ref: '#/definitions/models.MapRoute' |
| 324 | type: array | 326 | type: array |
| 325 | type: object | 327 | type: object |
| 328 | models.Pagination: | ||
| 329 | properties: | ||
| 330 | current_page: | ||
| 331 | type: integer | ||
| 332 | page_size: | ||
| 333 | type: integer | ||
| 334 | total_pages: | ||
| 335 | type: integer | ||
| 336 | total_records: | ||
| 337 | type: integer | ||
| 338 | type: object | ||
| 326 | models.Response: | 339 | models.Response: |
| 327 | properties: | 340 | properties: |
| 328 | data: {} | 341 | data: {} |
| @@ -581,6 +594,14 @@ paths: | |||
| 581 | name: id | 594 | name: id |
| 582 | required: true | 595 | required: true |
| 583 | type: integer | 596 | type: integer |
| 597 | - description: 'Page Number (default: 1)' | ||
| 598 | in: query | ||
| 599 | name: page | ||
| 600 | type: integer | ||
| 601 | - description: 'Number of Records Per Page (default: 20)' | ||
| 602 | in: query | ||
| 603 | name: pageSize | ||
| 604 | type: integer | ||
| 584 | produces: | 605 | produces: |
| 585 | - application/json | 606 | - application/json |
| 586 | responses: | 607 | responses: |