From ca7acc2fdc6e6c8371ca5bbeeaabb02d11bb1bee Mon Sep 17 00:00:00 2001 From: Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com> Date: Sun, 20 Aug 2023 12:51:26 +0300 Subject: refactor: move structs around for better understanding Former-commit-id: 0030a6b0c7b228772d8e27f5722ee6de1718786b --- docs/docs.go | 300 +++++++++++++++++++++++++++++------------------------------ 1 file changed, 150 insertions(+), 150 deletions(-) (limited to 'docs/docs.go') diff --git a/docs/docs.go b/docs/docs.go index 423afad..df01379 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -50,7 +50,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/models.ChapterMapsResponse" + "$ref": "#/definitions/controllers.ChapterMapsResponse" } } } @@ -173,7 +173,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/models.ChaptersResponse" + "$ref": "#/definitions/controllers.ChaptersResponse" } } } @@ -213,7 +213,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/models.LoginResponse" + "$ref": "#/definitions/controllers.LoginResponse" } } } @@ -259,7 +259,7 @@ const docTemplate = `{ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/models.EditMapImageRequest" + "$ref": "#/definitions/controllers.EditMapImageRequest" } } ], @@ -275,7 +275,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/models.EditMapImageRequest" + "$ref": "#/definitions/controllers.EditMapImageRequest" } } } @@ -414,7 +414,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/models.RecordResponse" + "$ref": "#/definitions/controllers.RecordResponse" } } } @@ -466,7 +466,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/models.MapSummaryResponse" + "$ref": "#/definitions/controllers.MapSummaryResponse" } } } @@ -510,7 +510,7 @@ const docTemplate = `{ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/models.EditMapSummaryRequest" + "$ref": "#/definitions/controllers.EditMapSummaryRequest" } } ], @@ -526,7 +526,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/models.EditMapSummaryRequest" + "$ref": "#/definitions/controllers.EditMapSummaryRequest" } } } @@ -570,7 +570,7 @@ const docTemplate = `{ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/models.CreateMapSummaryRequest" + "$ref": "#/definitions/controllers.CreateMapSummaryRequest" } } ], @@ -586,7 +586,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/models.CreateMapSummaryRequest" + "$ref": "#/definitions/controllers.CreateMapSummaryRequest" } } } @@ -630,7 +630,7 @@ const docTemplate = `{ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/models.DeleteMapSummaryRequest" + "$ref": "#/definitions/controllers.DeleteMapSummaryRequest" } } ], @@ -646,7 +646,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/models.DeleteMapSummaryRequest" + "$ref": "#/definitions/controllers.DeleteMapSummaryRequest" } } } @@ -695,7 +695,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/models.ProfileResponse" + "$ref": "#/definitions/controllers.ProfileResponse" } } } @@ -796,7 +796,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/models.ProfileResponse" + "$ref": "#/definitions/controllers.ProfileResponse" } } } @@ -839,7 +839,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/models.RankingsResponse" + "$ref": "#/definitions/controllers.RankingsResponse" } } } @@ -884,7 +884,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/models.SearchResponse" + "$ref": "#/definitions/controllers.SearchResponse" } } } @@ -921,7 +921,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/models.LoginResponse" + "$ref": "#/definitions/controllers.LoginResponse" } } } @@ -956,7 +956,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/models.LoginResponse" + "$ref": "#/definitions/controllers.LoginResponse" } } } @@ -1005,7 +1005,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/models.ProfileResponse" + "$ref": "#/definitions/controllers.ProfileResponse" } } } @@ -1029,29 +1029,7 @@ const docTemplate = `{ } }, "definitions": { - "models.Category": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - } - } - }, - "models.Chapter": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - } - } - }, - "models.ChapterMapsResponse": { + "controllers.ChapterMapsResponse": { "type": "object", "properties": { "chapter": { @@ -1065,7 +1043,7 @@ const docTemplate = `{ } } }, - "models.ChaptersResponse": { + "controllers.ChaptersResponse": { "type": "object", "properties": { "chapters": { @@ -1079,7 +1057,7 @@ const docTemplate = `{ } } }, - "models.CreateMapSummaryRequest": { + "controllers.CreateMapSummaryRequest": { "type": "object", "required": [ "category_id", @@ -1109,7 +1087,7 @@ const docTemplate = `{ } } }, - "models.DeleteMapSummaryRequest": { + "controllers.DeleteMapSummaryRequest": { "type": "object", "required": [ "route_id" @@ -1120,7 +1098,7 @@ const docTemplate = `{ } } }, - "models.EditMapImageRequest": { + "controllers.EditMapImageRequest": { "type": "object", "required": [ "image" @@ -1131,7 +1109,7 @@ const docTemplate = `{ } } }, - "models.EditMapSummaryRequest": { + "controllers.EditMapSummaryRequest": { "type": "object", "required": [ "description", @@ -1161,24 +1139,143 @@ const docTemplate = `{ } } }, - "models.Game": { + "controllers.LoginResponse": { + "type": "object", + "properties": { + "token": { + "type": "string" + } + } + }, + "controllers.MapSummaryResponse": { + "type": "object", + "properties": { + "map": { + "$ref": "#/definitions/models.Map" + }, + "summary": { + "$ref": "#/definitions/models.MapSummary" + } + } + }, + "controllers.ProfileResponse": { + "type": "object", + "properties": { + "avatar_link": { + "type": "string" + }, + "country_code": { + "type": "string" + }, + "profile": { + "type": "boolean" + }, + "scores_mp": { + "type": "array", + "items": { + "$ref": "#/definitions/controllers.ScoreResponse" + } + }, + "scores_sp": { + "type": "array", + "items": { + "$ref": "#/definitions/controllers.ScoreResponse" + } + }, + "steam_id": { + "type": "string" + }, + "user_name": { + "type": "string" + } + } + }, + "controllers.RankingsResponse": { + "type": "object", + "properties": { + "rankings_mp": { + "type": "array", + "items": { + "$ref": "#/definitions/models.UserRanking" + } + }, + "rankings_sp": { + "type": "array", + "items": { + "$ref": "#/definitions/models.UserRanking" + } + } + } + }, + "controllers.RecordResponse": { + "type": "object", + "properties": { + "score_count": { + "type": "integer" + }, + "score_time": { + "type": "integer" + } + } + }, + "controllers.ScoreResponse": { + "type": "object", + "properties": { + "map_id": { + "type": "integer" + }, + "records": {} + } + }, + "controllers.SearchResponse": { + "type": "object", + "properties": { + "maps": { + "type": "array", + "items": { + "$ref": "#/definitions/models.MapShort" + } + }, + "players": { + "type": "array", + "items": { + "$ref": "#/definitions/models.UserShort" + } + } + } + }, + "models.Category": { "type": "object", "properties": { "id": { "type": "integer" }, - "is_coop": { - "type": "boolean" + "name": { + "type": "string" + } + } + }, + "models.Chapter": { + "type": "object", + "properties": { + "id": { + "type": "integer" }, "name": { "type": "string" } } }, - "models.LoginResponse": { + "models.Game": { "type": "object", "properties": { - "token": { + "id": { + "type": "integer" + }, + "is_coop": { + "type": "boolean" + }, + "name": { "type": "string" } } @@ -1271,77 +1368,6 @@ const docTemplate = `{ } } }, - "models.MapSummaryResponse": { - "type": "object", - "properties": { - "map": { - "$ref": "#/definitions/models.Map" - }, - "summary": { - "$ref": "#/definitions/models.MapSummary" - } - } - }, - "models.ProfileResponse": { - "type": "object", - "properties": { - "avatar_link": { - "type": "string" - }, - "country_code": { - "type": "string" - }, - "profile": { - "type": "boolean" - }, - "scores_mp": { - "type": "array", - "items": { - "$ref": "#/definitions/models.ScoreResponse" - } - }, - "scores_sp": { - "type": "array", - "items": { - "$ref": "#/definitions/models.ScoreResponse" - } - }, - "steam_id": { - "type": "string" - }, - "user_name": { - "type": "string" - } - } - }, - "models.RankingsResponse": { - "type": "object", - "properties": { - "rankings_mp": { - "type": "array", - "items": { - "$ref": "#/definitions/models.UserRanking" - } - }, - "rankings_sp": { - "type": "array", - "items": { - "$ref": "#/definitions/models.UserRanking" - } - } - } - }, - "models.RecordResponse": { - "type": "object", - "properties": { - "score_count": { - "type": "integer" - }, - "score_time": { - "type": "integer" - } - } - }, "models.Response": { "type": "object", "properties": { @@ -1354,32 +1380,6 @@ const docTemplate = `{ } } }, - "models.ScoreResponse": { - "type": "object", - "properties": { - "map_id": { - "type": "integer" - }, - "records": {} - } - }, - "models.SearchResponse": { - "type": "object", - "properties": { - "maps": { - "type": "array", - "items": { - "$ref": "#/definitions/models.MapShort" - } - }, - "players": { - "type": "array", - "items": { - "$ref": "#/definitions/models.UserShort" - } - } - } - }, "models.UserRanking": { "type": "object", "properties": { -- cgit v1.2.3 From ba09abbe6a8d0c1f3a54c8c7426eda7b930e1447 Mon Sep 17 00:00:00 2001 From: Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com> Date: Fri, 25 Aug 2023 23:41:13 +0300 Subject: docs: profile improvement swagger (#51) Former-commit-id: ff35be478c4f29c611c40fa34ca5d134e970cc16 --- docs/docs.go | 137 +++++++++++++++++++++++++++++++++++++++++++++++------- docs/swagger.json | 137 +++++++++++++++++++++++++++++++++++++++++++++++------- docs/swagger.yaml | 93 ++++++++++++++++++++++++++++++------ main.go | 4 +- 4 files changed, 319 insertions(+), 52 deletions(-) (limited to 'docs/docs.go') diff --git a/docs/docs.go b/docs/docs.go index df01379..d0c78ac 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -1158,6 +1158,68 @@ const docTemplate = `{ } } }, + "controllers.ProfileRankings": { + "type": "object", + "properties": { + "cooperative": { + "$ref": "#/definitions/controllers.ProfileRankingsDetails" + }, + "overall": { + "$ref": "#/definitions/controllers.ProfileRankingsDetails" + }, + "singleplayer": { + "$ref": "#/definitions/controllers.ProfileRankingsDetails" + } + } + }, + "controllers.ProfileRankingsDetails": { + "type": "object", + "properties": { + "completion_count": { + "type": "integer" + }, + "completion_total": { + "type": "integer" + }, + "rank": { + "type": "integer" + } + } + }, + "controllers.ProfileRecords": { + "type": "object", + "properties": { + "portal2_cooperative": { + "type": "array", + "items": { + "$ref": "#/definitions/controllers.ProfileRecordsDetails" + } + }, + "portal2_singleplayer": { + "type": "array", + "items": { + "$ref": "#/definitions/controllers.ProfileRecordsDetails" + } + } + } + }, + "controllers.ProfileRecordsDetails": { + "type": "object", + "properties": { + "map_id": { + "type": "integer" + }, + "map_name": { + "type": "string" + }, + "scores": { + "type": "array", + "items": { + "$ref": "#/definitions/controllers.ProfileScores" + } + } + } + }, "controllers.ProfileResponse": { "type": "object", "properties": { @@ -1167,26 +1229,46 @@ const docTemplate = `{ "country_code": { "type": "string" }, + "links": { + "$ref": "#/definitions/models.Links" + }, "profile": { "type": "boolean" }, - "scores_mp": { - "type": "array", - "items": { - "$ref": "#/definitions/controllers.ScoreResponse" - } + "rankings": { + "$ref": "#/definitions/controllers.ProfileRankings" + }, + "records": { + "$ref": "#/definitions/controllers.ProfileRecords" }, - "scores_sp": { + "steam_id": { + "type": "string" + }, + "titles": { "type": "array", "items": { - "$ref": "#/definitions/controllers.ScoreResponse" + "$ref": "#/definitions/models.Title" } }, - "steam_id": { + "user_name": { + "type": "string" + } + } + }, + "controllers.ProfileScores": { + "type": "object", + "properties": { + "date": { "type": "string" }, - "user_name": { + "demo_id": { "type": "string" + }, + "score_count": { + "type": "integer" + }, + "score_time": { + "type": "integer" } } }, @@ -1218,15 +1300,6 @@ const docTemplate = `{ } } }, - "controllers.ScoreResponse": { - "type": "object", - "properties": { - "map_id": { - "type": "integer" - }, - "records": {} - } - }, "controllers.SearchResponse": { "type": "object", "properties": { @@ -1280,6 +1353,23 @@ const docTemplate = `{ } } }, + "models.Links": { + "type": "object", + "properties": { + "p2sr": { + "type": "string" + }, + "stream": { + "type": "string" + }, + "twitch": { + "type": "string" + }, + "youtube": { + "type": "string" + } + } + }, "models.Map": { "type": "object", "properties": { @@ -1380,6 +1470,17 @@ const docTemplate = `{ } } }, + "models.Title": { + "type": "object", + "properties": { + "color": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, "models.UserRanking": { "type": "object", "properties": { diff --git a/docs/swagger.json b/docs/swagger.json index 0f3dade..cf37a5a 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -1151,6 +1151,68 @@ } } }, + "controllers.ProfileRankings": { + "type": "object", + "properties": { + "cooperative": { + "$ref": "#/definitions/controllers.ProfileRankingsDetails" + }, + "overall": { + "$ref": "#/definitions/controllers.ProfileRankingsDetails" + }, + "singleplayer": { + "$ref": "#/definitions/controllers.ProfileRankingsDetails" + } + } + }, + "controllers.ProfileRankingsDetails": { + "type": "object", + "properties": { + "completion_count": { + "type": "integer" + }, + "completion_total": { + "type": "integer" + }, + "rank": { + "type": "integer" + } + } + }, + "controllers.ProfileRecords": { + "type": "object", + "properties": { + "portal2_cooperative": { + "type": "array", + "items": { + "$ref": "#/definitions/controllers.ProfileRecordsDetails" + } + }, + "portal2_singleplayer": { + "type": "array", + "items": { + "$ref": "#/definitions/controllers.ProfileRecordsDetails" + } + } + } + }, + "controllers.ProfileRecordsDetails": { + "type": "object", + "properties": { + "map_id": { + "type": "integer" + }, + "map_name": { + "type": "string" + }, + "scores": { + "type": "array", + "items": { + "$ref": "#/definitions/controllers.ProfileScores" + } + } + } + }, "controllers.ProfileResponse": { "type": "object", "properties": { @@ -1160,26 +1222,46 @@ "country_code": { "type": "string" }, + "links": { + "$ref": "#/definitions/models.Links" + }, "profile": { "type": "boolean" }, - "scores_mp": { - "type": "array", - "items": { - "$ref": "#/definitions/controllers.ScoreResponse" - } + "rankings": { + "$ref": "#/definitions/controllers.ProfileRankings" + }, + "records": { + "$ref": "#/definitions/controllers.ProfileRecords" }, - "scores_sp": { + "steam_id": { + "type": "string" + }, + "titles": { "type": "array", "items": { - "$ref": "#/definitions/controllers.ScoreResponse" + "$ref": "#/definitions/models.Title" } }, - "steam_id": { + "user_name": { + "type": "string" + } + } + }, + "controllers.ProfileScores": { + "type": "object", + "properties": { + "date": { "type": "string" }, - "user_name": { + "demo_id": { "type": "string" + }, + "score_count": { + "type": "integer" + }, + "score_time": { + "type": "integer" } } }, @@ -1211,15 +1293,6 @@ } } }, - "controllers.ScoreResponse": { - "type": "object", - "properties": { - "map_id": { - "type": "integer" - }, - "records": {} - } - }, "controllers.SearchResponse": { "type": "object", "properties": { @@ -1273,6 +1346,23 @@ } } }, + "models.Links": { + "type": "object", + "properties": { + "p2sr": { + "type": "string" + }, + "stream": { + "type": "string" + }, + "twitch": { + "type": "string" + }, + "youtube": { + "type": "string" + } + } + }, "models.Map": { "type": "object", "properties": { @@ -1373,6 +1463,17 @@ } } }, + "models.Title": { + "type": "object", + "properties": { + "color": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, "models.UserRanking": { "type": "object", "properties": { diff --git a/docs/swagger.yaml b/docs/swagger.yaml index f50fecb..0dd514d 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -86,27 +86,80 @@ definitions: summary: $ref: '#/definitions/models.MapSummary' type: object + controllers.ProfileRankings: + properties: + cooperative: + $ref: '#/definitions/controllers.ProfileRankingsDetails' + overall: + $ref: '#/definitions/controllers.ProfileRankingsDetails' + singleplayer: + $ref: '#/definitions/controllers.ProfileRankingsDetails' + type: object + controllers.ProfileRankingsDetails: + properties: + completion_count: + type: integer + completion_total: + type: integer + rank: + type: integer + type: object + controllers.ProfileRecords: + properties: + portal2_cooperative: + items: + $ref: '#/definitions/controllers.ProfileRecordsDetails' + type: array + portal2_singleplayer: + items: + $ref: '#/definitions/controllers.ProfileRecordsDetails' + type: array + type: object + controllers.ProfileRecordsDetails: + properties: + map_id: + type: integer + map_name: + type: string + scores: + items: + $ref: '#/definitions/controllers.ProfileScores' + type: array + type: object controllers.ProfileResponse: properties: avatar_link: type: string country_code: type: string + links: + $ref: '#/definitions/models.Links' profile: type: boolean - scores_mp: - items: - $ref: '#/definitions/controllers.ScoreResponse' - type: array - scores_sp: - items: - $ref: '#/definitions/controllers.ScoreResponse' - type: array + rankings: + $ref: '#/definitions/controllers.ProfileRankings' + records: + $ref: '#/definitions/controllers.ProfileRecords' steam_id: type: string + titles: + items: + $ref: '#/definitions/models.Title' + type: array user_name: type: string type: object + controllers.ProfileScores: + properties: + date: + type: string + demo_id: + type: string + score_count: + type: integer + score_time: + type: integer + type: object controllers.RankingsResponse: properties: rankings_mp: @@ -125,12 +178,6 @@ definitions: score_time: type: integer type: object - controllers.ScoreResponse: - properties: - map_id: - type: integer - records: {} - type: object controllers.SearchResponse: properties: maps: @@ -165,6 +212,17 @@ definitions: name: type: string type: object + models.Links: + properties: + p2sr: + type: string + stream: + type: string + twitch: + type: string + youtube: + type: string + type: object models.Map: properties: chapter_name: @@ -230,6 +288,13 @@ definitions: success: type: boolean type: object + models.Title: + properties: + color: + type: string + name: + type: string + type: object models.UserRanking: properties: total_score: diff --git a/main.go b/main.go index 9b531fe..69f7c86 100644 --- a/main.go +++ b/main.go @@ -19,8 +19,8 @@ import ( // @license.name GNU General Public License, Version 2 // @license.url https://www.gnu.org/licenses/old-licenses/gpl-2.0.html -// @host lp.ardapektezol.com/api -// @BasePath /v1 +// @host lp.ardapektezol.com/api +// @BasePath /v1 func main() { if os.Getenv("ENV") == "PROD" { gin.SetMode(gin.ReleaseMode) -- cgit v1.2.3 From c709ff5c9f275ff096153c3405b820baa5175231 Mon Sep 17 00:00:00 2001 From: Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com> Date: Wed, 30 Aug 2023 16:33:25 +0300 Subject: docs: map leaderboards response Former-commit-id: a2c27052fbdacaa0e329270e1dd961602623d5d1 --- docs/docs.go | 119 +++++++++++++++++++++++++----------------------------- docs/swagger.json | 119 +++++++++++++++++++++++++----------------------------- docs/swagger.yaml | 107 ++++++++++++++++++++++++------------------------ 3 files changed, 162 insertions(+), 183 deletions(-) (limited to 'docs/docs.go') diff --git a/docs/docs.go b/docs/docs.go index d0c78ac..6357150 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -50,7 +50,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.ChapterMapsResponse" + "$ref": "#/definitions/handlers.ChapterMapsResponse" } } } @@ -173,7 +173,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.ChaptersResponse" + "$ref": "#/definitions/handlers.ChaptersResponse" } } } @@ -213,7 +213,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.LoginResponse" + "$ref": "#/definitions/handlers.LoginResponse" } } } @@ -259,7 +259,7 @@ const docTemplate = `{ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/controllers.EditMapImageRequest" + "$ref": "#/definitions/handlers.EditMapImageRequest" } } ], @@ -275,7 +275,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.EditMapImageRequest" + "$ref": "#/definitions/handlers.EditMapImageRequest" } } } @@ -321,19 +321,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/definitions/models.Map" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/models.MapRecords" - } - } - } - ] + "$ref": "#/definitions/handlers.MapLeaderboardsResponse" } } } @@ -414,7 +402,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.RecordResponse" + "$ref": "#/definitions/handlers.RecordResponse" } } } @@ -466,7 +454,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.MapSummaryResponse" + "$ref": "#/definitions/handlers.MapSummaryResponse" } } } @@ -510,7 +498,7 @@ const docTemplate = `{ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/controllers.EditMapSummaryRequest" + "$ref": "#/definitions/handlers.EditMapSummaryRequest" } } ], @@ -526,7 +514,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.EditMapSummaryRequest" + "$ref": "#/definitions/handlers.EditMapSummaryRequest" } } } @@ -570,7 +558,7 @@ const docTemplate = `{ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/controllers.CreateMapSummaryRequest" + "$ref": "#/definitions/handlers.CreateMapSummaryRequest" } } ], @@ -586,7 +574,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.CreateMapSummaryRequest" + "$ref": "#/definitions/handlers.CreateMapSummaryRequest" } } } @@ -630,7 +618,7 @@ const docTemplate = `{ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/controllers.DeleteMapSummaryRequest" + "$ref": "#/definitions/handlers.DeleteMapSummaryRequest" } } ], @@ -646,7 +634,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.DeleteMapSummaryRequest" + "$ref": "#/definitions/handlers.DeleteMapSummaryRequest" } } } @@ -695,7 +683,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.ProfileResponse" + "$ref": "#/definitions/handlers.ProfileResponse" } } } @@ -796,7 +784,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.ProfileResponse" + "$ref": "#/definitions/handlers.ProfileResponse" } } } @@ -839,7 +827,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.RankingsResponse" + "$ref": "#/definitions/handlers.RankingsResponse" } } } @@ -884,7 +872,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.SearchResponse" + "$ref": "#/definitions/handlers.SearchResponse" } } } @@ -921,7 +909,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.LoginResponse" + "$ref": "#/definitions/handlers.LoginResponse" } } } @@ -956,7 +944,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.LoginResponse" + "$ref": "#/definitions/handlers.LoginResponse" } } } @@ -1005,7 +993,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.ProfileResponse" + "$ref": "#/definitions/handlers.ProfileResponse" } } } @@ -1029,7 +1017,7 @@ const docTemplate = `{ } }, "definitions": { - "controllers.ChapterMapsResponse": { + "handlers.ChapterMapsResponse": { "type": "object", "properties": { "chapter": { @@ -1043,7 +1031,7 @@ const docTemplate = `{ } } }, - "controllers.ChaptersResponse": { + "handlers.ChaptersResponse": { "type": "object", "properties": { "chapters": { @@ -1057,7 +1045,7 @@ const docTemplate = `{ } } }, - "controllers.CreateMapSummaryRequest": { + "handlers.CreateMapSummaryRequest": { "type": "object", "required": [ "category_id", @@ -1087,7 +1075,7 @@ const docTemplate = `{ } } }, - "controllers.DeleteMapSummaryRequest": { + "handlers.DeleteMapSummaryRequest": { "type": "object", "required": [ "route_id" @@ -1098,7 +1086,7 @@ const docTemplate = `{ } } }, - "controllers.EditMapImageRequest": { + "handlers.EditMapImageRequest": { "type": "object", "required": [ "image" @@ -1109,7 +1097,7 @@ const docTemplate = `{ } } }, - "controllers.EditMapSummaryRequest": { + "handlers.EditMapSummaryRequest": { "type": "object", "required": [ "description", @@ -1139,7 +1127,7 @@ const docTemplate = `{ } } }, - "controllers.LoginResponse": { + "handlers.LoginResponse": { "type": "object", "properties": { "token": { @@ -1147,7 +1135,16 @@ const docTemplate = `{ } } }, - "controllers.MapSummaryResponse": { + "handlers.MapLeaderboardsResponse": { + "type": "object", + "properties": { + "map": { + "$ref": "#/definitions/models.Map" + }, + "records": {} + } + }, + "handlers.MapSummaryResponse": { "type": "object", "properties": { "map": { @@ -1158,21 +1155,21 @@ const docTemplate = `{ } } }, - "controllers.ProfileRankings": { + "handlers.ProfileRankings": { "type": "object", "properties": { "cooperative": { - "$ref": "#/definitions/controllers.ProfileRankingsDetails" + "$ref": "#/definitions/handlers.ProfileRankingsDetails" }, "overall": { - "$ref": "#/definitions/controllers.ProfileRankingsDetails" + "$ref": "#/definitions/handlers.ProfileRankingsDetails" }, "singleplayer": { - "$ref": "#/definitions/controllers.ProfileRankingsDetails" + "$ref": "#/definitions/handlers.ProfileRankingsDetails" } } }, - "controllers.ProfileRankingsDetails": { + "handlers.ProfileRankingsDetails": { "type": "object", "properties": { "completion_count": { @@ -1186,24 +1183,24 @@ const docTemplate = `{ } } }, - "controllers.ProfileRecords": { + "handlers.ProfileRecords": { "type": "object", "properties": { "portal2_cooperative": { "type": "array", "items": { - "$ref": "#/definitions/controllers.ProfileRecordsDetails" + "$ref": "#/definitions/handlers.ProfileRecordsDetails" } }, "portal2_singleplayer": { "type": "array", "items": { - "$ref": "#/definitions/controllers.ProfileRecordsDetails" + "$ref": "#/definitions/handlers.ProfileRecordsDetails" } } } }, - "controllers.ProfileRecordsDetails": { + "handlers.ProfileRecordsDetails": { "type": "object", "properties": { "map_id": { @@ -1215,12 +1212,12 @@ const docTemplate = `{ "scores": { "type": "array", "items": { - "$ref": "#/definitions/controllers.ProfileScores" + "$ref": "#/definitions/handlers.ProfileScores" } } } }, - "controllers.ProfileResponse": { + "handlers.ProfileResponse": { "type": "object", "properties": { "avatar_link": { @@ -1236,10 +1233,10 @@ const docTemplate = `{ "type": "boolean" }, "rankings": { - "$ref": "#/definitions/controllers.ProfileRankings" + "$ref": "#/definitions/handlers.ProfileRankings" }, "records": { - "$ref": "#/definitions/controllers.ProfileRecords" + "$ref": "#/definitions/handlers.ProfileRecords" }, "steam_id": { "type": "string" @@ -1255,7 +1252,7 @@ const docTemplate = `{ } } }, - "controllers.ProfileScores": { + "handlers.ProfileScores": { "type": "object", "properties": { "date": { @@ -1272,7 +1269,7 @@ const docTemplate = `{ } } }, - "controllers.RankingsResponse": { + "handlers.RankingsResponse": { "type": "object", "properties": { "rankings_mp": { @@ -1289,7 +1286,7 @@ const docTemplate = `{ } } }, - "controllers.RecordResponse": { + "handlers.RecordResponse": { "type": "object", "properties": { "score_count": { @@ -1300,7 +1297,7 @@ const docTemplate = `{ } } }, - "controllers.SearchResponse": { + "handlers.SearchResponse": { "type": "object", "properties": { "maps": { @@ -1407,12 +1404,6 @@ const docTemplate = `{ } } }, - "models.MapRecords": { - "type": "object", - "properties": { - "records": {} - } - }, "models.MapRoute": { "type": "object", "properties": { diff --git a/docs/swagger.json b/docs/swagger.json index cf37a5a..22e30d2 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -43,7 +43,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.ChapterMapsResponse" + "$ref": "#/definitions/handlers.ChapterMapsResponse" } } } @@ -166,7 +166,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.ChaptersResponse" + "$ref": "#/definitions/handlers.ChaptersResponse" } } } @@ -206,7 +206,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.LoginResponse" + "$ref": "#/definitions/handlers.LoginResponse" } } } @@ -252,7 +252,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/controllers.EditMapImageRequest" + "$ref": "#/definitions/handlers.EditMapImageRequest" } } ], @@ -268,7 +268,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.EditMapImageRequest" + "$ref": "#/definitions/handlers.EditMapImageRequest" } } } @@ -314,19 +314,7 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/definitions/models.Map" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/models.MapRecords" - } - } - } - ] + "$ref": "#/definitions/handlers.MapLeaderboardsResponse" } } } @@ -407,7 +395,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.RecordResponse" + "$ref": "#/definitions/handlers.RecordResponse" } } } @@ -459,7 +447,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.MapSummaryResponse" + "$ref": "#/definitions/handlers.MapSummaryResponse" } } } @@ -503,7 +491,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/controllers.EditMapSummaryRequest" + "$ref": "#/definitions/handlers.EditMapSummaryRequest" } } ], @@ -519,7 +507,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.EditMapSummaryRequest" + "$ref": "#/definitions/handlers.EditMapSummaryRequest" } } } @@ -563,7 +551,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/controllers.CreateMapSummaryRequest" + "$ref": "#/definitions/handlers.CreateMapSummaryRequest" } } ], @@ -579,7 +567,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.CreateMapSummaryRequest" + "$ref": "#/definitions/handlers.CreateMapSummaryRequest" } } } @@ -623,7 +611,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/controllers.DeleteMapSummaryRequest" + "$ref": "#/definitions/handlers.DeleteMapSummaryRequest" } } ], @@ -639,7 +627,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.DeleteMapSummaryRequest" + "$ref": "#/definitions/handlers.DeleteMapSummaryRequest" } } } @@ -688,7 +676,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.ProfileResponse" + "$ref": "#/definitions/handlers.ProfileResponse" } } } @@ -789,7 +777,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.ProfileResponse" + "$ref": "#/definitions/handlers.ProfileResponse" } } } @@ -832,7 +820,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.RankingsResponse" + "$ref": "#/definitions/handlers.RankingsResponse" } } } @@ -877,7 +865,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.SearchResponse" + "$ref": "#/definitions/handlers.SearchResponse" } } } @@ -914,7 +902,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.LoginResponse" + "$ref": "#/definitions/handlers.LoginResponse" } } } @@ -949,7 +937,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.LoginResponse" + "$ref": "#/definitions/handlers.LoginResponse" } } } @@ -998,7 +986,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/controllers.ProfileResponse" + "$ref": "#/definitions/handlers.ProfileResponse" } } } @@ -1022,7 +1010,7 @@ } }, "definitions": { - "controllers.ChapterMapsResponse": { + "handlers.ChapterMapsResponse": { "type": "object", "properties": { "chapter": { @@ -1036,7 +1024,7 @@ } } }, - "controllers.ChaptersResponse": { + "handlers.ChaptersResponse": { "type": "object", "properties": { "chapters": { @@ -1050,7 +1038,7 @@ } } }, - "controllers.CreateMapSummaryRequest": { + "handlers.CreateMapSummaryRequest": { "type": "object", "required": [ "category_id", @@ -1080,7 +1068,7 @@ } } }, - "controllers.DeleteMapSummaryRequest": { + "handlers.DeleteMapSummaryRequest": { "type": "object", "required": [ "route_id" @@ -1091,7 +1079,7 @@ } } }, - "controllers.EditMapImageRequest": { + "handlers.EditMapImageRequest": { "type": "object", "required": [ "image" @@ -1102,7 +1090,7 @@ } } }, - "controllers.EditMapSummaryRequest": { + "handlers.EditMapSummaryRequest": { "type": "object", "required": [ "description", @@ -1132,7 +1120,7 @@ } } }, - "controllers.LoginResponse": { + "handlers.LoginResponse": { "type": "object", "properties": { "token": { @@ -1140,7 +1128,16 @@ } } }, - "controllers.MapSummaryResponse": { + "handlers.MapLeaderboardsResponse": { + "type": "object", + "properties": { + "map": { + "$ref": "#/definitions/models.Map" + }, + "records": {} + } + }, + "handlers.MapSummaryResponse": { "type": "object", "properties": { "map": { @@ -1151,21 +1148,21 @@ } } }, - "controllers.ProfileRankings": { + "handlers.ProfileRankings": { "type": "object", "properties": { "cooperative": { - "$ref": "#/definitions/controllers.ProfileRankingsDetails" + "$ref": "#/definitions/handlers.ProfileRankingsDetails" }, "overall": { - "$ref": "#/definitions/controllers.ProfileRankingsDetails" + "$ref": "#/definitions/handlers.ProfileRankingsDetails" }, "singleplayer": { - "$ref": "#/definitions/controllers.ProfileRankingsDetails" + "$ref": "#/definitions/handlers.ProfileRankingsDetails" } } }, - "controllers.ProfileRankingsDetails": { + "handlers.ProfileRankingsDetails": { "type": "object", "properties": { "completion_count": { @@ -1179,24 +1176,24 @@ } } }, - "controllers.ProfileRecords": { + "handlers.ProfileRecords": { "type": "object", "properties": { "portal2_cooperative": { "type": "array", "items": { - "$ref": "#/definitions/controllers.ProfileRecordsDetails" + "$ref": "#/definitions/handlers.ProfileRecordsDetails" } }, "portal2_singleplayer": { "type": "array", "items": { - "$ref": "#/definitions/controllers.ProfileRecordsDetails" + "$ref": "#/definitions/handlers.ProfileRecordsDetails" } } } }, - "controllers.ProfileRecordsDetails": { + "handlers.ProfileRecordsDetails": { "type": "object", "properties": { "map_id": { @@ -1208,12 +1205,12 @@ "scores": { "type": "array", "items": { - "$ref": "#/definitions/controllers.ProfileScores" + "$ref": "#/definitions/handlers.ProfileScores" } } } }, - "controllers.ProfileResponse": { + "handlers.ProfileResponse": { "type": "object", "properties": { "avatar_link": { @@ -1229,10 +1226,10 @@ "type": "boolean" }, "rankings": { - "$ref": "#/definitions/controllers.ProfileRankings" + "$ref": "#/definitions/handlers.ProfileRankings" }, "records": { - "$ref": "#/definitions/controllers.ProfileRecords" + "$ref": "#/definitions/handlers.ProfileRecords" }, "steam_id": { "type": "string" @@ -1248,7 +1245,7 @@ } } }, - "controllers.ProfileScores": { + "handlers.ProfileScores": { "type": "object", "properties": { "date": { @@ -1265,7 +1262,7 @@ } } }, - "controllers.RankingsResponse": { + "handlers.RankingsResponse": { "type": "object", "properties": { "rankings_mp": { @@ -1282,7 +1279,7 @@ } } }, - "controllers.RecordResponse": { + "handlers.RecordResponse": { "type": "object", "properties": { "score_count": { @@ -1293,7 +1290,7 @@ } } }, - "controllers.SearchResponse": { + "handlers.SearchResponse": { "type": "object", "properties": { "maps": { @@ -1400,12 +1397,6 @@ } } }, - "models.MapRecords": { - "type": "object", - "properties": { - "records": {} - } - }, "models.MapRoute": { "type": "object", "properties": { diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 0dd514d..462679e 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -1,6 +1,6 @@ basePath: /v1 definitions: - controllers.ChapterMapsResponse: + handlers.ChapterMapsResponse: properties: chapter: $ref: '#/definitions/models.Chapter' @@ -9,7 +9,7 @@ definitions: $ref: '#/definitions/models.MapShort' type: array type: object - controllers.ChaptersResponse: + handlers.ChaptersResponse: properties: chapters: items: @@ -18,7 +18,7 @@ definitions: game: $ref: '#/definitions/models.Game' type: object - controllers.CreateMapSummaryRequest: + handlers.CreateMapSummaryRequest: properties: category_id: type: integer @@ -39,21 +39,21 @@ definitions: - score_count - user_name type: object - controllers.DeleteMapSummaryRequest: + handlers.DeleteMapSummaryRequest: properties: route_id: type: integer required: - route_id type: object - controllers.EditMapImageRequest: + handlers.EditMapImageRequest: properties: image: type: string required: - image type: object - controllers.EditMapSummaryRequest: + handlers.EditMapSummaryRequest: properties: description: type: string @@ -74,28 +74,34 @@ definitions: - score_count - user_name type: object - controllers.LoginResponse: + handlers.LoginResponse: properties: token: type: string type: object - controllers.MapSummaryResponse: + handlers.MapLeaderboardsResponse: + properties: + map: + $ref: '#/definitions/models.Map' + records: {} + type: object + handlers.MapSummaryResponse: properties: map: $ref: '#/definitions/models.Map' summary: $ref: '#/definitions/models.MapSummary' type: object - controllers.ProfileRankings: + handlers.ProfileRankings: properties: cooperative: - $ref: '#/definitions/controllers.ProfileRankingsDetails' + $ref: '#/definitions/handlers.ProfileRankingsDetails' overall: - $ref: '#/definitions/controllers.ProfileRankingsDetails' + $ref: '#/definitions/handlers.ProfileRankingsDetails' singleplayer: - $ref: '#/definitions/controllers.ProfileRankingsDetails' + $ref: '#/definitions/handlers.ProfileRankingsDetails' type: object - controllers.ProfileRankingsDetails: + handlers.ProfileRankingsDetails: properties: completion_count: type: integer @@ -104,18 +110,18 @@ definitions: rank: type: integer type: object - controllers.ProfileRecords: + handlers.ProfileRecords: properties: portal2_cooperative: items: - $ref: '#/definitions/controllers.ProfileRecordsDetails' + $ref: '#/definitions/handlers.ProfileRecordsDetails' type: array portal2_singleplayer: items: - $ref: '#/definitions/controllers.ProfileRecordsDetails' + $ref: '#/definitions/handlers.ProfileRecordsDetails' type: array type: object - controllers.ProfileRecordsDetails: + handlers.ProfileRecordsDetails: properties: map_id: type: integer @@ -123,10 +129,10 @@ definitions: type: string scores: items: - $ref: '#/definitions/controllers.ProfileScores' + $ref: '#/definitions/handlers.ProfileScores' type: array type: object - controllers.ProfileResponse: + handlers.ProfileResponse: properties: avatar_link: type: string @@ -137,9 +143,9 @@ definitions: profile: type: boolean rankings: - $ref: '#/definitions/controllers.ProfileRankings' + $ref: '#/definitions/handlers.ProfileRankings' records: - $ref: '#/definitions/controllers.ProfileRecords' + $ref: '#/definitions/handlers.ProfileRecords' steam_id: type: string titles: @@ -149,7 +155,7 @@ definitions: user_name: type: string type: object - controllers.ProfileScores: + handlers.ProfileScores: properties: date: type: string @@ -160,7 +166,7 @@ definitions: score_time: type: integer type: object - controllers.RankingsResponse: + handlers.RankingsResponse: properties: rankings_mp: items: @@ -171,14 +177,14 @@ definitions: $ref: '#/definitions/models.UserRanking' type: array type: object - controllers.RecordResponse: + handlers.RecordResponse: properties: score_count: type: integer score_time: type: integer type: object - controllers.SearchResponse: + handlers.SearchResponse: properties: maps: items: @@ -247,10 +253,6 @@ definitions: score_count: type: integer type: object - models.MapRecords: - properties: - records: {} - type: object models.MapRoute: properties: category: @@ -340,7 +342,7 @@ paths: - $ref: '#/definitions/models.Response' - properties: data: - $ref: '#/definitions/controllers.ChapterMapsResponse' + $ref: '#/definitions/handlers.ChapterMapsResponse' type: object "400": description: Bad Request @@ -414,7 +416,7 @@ paths: - $ref: '#/definitions/models.Response' - properties: data: - $ref: '#/definitions/controllers.ChaptersResponse' + $ref: '#/definitions/handlers.ChaptersResponse' type: object "400": description: Bad Request @@ -437,7 +439,7 @@ paths: - $ref: '#/definitions/models.Response' - properties: data: - $ref: '#/definitions/controllers.LoginResponse' + $ref: '#/definitions/handlers.LoginResponse' type: object "400": description: Bad Request @@ -464,7 +466,7 @@ paths: name: request required: true schema: - $ref: '#/definitions/controllers.EditMapImageRequest' + $ref: '#/definitions/handlers.EditMapImageRequest' produces: - application/json responses: @@ -475,7 +477,7 @@ paths: - $ref: '#/definitions/models.Response' - properties: data: - $ref: '#/definitions/controllers.EditMapImageRequest' + $ref: '#/definitions/handlers.EditMapImageRequest' type: object "400": description: Bad Request @@ -502,12 +504,7 @@ paths: - $ref: '#/definitions/models.Response' - properties: data: - allOf: - - $ref: '#/definitions/models.Map' - - properties: - data: - $ref: '#/definitions/models.MapRecords' - type: object + $ref: '#/definitions/handlers.MapLeaderboardsResponse' type: object "400": description: Bad Request @@ -558,7 +555,7 @@ paths: - $ref: '#/definitions/models.Response' - properties: data: - $ref: '#/definitions/controllers.RecordResponse' + $ref: '#/definitions/handlers.RecordResponse' type: object "400": description: Bad Request @@ -589,7 +586,7 @@ paths: name: request required: true schema: - $ref: '#/definitions/controllers.DeleteMapSummaryRequest' + $ref: '#/definitions/handlers.DeleteMapSummaryRequest' produces: - application/json responses: @@ -600,7 +597,7 @@ paths: - $ref: '#/definitions/models.Response' - properties: data: - $ref: '#/definitions/controllers.DeleteMapSummaryRequest' + $ref: '#/definitions/handlers.DeleteMapSummaryRequest' type: object "400": description: Bad Request @@ -626,7 +623,7 @@ paths: - $ref: '#/definitions/models.Response' - properties: data: - $ref: '#/definitions/controllers.MapSummaryResponse' + $ref: '#/definitions/handlers.MapSummaryResponse' type: object "400": description: Bad Request @@ -652,7 +649,7 @@ paths: name: request required: true schema: - $ref: '#/definitions/controllers.CreateMapSummaryRequest' + $ref: '#/definitions/handlers.CreateMapSummaryRequest' produces: - application/json responses: @@ -663,7 +660,7 @@ paths: - $ref: '#/definitions/models.Response' - properties: data: - $ref: '#/definitions/controllers.CreateMapSummaryRequest' + $ref: '#/definitions/handlers.CreateMapSummaryRequest' type: object "400": description: Bad Request @@ -689,7 +686,7 @@ paths: name: request required: true schema: - $ref: '#/definitions/controllers.EditMapSummaryRequest' + $ref: '#/definitions/handlers.EditMapSummaryRequest' produces: - application/json responses: @@ -700,7 +697,7 @@ paths: - $ref: '#/definitions/models.Response' - properties: data: - $ref: '#/definitions/controllers.EditMapSummaryRequest' + $ref: '#/definitions/handlers.EditMapSummaryRequest' type: object "400": description: Bad Request @@ -729,7 +726,7 @@ paths: - $ref: '#/definitions/models.Response' - properties: data: - $ref: '#/definitions/controllers.ProfileResponse' + $ref: '#/definitions/handlers.ProfileResponse' type: object "400": description: Bad Request @@ -761,7 +758,7 @@ paths: - $ref: '#/definitions/models.Response' - properties: data: - $ref: '#/definitions/controllers.ProfileResponse' + $ref: '#/definitions/handlers.ProfileResponse' type: object "400": description: Bad Request @@ -818,7 +815,7 @@ paths: - $ref: '#/definitions/models.Response' - properties: data: - $ref: '#/definitions/controllers.RankingsResponse' + $ref: '#/definitions/handlers.RankingsResponse' type: object "400": description: Bad Request @@ -844,7 +841,7 @@ paths: - $ref: '#/definitions/models.Response' - properties: data: - $ref: '#/definitions/controllers.SearchResponse' + $ref: '#/definitions/handlers.SearchResponse' type: object "400": description: Bad Request @@ -865,7 +862,7 @@ paths: - $ref: '#/definitions/models.Response' - properties: data: - $ref: '#/definitions/controllers.LoginResponse' + $ref: '#/definitions/handlers.LoginResponse' type: object "404": description: Not Found @@ -885,7 +882,7 @@ paths: - $ref: '#/definitions/models.Response' - properties: data: - $ref: '#/definitions/controllers.LoginResponse' + $ref: '#/definitions/handlers.LoginResponse' type: object "404": description: Not Found @@ -914,7 +911,7 @@ paths: - $ref: '#/definitions/models.Response' - properties: data: - $ref: '#/definitions/controllers.ProfileResponse' + $ref: '#/definitions/handlers.ProfileResponse' type: object "400": description: Bad Request -- cgit v1.2.3 From 1e41c244446b81f3fdb7ebb3028cd68eaa919982 Mon Sep 17 00:00:00 2001 From: Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com> Date: Wed, 30 Aug 2023 19:14:46 +0300 Subject: docs: finalized profile scores in one array (#51) Former-commit-id: 93b44c71389b5ff98d9a610611be21fd12c88664 --- docs/docs.go | 29 ++++++++++++----------------- docs/swagger.json | 29 ++++++++++++----------------- docs/swagger.yaml | 21 +++++++++------------ 3 files changed, 33 insertions(+), 46 deletions(-) (limited to 'docs/docs.go') diff --git a/docs/docs.go b/docs/docs.go index 6357150..72a1434 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -1186,29 +1186,21 @@ const docTemplate = `{ "handlers.ProfileRecords": { "type": "object", "properties": { - "portal2_cooperative": { - "type": "array", - "items": { - "$ref": "#/definitions/handlers.ProfileRecordsDetails" - } + "category_id": { + "type": "integer" + }, + "game_id": { + "type": "integer" }, - "portal2_singleplayer": { - "type": "array", - "items": { - "$ref": "#/definitions/handlers.ProfileRecordsDetails" - } - } - } - }, - "handlers.ProfileRecordsDetails": { - "type": "object", - "properties": { "map_id": { "type": "integer" }, "map_name": { "type": "string" }, + "map_wr_count": { + "type": "integer" + }, "scores": { "type": "array", "items": { @@ -1236,7 +1228,10 @@ const docTemplate = `{ "$ref": "#/definitions/handlers.ProfileRankings" }, "records": { - "$ref": "#/definitions/handlers.ProfileRecords" + "type": "array", + "items": { + "$ref": "#/definitions/handlers.ProfileRecords" + } }, "steam_id": { "type": "string" diff --git a/docs/swagger.json b/docs/swagger.json index 22e30d2..6fbe02e 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -1179,29 +1179,21 @@ "handlers.ProfileRecords": { "type": "object", "properties": { - "portal2_cooperative": { - "type": "array", - "items": { - "$ref": "#/definitions/handlers.ProfileRecordsDetails" - } + "category_id": { + "type": "integer" + }, + "game_id": { + "type": "integer" }, - "portal2_singleplayer": { - "type": "array", - "items": { - "$ref": "#/definitions/handlers.ProfileRecordsDetails" - } - } - } - }, - "handlers.ProfileRecordsDetails": { - "type": "object", - "properties": { "map_id": { "type": "integer" }, "map_name": { "type": "string" }, + "map_wr_count": { + "type": "integer" + }, "scores": { "type": "array", "items": { @@ -1229,7 +1221,10 @@ "$ref": "#/definitions/handlers.ProfileRankings" }, "records": { - "$ref": "#/definitions/handlers.ProfileRecords" + "type": "array", + "items": { + "$ref": "#/definitions/handlers.ProfileRecords" + } }, "steam_id": { "type": "string" diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 462679e..4b59ee9 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -112,21 +112,16 @@ definitions: type: object handlers.ProfileRecords: properties: - portal2_cooperative: - items: - $ref: '#/definitions/handlers.ProfileRecordsDetails' - type: array - portal2_singleplayer: - items: - $ref: '#/definitions/handlers.ProfileRecordsDetails' - type: array - type: object - handlers.ProfileRecordsDetails: - properties: + category_id: + type: integer + game_id: + type: integer map_id: type: integer map_name: type: string + map_wr_count: + type: integer scores: items: $ref: '#/definitions/handlers.ProfileScores' @@ -145,7 +140,9 @@ definitions: rankings: $ref: '#/definitions/handlers.ProfileRankings' records: - $ref: '#/definitions/handlers.ProfileRecords' + items: + $ref: '#/definitions/handlers.ProfileRecords' + type: array steam_id: type: string titles: -- cgit v1.2.3 From 60fcf785ced334998e8dd19aea3b71be6a2db14f Mon Sep 17 00:00:00 2001 From: Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com> Date: Sat, 2 Sep 2023 13:52:45 +0300 Subject: docs: update docs for logs (#55) Former-commit-id: 0478aa459bfe9a7c81073d4ff8d8264aa1258bc1 --- backend/handlers/logs.go | 17 +++++++ docs/docs.go | 130 ++++++++++++++++++++++++++++++++++++++++++++++- docs/swagger.json | 130 ++++++++++++++++++++++++++++++++++++++++++++++- docs/swagger.yaml | 80 ++++++++++++++++++++++++++++- 4 files changed, 351 insertions(+), 6 deletions(-) (limited to 'docs/docs.go') diff --git a/backend/handlers/logs.go b/backend/handlers/logs.go index 0ebba47..5233738 100644 --- a/backend/handlers/logs.go +++ b/backend/handlers/logs.go @@ -49,6 +49,15 @@ type ScoreLogsResponseDetails struct { Date time.Time `json:"date"` } +// GET Mod Logs +// +// @Description Get mod logs. +// @Tags rankings +// @Produce json +// @Param Authorization header string true "JWT Token" +// @Success 200 {object} models.Response{data=ScoreLogsResponse} +// @Failure 400 {object} models.Response +// @Router /logs/mod [get] func ModLogs(c *gin.Context) { mod, exists := c.Get("mod") if !exists || !mod.(bool) { @@ -86,6 +95,14 @@ func ModLogs(c *gin.Context) { }) } +// GET Score Logs +// +// @Description Get score logs of every player. +// @Tags rankings +// @Produce json +// @Success 200 {object} models.Response{data=ScoreLogsResponse} +// @Failure 400 {object} models.Response +// @Router /logs/score [get] func ScoreLogs(c *gin.Context) { response := ScoreLogsResponse{Logs: []ScoreLogsResponseDetails{}} sql := `SELECT g.id, diff --git a/docs/docs.go b/docs/docs.go index 72a1434..3d140cc 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -229,6 +229,89 @@ const docTemplate = `{ } } }, + "/logs/mod": { + "get": { + "description": "Get mod logs.", + "produces": [ + "application/json" + ], + "tags": [ + "rankings" + ], + "parameters": [ + { + "type": "string", + "description": "JWT Token", + "name": "Authorization", + "in": "header", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/models.Response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/handlers.ScoreLogsResponse" + } + } + } + ] + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/models.Response" + } + } + } + } + }, + "/logs/score": { + "get": { + "description": "Get score logs of every player.", + "produces": [ + "application/json" + ], + "tags": [ + "rankings" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/models.Response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/handlers.ScoreLogsResponse" + } + } + } + ] + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/models.Response" + } + } + } + } + }, "/maps/{id}/image": { "put": { "description": "Edit map image with specified map id.", @@ -1267,13 +1350,19 @@ const docTemplate = `{ "handlers.RankingsResponse": { "type": "object", "properties": { - "rankings_mp": { + "rankings_multiplayer": { + "type": "array", + "items": { + "$ref": "#/definitions/models.UserRanking" + } + }, + "rankings_overall": { "type": "array", "items": { "$ref": "#/definitions/models.UserRanking" } }, - "rankings_sp": { + "rankings_singleplayer": { "type": "array", "items": { "$ref": "#/definitions/models.UserRanking" @@ -1292,6 +1381,43 @@ const docTemplate = `{ } } }, + "handlers.ScoreLogsResponse": { + "type": "object", + "properties": { + "scores": { + "type": "array", + "items": { + "$ref": "#/definitions/handlers.ScoreLogsResponseDetails" + } + } + } + }, + "handlers.ScoreLogsResponseDetails": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "demo_id": { + "type": "string" + }, + "game": { + "$ref": "#/definitions/models.Game" + }, + "map": { + "$ref": "#/definitions/models.MapShort" + }, + "score_count": { + "type": "integer" + }, + "score_time": { + "type": "integer" + }, + "user": { + "$ref": "#/definitions/models.UserShort" + } + } + }, "handlers.SearchResponse": { "type": "object", "properties": { diff --git a/docs/swagger.json b/docs/swagger.json index 6fbe02e..f55190e 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -222,6 +222,89 @@ } } }, + "/logs/mod": { + "get": { + "description": "Get mod logs.", + "produces": [ + "application/json" + ], + "tags": [ + "rankings" + ], + "parameters": [ + { + "type": "string", + "description": "JWT Token", + "name": "Authorization", + "in": "header", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/models.Response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/handlers.ScoreLogsResponse" + } + } + } + ] + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/models.Response" + } + } + } + } + }, + "/logs/score": { + "get": { + "description": "Get score logs of every player.", + "produces": [ + "application/json" + ], + "tags": [ + "rankings" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/models.Response" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/handlers.ScoreLogsResponse" + } + } + } + ] + } + }, + "400": { + "description": "Bad Request", + "schema": { + "$ref": "#/definitions/models.Response" + } + } + } + } + }, "/maps/{id}/image": { "put": { "description": "Edit map image with specified map id.", @@ -1260,13 +1343,19 @@ "handlers.RankingsResponse": { "type": "object", "properties": { - "rankings_mp": { + "rankings_multiplayer": { + "type": "array", + "items": { + "$ref": "#/definitions/models.UserRanking" + } + }, + "rankings_overall": { "type": "array", "items": { "$ref": "#/definitions/models.UserRanking" } }, - "rankings_sp": { + "rankings_singleplayer": { "type": "array", "items": { "$ref": "#/definitions/models.UserRanking" @@ -1285,6 +1374,43 @@ } } }, + "handlers.ScoreLogsResponse": { + "type": "object", + "properties": { + "scores": { + "type": "array", + "items": { + "$ref": "#/definitions/handlers.ScoreLogsResponseDetails" + } + } + } + }, + "handlers.ScoreLogsResponseDetails": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "demo_id": { + "type": "string" + }, + "game": { + "$ref": "#/definitions/models.Game" + }, + "map": { + "$ref": "#/definitions/models.MapShort" + }, + "score_count": { + "type": "integer" + }, + "score_time": { + "type": "integer" + }, + "user": { + "$ref": "#/definitions/models.UserShort" + } + } + }, "handlers.SearchResponse": { "type": "object", "properties": { diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 4b59ee9..4d5661e 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -165,11 +165,15 @@ definitions: type: object handlers.RankingsResponse: properties: - rankings_mp: + rankings_multiplayer: items: $ref: '#/definitions/models.UserRanking' type: array - rankings_sp: + rankings_overall: + items: + $ref: '#/definitions/models.UserRanking' + type: array + rankings_singleplayer: items: $ref: '#/definitions/models.UserRanking' type: array @@ -181,6 +185,30 @@ definitions: score_time: type: integer type: object + handlers.ScoreLogsResponse: + properties: + scores: + items: + $ref: '#/definitions/handlers.ScoreLogsResponseDetails' + type: array + type: object + handlers.ScoreLogsResponseDetails: + properties: + date: + type: string + demo_id: + type: string + game: + $ref: '#/definitions/models.Game' + map: + $ref: '#/definitions/models.MapShort' + score_count: + type: integer + score_time: + type: integer + user: + $ref: '#/definitions/models.UserShort' + type: object handlers.SearchResponse: properties: maps: @@ -444,6 +472,54 @@ paths: $ref: '#/definitions/models.Response' tags: - login + /logs/mod: + get: + description: Get mod logs. + parameters: + - description: JWT Token + in: header + name: Authorization + required: true + type: string + produces: + - application/json + responses: + "200": + description: OK + schema: + allOf: + - $ref: '#/definitions/models.Response' + - properties: + data: + $ref: '#/definitions/handlers.ScoreLogsResponse' + type: object + "400": + description: Bad Request + schema: + $ref: '#/definitions/models.Response' + tags: + - rankings + /logs/score: + get: + description: Get score logs of every player. + produces: + - application/json + responses: + "200": + description: OK + schema: + allOf: + - $ref: '#/definitions/models.Response' + - properties: + data: + $ref: '#/definitions/handlers.ScoreLogsResponse' + type: object + "400": + description: Bad Request + schema: + $ref: '#/definitions/models.Response' + tags: + - rankings /maps/{id}/image: put: description: Edit map image with specified map id. -- cgit v1.2.3 From 0f493cef0fd6442bddeb3f7fa1f9ca4bd3c47917 Mon Sep 17 00:00:00 2001 From: Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com> Date: Sat, 2 Sep 2023 13:54:11 +0300 Subject: docs: change tags for logs (#55) Former-commit-id: c3f9968ecb1a8734bbc87ad4fe28073b14b9920c --- backend/handlers/logs.go | 4 ++-- docs/docs.go | 4 ++-- docs/swagger.json | 4 ++-- docs/swagger.yaml | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) (limited to 'docs/docs.go') diff --git a/backend/handlers/logs.go b/backend/handlers/logs.go index 5233738..882632d 100644 --- a/backend/handlers/logs.go +++ b/backend/handlers/logs.go @@ -52,7 +52,7 @@ type ScoreLogsResponseDetails struct { // GET Mod Logs // // @Description Get mod logs. -// @Tags rankings +// @Tags logs // @Produce json // @Param Authorization header string true "JWT Token" // @Success 200 {object} models.Response{data=ScoreLogsResponse} @@ -98,7 +98,7 @@ func ModLogs(c *gin.Context) { // GET Score Logs // // @Description Get score logs of every player. -// @Tags rankings +// @Tags logs // @Produce json // @Success 200 {object} models.Response{data=ScoreLogsResponse} // @Failure 400 {object} models.Response diff --git a/docs/docs.go b/docs/docs.go index 3d140cc..0523288 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -236,7 +236,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "rankings" + "logs" ], "parameters": [ { @@ -282,7 +282,7 @@ const docTemplate = `{ "application/json" ], "tags": [ - "rankings" + "logs" ], "responses": { "200": { diff --git a/docs/swagger.json b/docs/swagger.json index f55190e..6837d8a 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -229,7 +229,7 @@ "application/json" ], "tags": [ - "rankings" + "logs" ], "parameters": [ { @@ -275,7 +275,7 @@ "application/json" ], "tags": [ - "rankings" + "logs" ], "responses": { "200": { diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 4d5661e..48e84b2 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -498,7 +498,7 @@ paths: schema: $ref: '#/definitions/models.Response' tags: - - rankings + - logs /logs/score: get: description: Get score logs of every player. @@ -519,7 +519,7 @@ paths: schema: $ref: '#/definitions/models.Response' tags: - - rankings + - logs /maps/{id}/image: put: description: Edit map image with specified map id. -- cgit v1.2.3 From 323311123f35cbe6dc0924ae7bb4109b4ba55e9c Mon Sep 17 00:00:00 2001 From: Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com> Date: Sat, 2 Sep 2023 22:02:32 +0300 Subject: docs: update swagger for changed models Former-commit-id: 45b281132d5d5cf05297230ac9b17f2790a4c75f --- docs/docs.go | 7 ++----- docs/swagger.json | 7 ++----- docs/swagger.yaml | 6 ++---- 3 files changed, 6 insertions(+), 14 deletions(-) (limited to 'docs/docs.go') diff --git a/docs/docs.go b/docs/docs.go index 0523288..60a39bf 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -1599,11 +1599,8 @@ const docTemplate = `{ "total_score": { "type": "integer" }, - "user_id": { - "type": "string" - }, - "user_name": { - "type": "string" + "user": { + "$ref": "#/definitions/models.UserShort" } } }, diff --git a/docs/swagger.json b/docs/swagger.json index 6837d8a..bba8488 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -1592,11 +1592,8 @@ "total_score": { "type": "integer" }, - "user_id": { - "type": "string" - }, - "user_name": { - "type": "string" + "user": { + "$ref": "#/definitions/models.UserShort" } } }, diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 48e84b2..166f960 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -326,10 +326,8 @@ definitions: properties: total_score: type: integer - user_id: - type: string - user_name: - type: string + user: + $ref: '#/definitions/models.UserShort' type: object models.UserShort: properties: -- cgit v1.2.3 From e84def27c803fc8982bdd21077a43967ab6031df Mon Sep 17 00:00:00 2001 From: Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com> Date: Sun, 3 Sep 2023 13:31:45 +0300 Subject: docs: update log response type Former-commit-id: 8e2be25b6ce30d3f42b388b7c67ee14e230cce80 --- docs/docs.go | 27 ++++++++++++++++++++++++++- docs/swagger.json | 27 ++++++++++++++++++++++++++- docs/swagger.yaml | 18 +++++++++++++++++- 3 files changed, 69 insertions(+), 3 deletions(-) (limited to 'docs/docs.go') diff --git a/docs/docs.go b/docs/docs.go index 60a39bf..4129343 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -259,7 +259,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "$ref": "#/definitions/handlers.ScoreLogsResponse" + "$ref": "#/definitions/handlers.LogsResponse" } } } @@ -1218,6 +1218,31 @@ const docTemplate = `{ } } }, + "handlers.LogsResponse": { + "type": "object", + "properties": { + "logs": { + "type": "array", + "items": { + "$ref": "#/definitions/handlers.LogsResponseDetails" + } + } + } + }, + "handlers.LogsResponseDetails": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "detail": { + "type": "string" + }, + "user": { + "$ref": "#/definitions/models.UserShort" + } + } + }, "handlers.MapLeaderboardsResponse": { "type": "object", "properties": { diff --git a/docs/swagger.json b/docs/swagger.json index bba8488..646da0f 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -252,7 +252,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/definitions/handlers.ScoreLogsResponse" + "$ref": "#/definitions/handlers.LogsResponse" } } } @@ -1211,6 +1211,31 @@ } } }, + "handlers.LogsResponse": { + "type": "object", + "properties": { + "logs": { + "type": "array", + "items": { + "$ref": "#/definitions/handlers.LogsResponseDetails" + } + } + } + }, + "handlers.LogsResponseDetails": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "detail": { + "type": "string" + }, + "user": { + "$ref": "#/definitions/models.UserShort" + } + } + }, "handlers.MapLeaderboardsResponse": { "type": "object", "properties": { diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 166f960..6b1e6ea 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -79,6 +79,22 @@ definitions: token: type: string type: object + handlers.LogsResponse: + properties: + logs: + items: + $ref: '#/definitions/handlers.LogsResponseDetails' + type: array + type: object + handlers.LogsResponseDetails: + properties: + date: + type: string + detail: + type: string + user: + $ref: '#/definitions/models.UserShort' + type: object handlers.MapLeaderboardsResponse: properties: map: @@ -489,7 +505,7 @@ paths: - $ref: '#/definitions/models.Response' - properties: data: - $ref: '#/definitions/handlers.ScoreLogsResponse' + $ref: '#/definitions/handlers.LogsResponse' type: object "400": description: Bad Request -- cgit v1.2.3