From 345fa5d06a47837fca48137163f8a7bdae33cebf Mon Sep 17 00:00:00 2001 From: Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com> Date: Sun, 18 Jun 2023 17:08:27 +0300 Subject: feat: improved map summary response (#43) --- docs/docs.go | 127 +++++++++++++++++++++++------------------------------- docs/swagger.json | 127 +++++++++++++++++++++++------------------------------- docs/swagger.yaml | 82 ++++++++++++++++------------------- 3 files changed, 148 insertions(+), 188 deletions(-) (limited to 'docs') diff --git a/docs/docs.go b/docs/docs.go index 34aa7f4..cf6c00d 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -447,19 +447,7 @@ const docTemplate = `{ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/definitions/models.Map" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/models.MapSummary" - } - } - } - ] + "$ref": "#/definitions/models.MapSummaryResponse" } } } @@ -560,19 +548,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "allOf": [ - { - "$ref": "#/definitions/models.Response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/models.ProfileResponse" - } - } - } - ] + "$ref": "#/definitions/models.Response" } }, "400": { @@ -817,6 +793,17 @@ const docTemplate = `{ } }, "definitions": { + "models.Category": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + }, "models.Chapter": { "type": "object", "properties": { @@ -881,7 +868,6 @@ const docTemplate = `{ "chapter_name": { "type": "string" }, - "data": {}, "game_name": { "type": "string" }, @@ -893,23 +879,6 @@ const docTemplate = `{ } } }, - "models.MapCategoryScores": { - "type": "object", - "properties": { - "any": { - "type": "integer" - }, - "cm": { - "type": "integer" - }, - "inbounds_sla": { - "type": "integer" - }, - "no_sla": { - "type": "integer" - } - } - }, "models.MapHistory": { "type": "object", "properties": { @@ -930,6 +899,23 @@ const docTemplate = `{ "records": {} } }, + "models.MapRoute": { + "type": "object", + "properties": { + "category": { + "$ref": "#/definitions/models.Category" + }, + "description": { + "type": "string" + }, + "score_count": { + "type": "integer" + }, + "showcase": { + "type": "string" + } + } + }, "models.MapShort": { "type": "object", "properties": { @@ -944,12 +930,6 @@ const docTemplate = `{ "models.MapSummary": { "type": "object", "properties": { - "category_scores": { - "$ref": "#/definitions/models.MapCategoryScores" - }, - "description": { - "type": "string" - }, "history": { "type": "array", "items": { @@ -959,14 +939,22 @@ const docTemplate = `{ "rating": { "type": "number" }, - "routers": { + "routes": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/models.MapRoute" } + } + } + }, + "models.MapSummaryResponse": { + "type": "object", + "properties": { + "map": { + "$ref": "#/definitions/models.Map" }, - "showcase": { - "type": "string" + "summary": { + "$ref": "#/definitions/models.MapSummary" } } }, @@ -1069,29 +1057,13 @@ const docTemplate = `{ "maps": { "type": "array", "items": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - } - } + "$ref": "#/definitions/models.MapShort" } }, "players": { "type": "array", "items": { - "type": "object", - "properties": { - "steam_id": { - "type": "string" - }, - "user_name": { - "type": "string" - } - } + "$ref": "#/definitions/models.UserShort" } } } @@ -1109,6 +1081,17 @@ const docTemplate = `{ "type": "string" } } + }, + "models.UserShort": { + "type": "object", + "properties": { + "steam_id": { + "type": "string" + }, + "user_name": { + "type": "string" + } + } } } }` diff --git a/docs/swagger.json b/docs/swagger.json index 8491d2e..f2ed3f0 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -440,19 +440,7 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/definitions/models.Map" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/models.MapSummary" - } - } - } - ] + "$ref": "#/definitions/models.MapSummaryResponse" } } } @@ -553,19 +541,7 @@ "200": { "description": "OK", "schema": { - "allOf": [ - { - "$ref": "#/definitions/models.Response" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/models.ProfileResponse" - } - } - } - ] + "$ref": "#/definitions/models.Response" } }, "400": { @@ -810,6 +786,17 @@ } }, "definitions": { + "models.Category": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + }, "models.Chapter": { "type": "object", "properties": { @@ -874,7 +861,6 @@ "chapter_name": { "type": "string" }, - "data": {}, "game_name": { "type": "string" }, @@ -886,23 +872,6 @@ } } }, - "models.MapCategoryScores": { - "type": "object", - "properties": { - "any": { - "type": "integer" - }, - "cm": { - "type": "integer" - }, - "inbounds_sla": { - "type": "integer" - }, - "no_sla": { - "type": "integer" - } - } - }, "models.MapHistory": { "type": "object", "properties": { @@ -923,6 +892,23 @@ "records": {} } }, + "models.MapRoute": { + "type": "object", + "properties": { + "category": { + "$ref": "#/definitions/models.Category" + }, + "description": { + "type": "string" + }, + "score_count": { + "type": "integer" + }, + "showcase": { + "type": "string" + } + } + }, "models.MapShort": { "type": "object", "properties": { @@ -937,12 +923,6 @@ "models.MapSummary": { "type": "object", "properties": { - "category_scores": { - "$ref": "#/definitions/models.MapCategoryScores" - }, - "description": { - "type": "string" - }, "history": { "type": "array", "items": { @@ -952,14 +932,22 @@ "rating": { "type": "number" }, - "routers": { + "routes": { "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/models.MapRoute" } + } + } + }, + "models.MapSummaryResponse": { + "type": "object", + "properties": { + "map": { + "$ref": "#/definitions/models.Map" }, - "showcase": { - "type": "string" + "summary": { + "$ref": "#/definitions/models.MapSummary" } } }, @@ -1062,29 +1050,13 @@ "maps": { "type": "array", "items": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "name": { - "type": "string" - } - } + "$ref": "#/definitions/models.MapShort" } }, "players": { "type": "array", "items": { - "type": "object", - "properties": { - "steam_id": { - "type": "string" - }, - "user_name": { - "type": "string" - } - } + "$ref": "#/definitions/models.UserShort" } } } @@ -1102,6 +1074,17 @@ "type": "string" } } + }, + "models.UserShort": { + "type": "object", + "properties": { + "steam_id": { + "type": "string" + }, + "user_name": { + "type": "string" + } + } } } } \ No newline at end of file diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 597df9f..61f2ad7 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -1,5 +1,12 @@ basePath: /v1 definitions: + models.Category: + properties: + id: + type: integer + name: + type: string + type: object models.Chapter: properties: id: @@ -41,7 +48,6 @@ definitions: properties: chapter_name: type: string - data: {} game_name: type: string id: @@ -49,17 +55,6 @@ definitions: map_name: type: string type: object - models.MapCategoryScores: - properties: - any: - type: integer - cm: - type: integer - inbounds_sla: - type: integer - no_sla: - type: integer - type: object models.MapHistory: properties: date: @@ -73,6 +68,17 @@ definitions: properties: records: {} type: object + models.MapRoute: + properties: + category: + $ref: '#/definitions/models.Category' + description: + type: string + score_count: + type: integer + showcase: + type: string + type: object models.MapShort: properties: id: @@ -82,22 +88,23 @@ definitions: type: object models.MapSummary: properties: - category_scores: - $ref: '#/definitions/models.MapCategoryScores' - description: - type: string history: items: $ref: '#/definitions/models.MapHistory' type: array rating: type: number - routers: + routes: items: - type: string + $ref: '#/definitions/models.MapRoute' type: array - showcase: - type: string + type: object + models.MapSummaryResponse: + properties: + map: + $ref: '#/definitions/models.Map' + summary: + $ref: '#/definitions/models.MapSummary' type: object models.ProfileResponse: properties: @@ -165,21 +172,11 @@ definitions: properties: maps: items: - properties: - id: - type: integer - name: - type: string - type: object + $ref: '#/definitions/models.MapShort' type: array players: items: - properties: - steam_id: - type: string - user_name: - type: string - type: object + $ref: '#/definitions/models.UserShort' type: array type: object models.UserRanking: @@ -191,6 +188,13 @@ definitions: user_name: type: string type: object + models.UserShort: + properties: + steam_id: + type: string + user_name: + type: string + type: object host: lp.ardapektezol.com/api info: contact: {} @@ -456,12 +460,7 @@ paths: - $ref: '#/definitions/models.Response' - properties: data: - allOf: - - $ref: '#/definitions/models.Map' - - properties: - data: - $ref: '#/definitions/models.MapSummary' - type: object + $ref: '#/definitions/models.MapSummaryResponse' type: object "400": description: Bad Request @@ -555,12 +554,7 @@ paths: "200": description: OK schema: - allOf: - - $ref: '#/definitions/models.Response' - - properties: - data: - $ref: '#/definitions/models.ProfileResponse' - type: object + $ref: '#/definitions/models.Response' "400": description: Bad Request schema: -- cgit v1.2.3