From e3435419a67621d4d647e1080662c9b294e7d334 Mon Sep 17 00:00:00 2001 From: itzaname Date: Sun, 22 Jun 2025 21:58:41 -0400 Subject: [PATCH] Fix user rank docs --- docs/docs.go | 15 ++++++++++++++- docs/swagger.json | 15 ++++++++++++++- docs/swagger.yaml | 9 ++++++++- generate.go | 2 +- pkg/api/handlers/user.go | 4 ++-- 5 files changed, 39 insertions(+), 6 deletions(-) diff --git a/docs/docs.go b/docs/docs.go index 54e6013..fb39771 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -472,7 +472,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Response-User" + "$ref": "#/definitions/Response-Rank" } }, "404": { @@ -663,6 +663,19 @@ const docTemplate = `{ } } }, + "Response-Rank": { + "type": "object", + "properties": { + "data": { + "description": "Data contains the actual response payload", + "allOf": [ + { + "$ref": "#/definitions/Rank" + } + ] + } + } + }, "Response-Time": { "type": "object", "properties": { diff --git a/docs/swagger.json b/docs/swagger.json index a8d25fa..470496d 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -465,7 +465,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Response-User" + "$ref": "#/definitions/Response-Rank" } }, "404": { @@ -656,6 +656,19 @@ } } }, + "Response-Rank": { + "type": "object", + "properties": { + "data": { + "description": "Data contains the actual response payload", + "allOf": [ + { + "$ref": "#/definitions/Rank" + } + ] + } + } + }, "Response-Time": { "type": "object", "properties": { diff --git a/docs/swagger.yaml b/docs/swagger.yaml index a3e8596..16dd03d 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -107,6 +107,13 @@ definitions: - $ref: '#/definitions/Map' description: Data contains the actual response payload type: object + Response-Rank: + properties: + data: + allOf: + - $ref: '#/definitions/Rank' + description: Data contains the actual response payload + type: object Response-Time: properties: data: @@ -454,7 +461,7 @@ paths: "200": description: OK schema: - $ref: '#/definitions/Response-User' + $ref: '#/definitions/Response-Rank' "404": description: User not found schema: diff --git a/generate.go b/generate.go index a798627..0436479 100644 --- a/generate.go +++ b/generate.go @@ -1,3 +1,3 @@ package public_api -//go:generate swag init -g ./cmd/public-api/serve.go +//go:generate swag init -g ./cmd/public-api/service.go diff --git a/pkg/api/handlers/user.go b/pkg/api/handlers/user.go index 7fec2c4..451011c 100644 --- a/pkg/api/handlers/user.go +++ b/pkg/api/handlers/user.go @@ -88,7 +88,7 @@ func (h *UserHandler) Get(ctx *gin.Context) { // @Security ApiKeyAuth // @Param id path int true "User ID" // @Param filter query dto.RankFilter false "Rank query parameters" -// @Success 200 {object} dto.Response[dto.User] +// @Success 200 {object} dto.Response[dto.Rank] // @Failure 404 {object} dto.Error "User not found" // @Failure default {object} dto.Error "General error response" // @Router /user/{id}/rank [get] @@ -137,7 +137,7 @@ func (h *UserHandler) GetRank(ctx *gin.Context) { return } - // Convert gRPC UserResponse object to dto.UserData object + // Convert gRPC Rank object to dto.Rank object var rank dto.Rank result := rank.FromGRPC(rankItem)