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

Fix swagger 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 12:09:14 +08:00
parent 287f315c00
commit 7536fdc1ac
5 changed files with 49 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
api/event/join.go
View File

@@ -18,6 +18,7 @@ import (
// @Param request body service_event.EventJoinData true "Event Join Details (UserId and EventId are required)" // @Param request body service_event.EventJoinData true "Event Join Details (UserId and EventId are required)"
// @Success 200 {object} utils.RespStatus{data=nil} "Successfully joined the event" // @Success 200 {object} utils.RespStatus{data=nil} "Successfully joined the event"
// @Failure 400 {object} utils.RespStatus{data=nil} "Invalid Input or UUID Parse Failed" // @Failure 400 {object} utils.RespStatus{data=nil} "Invalid Input or UUID Parse Failed"
// @Failure 401 {object} utils.RespStatus{data=nil} "Missing User ID / Unauthorized"
// @Failure 403 {object} utils.RespStatus{data=nil} "Unauthorized / Missing User ID" // @Failure 403 {object} utils.RespStatus{data=nil} "Unauthorized / Missing User ID"
// @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error / Database Error" // @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error / Database Error"
// @Security ApiKeyAuth // @Security ApiKeyAuth

27
docs/docs.go
View File

@@ -975,6 +975,24 @@ const docTemplate = `{
] ]
} }
}, },
"401": {
"description": "Missing User ID / Unauthorized",
"schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
}
},
"403": { "403": {
"description": "Unauthorized / Missing User ID", "description": "Unauthorized / Missing User ID",
"schema": { "schema": {
@@ -1721,15 +1739,6 @@ const docTemplate = `{
"properties": { "properties": {
"event_id": { "event_id": {
"type": "string" "type": "string"
},
"role": {
"type": "string"
},
"state": {
"type": "string"
},
"user_id": {
"type": "string"
} }
} }
}, },

27
docs/swagger.json
View File

@@ -973,6 +973,24 @@
] ]
} }
}, },
"401": {
"description": "Missing User ID / Unauthorized",
"schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
}
},
"403": { "403": {
"description": "Unauthorized / Missing User ID", "description": "Unauthorized / Missing User ID",
"schema": { "schema": {
@@ -1719,15 +1737,6 @@
"properties": { "properties": {
"event_id": { "event_id": {
"type": "string" "type": "string"
},
"role": {
"type": "string"
},
"state": {
"type": "string"
},
"user_id": {
"type": "string"
} }
} }
}, },

15
docs/swagger.yaml
View File

@@ -104,12 +104,6 @@ definitions:
properties: properties:
event_id: event_id:
type: string type: string
role:
type: string
state:
type: string
user_id:
type: string
type: object type: object
service_user.UserInfoData: service_user.UserInfoData:
properties: properties:
@@ -681,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
"403": "403":
description: Unauthorized / Missing User ID description: Unauthorized / Missing User ID
schema: schema:

6
service/service_event/join_event.go
View File

@@ -11,9 +11,9 @@ import (
type EventJoinData struct { type EventJoinData struct {
EventId string `json:"event_id"` EventId string `json:"event_id"`
UserId string `json:"user_id"` UserId string `json:"user_id" swaggerignore:"true"`
Role string `json:"role"` Role string `json:"role" swaggerignore:"true"`
State string `json:"state"` State string `json:"state" swaggerignore:"true"`
} }
type EventJoinPayload struct { type EventJoinPayload struct {