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/docs.go | 228 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- docs/swagger.json | 228 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- docs/swagger.yaml | 138 +++++++++++++++++++++++++++++++-- 3 files changed, 577 insertions(+), 17 deletions(-) (limited to 'docs') diff --git a/docs/docs.go b/docs/docs.go index 22d4362..788ca3d 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -20,6 +20,55 @@ const docTemplate = `{ "host": "{{.Host}}", "basePath": "{{.BasePath}}", "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": [ @@ -94,6 +143,46 @@ const docTemplate = `{ } } }, + "/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": [ @@ -134,11 +223,57 @@ const docTemplate = `{ } } }, - "/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" ], @@ -290,9 +425,6 @@ const docTemplate = `{ }, "/maps/{id}/summary": { "get": { - "consumes": [ - "application/json" - ], "produces": [ "application/json" ], @@ -530,7 +662,19 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/models.Response" + "allOf": [ + { + "$ref": "#/definitions/models.Response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/models.SearchResponse" + } + } + } + ] } }, "400": { @@ -599,6 +743,31 @@ const docTemplate = `{ } }, "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": { @@ -662,6 +831,20 @@ const docTemplate = `{ "records": {} } }, + "models.MapShort": { + "type": "object", + "properties": { + "chapter_id": { + "type": "integer" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + }, "models.MapSummary": { "type": "object", "properties": { @@ -784,6 +967,39 @@ const docTemplate = `{ "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": { 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": { diff --git a/docs/swagger.yaml b/docs/swagger.yaml index f719008..8b66ec8 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -1,5 +1,21 @@ basePath: /v1 definitions: + models.Chapter: + properties: + game_id: + type: integer + id: + type: integer + name: + type: string + type: object + models.Game: + properties: + id: + type: integer + name: + type: string + type: object models.LoginResponse: properties: token: @@ -41,6 +57,15 @@ definitions: properties: records: {} type: object + models.MapShort: + properties: + chapter_id: + type: integer + id: + type: integer + name: + type: string + type: object models.MapSummary: properties: category_scores: @@ -122,6 +147,27 @@ definitions: type: integer records: {} type: object + models.SearchResponse: + properties: + maps: + items: + properties: + id: + type: integer + name: + type: string + type: object + type: array + players: + items: + properties: + steam_id: + type: string + user_name: + type: string + type: object + type: array + type: object models.UserRanking: properties: total_score: @@ -141,6 +187,35 @@ info: title: Least Portals Database API version: "1.0" paths: + /chapters/{id}: + get: + parameters: + - description: Game ID + in: path + name: id + required: true + type: integer + produces: + - application/json + responses: + "200": + description: OK + schema: + allOf: + - $ref: '#/definitions/models.Response' + - properties: + data: + items: + $ref: '#/definitions/models.Chapter' + type: array + type: object + "400": + description: Bad Request + schema: + $ref: '#/definitions/models.Response' + summary: Get chapters from the specified game id. + tags: + - chapters /demo: get: produces: @@ -186,6 +261,29 @@ paths: summary: Get demo with specified demo uuid. tags: - demo + /games: + get: + produces: + - application/json + responses: + "200": + description: OK + schema: + allOf: + - $ref: '#/definitions/models.Response' + - properties: + data: + items: + $ref: '#/definitions/models.Game' + type: array + type: object + "400": + description: Bad Request + schema: + $ref: '#/definitions/models.Response' + summary: Get games from the leaderboards. + tags: + - games /login: get: consumes: @@ -209,10 +307,37 @@ paths: summary: Get (redirect) login page for Steam auth. tags: - login - /maps/{id}/leaderboards: + /maps/{id}: get: - consumes: + parameters: + - description: Chapter ID + in: path + name: id + required: true + type: integer + produces: - application/json + responses: + "200": + description: OK + schema: + allOf: + - $ref: '#/definitions/models.Response' + - properties: + data: + items: + $ref: '#/definitions/models.MapShort' + type: array + type: object + "400": + description: Bad Request + schema: + $ref: '#/definitions/models.Response' + summary: Get maps from the specified chapter id. + tags: + - maps + /maps/{id}/leaderboards: + get: parameters: - description: Map ID in: path @@ -305,8 +430,6 @@ paths: - maps /maps/{id}/summary: get: - consumes: - - application/json parameters: - description: Map ID in: path @@ -447,7 +570,12 @@ paths: "200": description: OK schema: - $ref: '#/definitions/models.Response' + allOf: + - $ref: '#/definitions/models.Response' + - properties: + data: + $ref: '#/definitions/models.SearchResponse' + type: object "400": description: Bad Request schema: -- cgit v1.2.3