From 0a2c6021e36be31aaffe8ace232179e2211b3140 Mon Sep 17 00:00:00 2001 From: Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com> Date: Tue, 2 May 2023 23:25:48 +0300 Subject: feat: game, chapter, map endpoints for records page --- docs/swagger.json | 228 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 222 insertions(+), 6 deletions(-) (limited to 'docs/swagger.json') diff --git a/docs/swagger.json b/docs/swagger.json index 0bebe1c..ba0e8a3 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -13,6 +13,55 @@ "host": "lp.ardapektezol.com/api", "basePath": "/v1", "paths": { + "/chapters/{id}": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "chapters" + ], + "summary": "Get chapters from the specified game id.", + "parameters": [ + { + "type": "integer", + "description": "Game ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/models.Response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/models.Chapter" + } + } + } + } + ] + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/models.Response" + } + } + } + } + }, "/demo": { "get": { "produces": [ @@ -87,6 +136,46 @@ } } }, + "/games": { + "get": { + "produces": [ + "application/json" + ], + "tags": [ + "games" + ], + "summary": "Get games from the leaderboards.", + "responses": { + "200": { + "description": "OK", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/models.Response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/models.Game" + } + } + } + } + ] + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/models.Response" + } + } + } + } + }, "/login": { "get": { "consumes": [ @@ -127,11 +216,57 @@ } } }, - "/maps/{id}/leaderboards": { + "/maps/{id}": { "get": { - "consumes": [ + "produces": [ "application/json" ], + "tags": [ + "maps" + ], + "summary": "Get maps from the specified chapter id.", + "parameters": [ + { + "type": "integer", + "description": "Chapter ID", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/models.Response" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/models.MapShort" + } + } + } + } + ] + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/models.Response" + } + } + } + } + }, + "/maps/{id}/leaderboards": { + "get": { "produces": [ "application/json" ], @@ -283,9 +418,6 @@ }, "/maps/{id}/summary": { "get": { - "consumes": [ - "application/json" - ], "produces": [ "application/json" ], @@ -523,7 +655,19 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/models.Response" + "allOf": [ + { + "$ref": "#/definitions/models.Response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/models.SearchResponse" + } + } + } + ] } }, "400": { @@ -592,6 +736,31 @@ } }, "definitions": { + "models.Chapter": { + "type": "object", + "properties": { + "game_id": { + "type": "integer" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + }, + "models.Game": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + }, "models.LoginResponse": { "type": "object", "properties": { @@ -655,6 +824,20 @@ "records": {} } }, + "models.MapShort": { + "type": "object", + "properties": { + "chapter_id": { + "type": "integer" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + }, "models.MapSummary": { "type": "object", "properties": { @@ -777,6 +960,39 @@ "records": {} } }, + "models.SearchResponse": { + "type": "object", + "properties": { + "maps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + } + }, + "players": { + "type": "array", + "items": { + "type": "object", + "properties": { + "steam_id": { + "type": "string" + }, + "user_name": { + "type": "string" + } + } + } + } + } + }, "models.UserRanking": { "type": "object", "properties": { -- cgit v1.2.3