nixcn/cms-server
1
0
Fork 1
Code Pull Requests Activity

Fix swagget docs
All checks were successful
Client CMS Check Build (NixCN CMS) TeamCity build finished
Details
Backend Check Build (NixCN CMS) TeamCity build finished
Details

Browse Source 
Signed-off-by: Asai Neko <sugar@sne.moe>
This commit is contained in:
Asai Neko
2026-01-31 08:49:52 +08:00
parent c05724a9ee
commit 8c90837a67
10 changed files with 245 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
api/event/checkin.go
View File

@@ -18,6 +18,7 @@ import (
// @Produce json // @Produce json
// @Param event_id query string true "Event UUID" // @Param event_id query string true "Event UUID"
// @Success 200 {object} utils.RespStatus{data=service_event.CheckinResponse} "Successfully generated code" // @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 400 {object} utils.RespStatus{data=nil} "Invalid Input"
// @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error" // @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error"
// @Security ApiKeyAuth // @Security ApiKeyAuth

1
api/event/info.go
View File

@@ -19,6 +19,7 @@ import (
// @Param event_id query string true "Event UUID" // @Param event_id query string true "Event UUID"
// @Success 200 {object} utils.RespStatus{data=data.EventIndexDoc} "Successful retrieval" // @Success 200 {object} utils.RespStatus{data=data.EventIndexDoc} "Successful retrieval"
// @Failure 400 {object} utils.RespStatus{data=nil} "Invalid Input" // @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 404 {object} utils.RespStatus{data=nil} "Event Not Found"
// @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error" // @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error"
// @Security ApiKeyAuth // @Security ApiKeyAuth

1
api/event/list.go
View File

@@ -19,6 +19,7 @@ import (
// @Param offset query string true "Number of events to skip" // @Param offset query string true "Number of events to skip"
// @Success 200 {object} utils.RespStatus{data=[]data.EventIndexDoc} "Successful paginated list retrieval" // @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 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)" // @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error (Database query failed)"
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Router /event/list [get] // @Router /event/list [get]

2
api/user/info.go
View File

@@ -17,7 +17,7 @@ import (
// @Accept json // @Accept json
// @Produce json // @Produce json
// @Success 200 {object} utils.RespStatus{data=service_user.UserInfoData} "Successful profile retrieval" // @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=nil} "User Not Found"
// @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error (UUID Parse Failed)" // @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error (UUID Parse Failed)"
// @Security ApiKeyAuth // @Security ApiKeyAuth

1
api/user/list.go
View File

@@ -18,6 +18,7 @@ import (
// @Param limit query string false "Maximum number of users to return (default 0)" // @Param limit query string false "Maximum number of users to return (default 0)"
// @Param offset query string true "Number of users to skip" // @Param offset query string true "Number of users to skip"
// @Success 200 {object} utils.RespStatus{data=[]data.UserIndexDoc} "Successful paginated list retrieval" // @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 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)" // @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error (Search Engine or Missing Offset)"
// @Security ApiKeyAuth // @Security ApiKeyAuth

4
api/user/other.go
View File

@@ -18,9 +18,9 @@ import (
// @Produce json // @Produce json
// @Param user_id path string true "Other user id" // @Param user_id path string true "Other user id"
// @Success 200 {object} utils.RespStatus{data=service_user.UserInfoData} "Successful profile retrieval" // @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=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)" // @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error (UUID Parse Failed)"
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Router /user/info/{user_id} [get] // @Router /user/info/{user_id} [get]

2
api/user/update.go
View File

@@ -20,7 +20,7 @@ import (
// @Param payload body service_user.UserInfoData true "Updated User Profile Data" // @Param payload body service_user.UserInfoData true "Updated User Profile Data"
// @Success 200 {object} utils.RespStatus{data=nil} "Successful profile update" // @Success 200 {object} utils.RespStatus{data=nil} "Successful profile update"
// @Failure 400 {object} utils.RespStatus{data=nil} "Invalid Input (Validation Failed)" // @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)" // @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error (Database Error / UUID Parse Failed)"
// @Security ApiKeyAuth // @Security ApiKeyAuth
// @Router /user/update [patch] // @Router /user/update [patch]

98
docs/docs.go
View File

@@ -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": { "500": {
"description": "Internal Server Error", "description": "Internal Server Error",
"schema": { "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": { "404": {
"description": "Event Not Found", "description": "Event Not Found",
"schema": { "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": { "500": {
"description": "Internal Server Error (Database query failed)", "description": "Internal Server Error (Database query failed)",
"schema": { "schema": {
@@ -1004,7 +1058,7 @@ const docTemplate = `{
] ]
} }
}, },
"403": { "401": {
"description": "Missing User ID / Unauthorized", "description": "Missing User ID / Unauthorized",
"schema": { "schema": {
"allOf": [ "allOf": [
@@ -1107,7 +1161,7 @@ const docTemplate = `{
] ]
} }
}, },
"403": { "401": {
"description": "Missing User ID / Unauthorized", "description": "Missing User ID / Unauthorized",
"schema": { "schema": {
"allOf": [ "allOf": [
@@ -1125,7 +1179,7 @@ const docTemplate = `{
] ]
} }
}, },
"404": { "403": {
"description": "User Not Public", "description": "User Not Public",
"schema": { "schema": {
"allOf": [ "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": { "500": {
"description": "Internal Server Error (UUID Parse Failed)", "description": "Internal Server Error (UUID Parse Failed)",
"schema": { "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": { "500": {
"description": "Internal Server Error (Search Engine or Missing Offset)", "description": "Internal Server Error (Search Engine or Missing Offset)",
"schema": { "schema": {
@@ -1324,7 +1414,7 @@ const docTemplate = `{
] ]
} }
}, },
"403": { "401": {
"description": "Missing User ID / Unauthorized", "description": "Missing User ID / Unauthorized",
"schema": { "schema": {
"allOf": [ "allOf": [

98
docs/swagger.json
View File

@@ -593,6 +593,24 @@
] ]
} }
}, },
"401": {
"description": "Missing User ID / Unauthorized",
"schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
}
},
"500": { "500": {
"description": "Internal Server Error", "description": "Internal Server Error",
"schema": { "schema": {
@@ -832,6 +850,24 @@
] ]
} }
}, },
"401": {
"description": "Missing User ID / Unauthorized",
"schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
}
},
"404": { "404": {
"description": "Event Not Found", "description": "Event Not Found",
"schema": { "schema": {
@@ -944,6 +980,24 @@
] ]
} }
}, },
"401": {
"description": "Missing User ID / Unauthorized",
"schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
}
},
"500": { "500": {
"description": "Internal Server Error (Database query failed)", "description": "Internal Server Error (Database query failed)",
"schema": { "schema": {
@@ -1002,7 +1056,7 @@
] ]
} }
}, },
"403": { "401": {
"description": "Missing User ID / Unauthorized", "description": "Missing User ID / Unauthorized",
"schema": { "schema": {
"allOf": [ "allOf": [
@@ -1105,7 +1159,7 @@
] ]
} }
}, },
"403": { "401": {
"description": "Missing User ID / Unauthorized", "description": "Missing User ID / Unauthorized",
"schema": { "schema": {
"allOf": [ "allOf": [
@@ -1123,7 +1177,7 @@
] ]
} }
}, },
"404": { "403": {
"description": "User Not Public", "description": "User Not Public",
"schema": { "schema": {
"allOf": [ "allOf": [
@@ -1141,6 +1195,24 @@
] ]
} }
}, },
"404": {
"description": "User Not Found",
"schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
}
},
"500": { "500": {
"description": "Internal Server Error (UUID Parse Failed)", "description": "Internal Server Error (UUID Parse Failed)",
"schema": { "schema": {
@@ -1235,6 +1307,24 @@
] ]
} }
}, },
"401": {
"description": "Missing User ID / Unauthorized",
"schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
}
},
"500": { "500": {
"description": "Internal Server Error (Search Engine or Missing Offset)", "description": "Internal Server Error (Search Engine or Missing Offset)",
"schema": { "schema": {
@@ -1322,7 +1412,7 @@
] ]
} }
}, },
"403": { "401": {
"description": "Missing User ID / Unauthorized", "description": "Missing User ID / Unauthorized",
"schema": { "schema": {
"allOf": [ "allOf": [

53
docs/swagger.yaml
View File

@@ -463,6 +463,15 @@ paths:
data: data:
type: object type: object
type: object type: object
"401":
description: Missing User ID / Unauthorized
schema:
allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"500": "500":
description: Internal Server Error description: Internal Server Error
schema: schema:
@@ -595,6 +604,15 @@ paths:
data: data:
type: object type: object
type: object type: object
"401":
description: Missing User ID / Unauthorized
schema:
allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"404": "404":
description: Event Not Found description: Event Not Found
schema: schema:
@@ -657,6 +675,15 @@ paths:
data: data:
type: object type: object
type: object type: object
"401":
description: Missing User ID / Unauthorized
schema:
allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"500": "500":
description: Internal Server Error (Database query failed) description: Internal Server Error (Database query failed)
schema: schema:
@@ -689,7 +716,7 @@ paths:
data: data:
$ref: '#/definitions/service_user.UserInfoData' $ref: '#/definitions/service_user.UserInfoData'
type: object type: object
"403": "401":
description: Missing User ID / Unauthorized description: Missing User ID / Unauthorized
schema: schema:
allOf: allOf:
@@ -745,7 +772,7 @@ paths:
data: data:
$ref: '#/definitions/service_user.UserInfoData' $ref: '#/definitions/service_user.UserInfoData'
type: object type: object
"403": "401":
description: Missing User ID / Unauthorized description: Missing User ID / Unauthorized
schema: schema:
allOf: allOf:
@@ -754,7 +781,7 @@ paths:
data: data:
type: object type: object
type: object type: object
"404": "403":
description: User Not Public description: User Not Public
schema: schema:
allOf: allOf:
@@ -763,6 +790,15 @@ paths:
data: data:
$ref: '#/definitions/service_user.UserInfoData' $ref: '#/definitions/service_user.UserInfoData'
type: object type: object
"404":
description: User Not Found
schema:
allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"500": "500":
description: Internal Server Error (UUID Parse Failed) description: Internal Server Error (UUID Parse Failed)
schema: schema:
@@ -816,6 +852,15 @@ paths:
data: data:
type: object type: object
type: object type: object
"401":
description: Missing User ID / Unauthorized
schema:
allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"500": "500":
description: Internal Server Error (Search Engine or Missing Offset) description: Internal Server Error (Search Engine or Missing Offset)
schema: schema:
@@ -865,7 +910,7 @@ paths:
data: data:
type: object type: object
type: object type: object
"403": "401":
description: Missing User ID / Unauthorized description: Missing User ID / Unauthorized
schema: schema:
allOf: allOf: