From 8c90837a671a61cc50ce66efc6f32e524eb1fced Mon Sep 17 00:00:00 2001 From: Asai Neko Date: Sat, 31 Jan 2026 08:49:52 +0800 Subject: [PATCH] Fix swagget docs Signed-off-by: Asai Neko --- api/event/checkin.go | 1 + api/event/info.go | 1 + api/event/list.go | 1 + api/user/info.go | 2 +- api/user/list.go | 1 + api/user/other.go | 4 +- api/user/update.go | 2 +- docs/docs.go | 98 ++++++++++++++++++++++++++++++++++++++++++-- docs/swagger.json | 98 ++++++++++++++++++++++++++++++++++++++++++-- docs/swagger.yaml | 53 ++++++++++++++++++++++-- 10 files changed, 245 insertions(+), 16 deletions(-) diff --git a/api/event/checkin.go b/api/event/checkin.go index e98ab6a..30a52c8 100644 --- a/api/event/checkin.go +++ b/api/event/checkin.go @@ -18,6 +18,7 @@ import ( // @Produce json // @Param event_id query string true "Event UUID" // @Success 200 {object} utils.RespStatus{data=service_event.CheckinResponse} "Successfully generated code" +// @Failure 401 {object} utils.RespStatus{data=nil} "Missing User ID / Unauthorized" // @Failure 400 {object} utils.RespStatus{data=nil} "Invalid Input" // @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error" // @Security ApiKeyAuth diff --git a/api/event/info.go b/api/event/info.go index fcdcbd7..e7c5586 100644 --- a/api/event/info.go +++ b/api/event/info.go @@ -19,6 +19,7 @@ import ( // @Param event_id query string true "Event UUID" // @Success 200 {object} utils.RespStatus{data=data.EventIndexDoc} "Successful retrieval" // @Failure 400 {object} utils.RespStatus{data=nil} "Invalid Input" +// @Failure 401 {object} utils.RespStatus{data=nil} "Missing User ID / Unauthorized" // @Failure 404 {object} utils.RespStatus{data=nil} "Event Not Found" // @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error" // @Security ApiKeyAuth diff --git a/api/event/list.go b/api/event/list.go index fa92c9f..bf9fdcd 100644 --- a/api/event/list.go +++ b/api/event/list.go @@ -19,6 +19,7 @@ import ( // @Param offset query string true "Number of events to skip" // @Success 200 {object} utils.RespStatus{data=[]data.EventIndexDoc} "Successful paginated list retrieval" // @Failure 400 {object} utils.RespStatus{data=nil} "Invalid Input (Missing offset or malformed parameters)" +// @Failure 401 {object} utils.RespStatus{data=nil} "Missing User ID / Unauthorized" // @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error (Database query failed)" // @Security ApiKeyAuth // @Router /event/list [get] diff --git a/api/user/info.go b/api/user/info.go index 0cf1c23..d05e051 100644 --- a/api/user/info.go +++ b/api/user/info.go @@ -17,7 +17,7 @@ import ( // @Accept json // @Produce json // @Success 200 {object} utils.RespStatus{data=service_user.UserInfoData} "Successful profile retrieval" -// @Failure 403 {object} utils.RespStatus{data=nil} "Missing User ID / Unauthorized" +// @Failure 401 {object} utils.RespStatus{data=nil} "Missing User ID / Unauthorized" // @Failure 404 {object} utils.RespStatus{data=nil} "User Not Found" // @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error (UUID Parse Failed)" // @Security ApiKeyAuth diff --git a/api/user/list.go b/api/user/list.go index b6b9679..f2475dd 100644 --- a/api/user/list.go +++ b/api/user/list.go @@ -18,6 +18,7 @@ import ( // @Param limit query string false "Maximum number of users to return (default 0)" // @Param offset query string true "Number of users to skip" // @Success 200 {object} utils.RespStatus{data=[]data.UserIndexDoc} "Successful paginated list retrieval" +// @Failure 401 {object} utils.RespStatus{data=nil} "Missing User ID / Unauthorized" // @Failure 400 {object} utils.RespStatus{data=nil} "Invalid Input (Format Error)" // @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error (Search Engine or Missing Offset)" // @Security ApiKeyAuth diff --git a/api/user/other.go b/api/user/other.go index cf39964..310e46b 100644 --- a/api/user/other.go +++ b/api/user/other.go @@ -18,9 +18,9 @@ import ( // @Produce json // @Param user_id path string true "Other user id" // @Success 200 {object} utils.RespStatus{data=service_user.UserInfoData} "Successful profile retrieval" -// @Failure 403 {object} utils.RespStatus{data=nil} "Missing User ID / Unauthorized" +// @Failure 401 {object} utils.RespStatus{data=nil} "Missing User ID / Unauthorized" // @Failure 404 {object} utils.RespStatus{data=nil} "User Not Found" -// @Failure 404 {object} utils.RespStatus{data=service_user.UserInfoData} "User Not Public" +// @Failure 403 {object} utils.RespStatus{data=service_user.UserInfoData} "User Not Public" // @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error (UUID Parse Failed)" // @Security ApiKeyAuth // @Router /user/info/{user_id} [get] diff --git a/api/user/update.go b/api/user/update.go index d6d3513..63977c5 100644 --- a/api/user/update.go +++ b/api/user/update.go @@ -20,7 +20,7 @@ import ( // @Param payload body service_user.UserInfoData true "Updated User Profile Data" // @Success 200 {object} utils.RespStatus{data=nil} "Successful profile update" // @Failure 400 {object} utils.RespStatus{data=nil} "Invalid Input (Validation Failed)" -// @Failure 403 {object} utils.RespStatus{data=nil} "Missing User ID / Unauthorized" +// @Failure 401 {object} utils.RespStatus{data=nil} "Missing User ID / Unauthorized" // @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error (Database Error / UUID Parse Failed)" // @Security ApiKeyAuth // @Router /user/update [patch] diff --git a/docs/docs.go b/docs/docs.go index 12575bd..1f86e26 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -595,6 +595,24 @@ const docTemplate = `{ ] } }, + "401": { + "description": "Missing User ID / Unauthorized", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/utils.RespStatus" + }, + { + "type": "object", + "properties": { + "data": { + "type": "object" + } + } + } + ] + } + }, "500": { "description": "Internal Server Error", "schema": { @@ -834,6 +852,24 @@ const docTemplate = `{ ] } }, + "401": { + "description": "Missing User ID / Unauthorized", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/utils.RespStatus" + }, + { + "type": "object", + "properties": { + "data": { + "type": "object" + } + } + } + ] + } + }, "404": { "description": "Event Not Found", "schema": { @@ -946,6 +982,24 @@ const docTemplate = `{ ] } }, + "401": { + "description": "Missing User ID / Unauthorized", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/utils.RespStatus" + }, + { + "type": "object", + "properties": { + "data": { + "type": "object" + } + } + } + ] + } + }, "500": { "description": "Internal Server Error (Database query failed)", "schema": { @@ -1004,7 +1058,7 @@ const docTemplate = `{ ] } }, - "403": { + "401": { "description": "Missing User ID / Unauthorized", "schema": { "allOf": [ @@ -1107,7 +1161,7 @@ const docTemplate = `{ ] } }, - "403": { + "401": { "description": "Missing User ID / Unauthorized", "schema": { "allOf": [ @@ -1125,7 +1179,7 @@ const docTemplate = `{ ] } }, - "404": { + "403": { "description": "User Not Public", "schema": { "allOf": [ @@ -1143,6 +1197,24 @@ const docTemplate = `{ ] } }, + "404": { + "description": "User Not Found", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/utils.RespStatus" + }, + { + "type": "object", + "properties": { + "data": { + "type": "object" + } + } + } + ] + } + }, "500": { "description": "Internal Server Error (UUID Parse Failed)", "schema": { @@ -1237,6 +1309,24 @@ const docTemplate = `{ ] } }, + "401": { + "description": "Missing User ID / Unauthorized", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/utils.RespStatus" + }, + { + "type": "object", + "properties": { + "data": { + "type": "object" + } + } + } + ] + } + }, "500": { "description": "Internal Server Error (Search Engine or Missing Offset)", "schema": { @@ -1324,7 +1414,7 @@ const docTemplate = `{ ] } }, - "403": { + "401": { "description": "Missing User ID / Unauthorized", "schema": { "allOf": [ diff --git a/docs/swagger.json b/docs/swagger.json index a29e081..c27c865 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -593,6 +593,24 @@ ] } }, + "401": { + "description": "Missing User ID / Unauthorized", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/utils.RespStatus" + }, + { + "type": "object", + "properties": { + "data": { + "type": "object" + } + } + } + ] + } + }, "500": { "description": "Internal Server Error", "schema": { @@ -832,6 +850,24 @@ ] } }, + "401": { + "description": "Missing User ID / Unauthorized", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/utils.RespStatus" + }, + { + "type": "object", + "properties": { + "data": { + "type": "object" + } + } + } + ] + } + }, "404": { "description": "Event Not Found", "schema": { @@ -944,6 +980,24 @@ ] } }, + "401": { + "description": "Missing User ID / Unauthorized", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/utils.RespStatus" + }, + { + "type": "object", + "properties": { + "data": { + "type": "object" + } + } + } + ] + } + }, "500": { "description": "Internal Server Error (Database query failed)", "schema": { @@ -1002,7 +1056,7 @@ ] } }, - "403": { + "401": { "description": "Missing User ID / Unauthorized", "schema": { "allOf": [ @@ -1105,7 +1159,7 @@ ] } }, - "403": { + "401": { "description": "Missing User ID / Unauthorized", "schema": { "allOf": [ @@ -1123,7 +1177,7 @@ ] } }, - "404": { + "403": { "description": "User Not Public", "schema": { "allOf": [ @@ -1141,6 +1195,24 @@ ] } }, + "404": { + "description": "User Not Found", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/utils.RespStatus" + }, + { + "type": "object", + "properties": { + "data": { + "type": "object" + } + } + } + ] + } + }, "500": { "description": "Internal Server Error (UUID Parse Failed)", "schema": { @@ -1235,6 +1307,24 @@ ] } }, + "401": { + "description": "Missing User ID / Unauthorized", + "schema": { + "allOf": [ + { + "$ref": "#/definitions/utils.RespStatus" + }, + { + "type": "object", + "properties": { + "data": { + "type": "object" + } + } + } + ] + } + }, "500": { "description": "Internal Server Error (Search Engine or Missing Offset)", "schema": { @@ -1322,7 +1412,7 @@ ] } }, - "403": { + "401": { "description": "Missing User ID / Unauthorized", "schema": { "allOf": [ diff --git a/docs/swagger.yaml b/docs/swagger.yaml index db9a1d1..553bc3c 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -463,6 +463,15 @@ paths: data: type: object type: object + "401": + description: Missing User ID / Unauthorized + schema: + allOf: + - $ref: '#/definitions/utils.RespStatus' + - properties: + data: + type: object + type: object "500": description: Internal Server Error schema: @@ -595,6 +604,15 @@ paths: data: type: object type: object + "401": + description: Missing User ID / Unauthorized + schema: + allOf: + - $ref: '#/definitions/utils.RespStatus' + - properties: + data: + type: object + type: object "404": description: Event Not Found schema: @@ -657,6 +675,15 @@ paths: data: type: object type: object + "401": + description: Missing User ID / Unauthorized + schema: + allOf: + - $ref: '#/definitions/utils.RespStatus' + - properties: + data: + type: object + type: object "500": description: Internal Server Error (Database query failed) schema: @@ -689,7 +716,7 @@ paths: data: $ref: '#/definitions/service_user.UserInfoData' type: object - "403": + "401": description: Missing User ID / Unauthorized schema: allOf: @@ -745,7 +772,7 @@ paths: data: $ref: '#/definitions/service_user.UserInfoData' type: object - "403": + "401": description: Missing User ID / Unauthorized schema: allOf: @@ -754,7 +781,7 @@ paths: data: type: object type: object - "404": + "403": description: User Not Public schema: allOf: @@ -763,6 +790,15 @@ paths: data: $ref: '#/definitions/service_user.UserInfoData' type: object + "404": + description: User Not Found + schema: + allOf: + - $ref: '#/definitions/utils.RespStatus' + - properties: + data: + type: object + type: object "500": description: Internal Server Error (UUID Parse Failed) schema: @@ -816,6 +852,15 @@ paths: data: type: object type: object + "401": + description: Missing User ID / Unauthorized + schema: + allOf: + - $ref: '#/definitions/utils.RespStatus' + - properties: + data: + type: object + type: object "500": description: Internal Server Error (Search Engine or Missing Offset) schema: @@ -865,7 +910,7 @@ paths: data: type: object type: object - "403": + "401": description: Missing User ID / Unauthorized schema: allOf: