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

Fix swagger auth docs
Some checks failed
Backend Check Build (NixCN CMS) TeamCity build failed
Details
Client CMS 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-29 01:28:19 +08:00
parent 654b196bfd
commit 937f382f93
7 changed files with 65 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/docs.go
View File

@@ -17,11 +17,6 @@ const docTemplate = `{
"paths": {
"/auth/exchange": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Exchanges client credentials and user session for a specific redirect authorization code.",
"consumes": [
"application/json"
@@ -529,6 +524,11 @@ const docTemplate = `{
},
"/event/checkin": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Creates a temporary check-in code for the authenticated user and event.",
"consumes": [
"application/json"
@@ -609,6 +609,11 @@ const docTemplate = `{
},
"/event/checkin/query": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Returns the timestamp of when the user checked in, or null if not yet checked in.",
"consumes": [
"application/json"
@@ -689,6 +694,11 @@ const docTemplate = `{
},
"/event/checkin/submit": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Submits the generated code to mark the user as attended.",
"consumes": [
"application/json"
@@ -753,6 +763,11 @@ const docTemplate = `{
},
"/event/info": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Fetches the name, start time, and end time of an event using its UUID.",
"consumes": [
"application/json"
@@ -1003,6 +1018,11 @@ const docTemplate = `{
},
"/user/list": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Fetches a list of users with support for pagination via limit and offset. Data is sourced from the search engine for high performance.",
"consumes": [
"application/json"

30
docs/swagger.json
View File

@@ -6,11 +6,6 @@
"paths": {
"/auth/exchange": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Exchanges client credentials and user session for a specific redirect authorization code.",
"consumes": [
"application/json"
@@ -518,6 +513,11 @@
},
"/event/checkin": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Creates a temporary check-in code for the authenticated user and event.",
"consumes": [
"application/json"
@@ -598,6 +598,11 @@
},
"/event/checkin/query": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Returns the timestamp of when the user checked in, or null if not yet checked in.",
"consumes": [
"application/json"
@@ -678,6 +683,11 @@
},
"/event/checkin/submit": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Submits the generated code to mark the user as attended.",
"consumes": [
"application/json"
@@ -742,6 +752,11 @@
},
"/event/info": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Fetches the name, start time, and end time of an event using its UUID.",
"consumes": [
"application/json"
@@ -992,6 +1007,11 @@
},
"/user/list": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Fetches a list of users with support for pagination via limit and offset. Data is sourced from the search engine for high performance.",
"consumes": [
"application/json"

12
docs/swagger.yaml
View File

@@ -209,8 +209,6 @@ paths:
data:
type: object
type: object
security:
- ApiKeyAuth: []
summary: Exchange Auth Code
tags:
- Authentication
@@ -486,6 +484,8 @@ paths:
data:
type: object
type: object
security:
- ApiKeyAuth: []
summary: Generate Check-in Code
tags:
- Event
@@ -531,6 +531,8 @@ paths:
data:
type: object
type: object
security:
- ApiKeyAuth: []
summary: Query Check-in Status
tags:
- Event
@@ -567,6 +569,8 @@ paths:
data:
type: object
type: object
security:
- ApiKeyAuth: []
summary: Submit Check-in Code
tags:
- Event
@@ -621,6 +625,8 @@ paths:
data:
type: object
type: object
security:
- ApiKeyAuth: []
summary: Get Event Information
tags:
- Event
@@ -754,6 +760,8 @@ paths:
data:
type: object
type: object
security:
- ApiKeyAuth: []
summary: List Users
tags:
- User