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

Generate swagger docs
Some checks failed
Client CMS Check Build (NixCN CMS) TeamCity build finished
Details
Backend Check Build (NixCN CMS) TeamCity build failed
Details

Browse Source 
Signed-off-by: Asai Neko <sugar@sne.moe>
This commit is contained in:
Asai Neko
2026-01-29 00:59:49 +08:00
parent 330b037dca
commit 732d9866db
3 changed files with 1563 additions and 301 deletions
Download Patch File Download Diff File Expand all files Collapse all files

724
docs/docs.go
View File

@@ -46,27 +46,75 @@ const docTemplate = `{
], ],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Successful exchange",
"schema": { "schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_auth.ExchangeResult" "$ref": "#/definitions/service_auth.ExchangeResult"
} }
}
}
]
}
}, },
"400": { "400": {
"description": "Invalid Input", "description": "Invalid Input",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"401": { "401": {
"description": "Unauthorized", "description": "Unauthorized",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"500": { "500": {
"description": "Internal Server Error", "description": "Internal Server Error",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -98,27 +146,75 @@ const docTemplate = `{
], ],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Successful request",
"schema": { "schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_auth.MagicResult" "$ref": "#/definitions/service_auth.MagicResult"
} }
}
}
]
}
}, },
"400": { "400": {
"description": "Invalid Input", "description": "Invalid Input",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"403": { "403": {
"description": "Turnstile Verification Failed", "description": "Turnstile Verification Failed",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"500": { "500": {
"description": "Internal Server Error", "description": "Internal Server Error",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -131,6 +227,7 @@ const docTemplate = `{
"application/x-www-form-urlencoded" "application/x-www-form-urlencoded"
], ],
"produces": [ "produces": [
"application/json",
"text/html" "text/html"
], ],
"tags": [ "tags": [
@@ -176,19 +273,55 @@ const docTemplate = `{
"400": { "400": {
"description": "Invalid Input / Client Not Found / URI Mismatch", "description": "Invalid Input / Client Not Found / URI Mismatch",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"403": { "403": {
"description": "Invalid or Expired Verification Code", "description": "Invalid or Expired Verification Code",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"500": { "500": {
"description": "Internal Server Error", "description": "Internal Server Error",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -220,27 +353,75 @@ const docTemplate = `{
], ],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Successful rotation",
"schema": { "schema": {
"$ref": "#/definitions/service_auth.RefreshResult" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_auth.TokenResponse"
}
}
}
]
} }
}, },
"400": { "400": {
"description": "Invalid Input", "description": "Invalid Input",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"401": { "401": {
"description": "Invalid Refresh Token", "description": "Invalid Refresh Token",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"500": { "500": {
"description": "Internal Server Error", "description": "Internal Server Error",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -272,27 +453,75 @@ const docTemplate = `{
], ],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Successful token issuance",
"schema": { "schema": {
"$ref": "#/definitions/service_auth.TokenResult" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_auth.TokenResponse"
}
}
}
]
} }
}, },
"400": { "400": {
"description": "Invalid Input", "description": "Invalid Input",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"403": { "403": {
"description": "Invalid or Expired Code", "description": "Invalid or Expired Code",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"500": { "500": {
"description": "Internal Server Error", "description": "Internal Server Error",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -322,12 +551,60 @@ const docTemplate = `{
], ],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Successfully generated code",
"schema": { "schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_event.CheckinResult" "$ref": "#/definitions/service_event.CheckinResult"
} }
} }
} }
]
}
},
"400": {
"description": "Invalid Input",
"schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
}
}
}
} }
}, },
"/event/checkin/query": { "/event/checkin/query": {
@@ -354,12 +631,60 @@ const docTemplate = `{
], ],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Current attendance status",
"schema": { "schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_event.CheckinQueryResult" "$ref": "#/definitions/service_event.CheckinQueryResult"
} }
} }
} }
]
}
},
"400": {
"description": "Invalid Input",
"schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
}
},
"404": {
"description": "Record Not Found",
"schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
}
}
}
} }
}, },
"/event/checkin/submit": { "/event/checkin/submit": {
@@ -388,9 +713,39 @@ const docTemplate = `{
], ],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Attendance marked successfully",
"schema": { "schema": {
"$ref": "#/definitions/service_event.CheckinSubmitResult" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
}
},
"400": {
"description": "Invalid Code or Input",
"schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -420,27 +775,75 @@ const docTemplate = `{
], ],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Successful retrieval",
"schema": { "schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_event.InfoResult" "$ref": "#/definitions/service_event.InfoResult"
} }
}
}
]
}
}, },
"400": { "400": {
"description": "Invalid Input", "description": "Invalid Input",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"404": { "404": {
"description": "Event Not Found", "description": "Event Not Found",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"500": { "500": {
"description": "Internal Server Error", "description": "Internal Server Error",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -466,15 +869,39 @@ const docTemplate = `{
"summary": "Get Full User Table", "summary": "Get Full User Table",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Successful retrieval of full user table",
"schema": { "schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_user.UserTableResult" "$ref": "#/definitions/service_user.UserTableResult"
} }
}
}
]
}
}, },
"500": { "500": {
"description": "Internal Server Error (Database Error)", "description": "Internal Server Error (Database Error)",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -500,27 +927,75 @@ const docTemplate = `{
"summary": "Get My User Information", "summary": "Get My User Information",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Successful profile retrieval",
"schema": { "schema": {
"$ref": "#/definitions/service_user.UserInfoResult" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_user.UserInfoData"
}
}
}
]
} }
}, },
"403": { "403": {
"description": "Missing User ID / Unauthorized", "description": "Missing User ID / Unauthorized",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"404": { "404": {
"description": "User Not Found", "description": "User Not Found",
"schema": { "schema": {
"type": "string" "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": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -528,7 +1003,7 @@ const docTemplate = `{
}, },
"/user/list": { "/user/list": {
"get": { "get": {
"description": "Fetches a list of users with support for pagination via limit and offset.", "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": [ "consumes": [
"application/json" "application/json"
], ],
@@ -556,21 +1031,60 @@ const docTemplate = `{
], ],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Successful paginated list retrieval",
"schema": { "schema": {
"$ref": "#/definitions/service_user.UserListResult" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/data.UserSearchDoc"
}
}
}
}
]
} }
}, },
"400": { "400": {
"description": "Invalid Input (Format Error)", "description": "Invalid Input (Format Error)",
"schema": { "schema": {
"type": "string" "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": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -607,27 +1121,75 @@ const docTemplate = `{
], ],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Successful profile update",
"schema": { "schema": {
"$ref": "#/definitions/service_user.UserInfoResult" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"400": { "400": {
"description": "Invalid Input (Validation Failed)", "description": "Invalid Input (Validation Failed)",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"403": { "403": {
"description": "Missing User ID / Unauthorized", "description": "Missing User ID / Unauthorized",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"500": { "500": {
"description": "Internal Server Error (Database Error / UUID Parse Failed)", "description": "Internal Server Error (Database Error / UUID Parse Failed)",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -793,17 +1355,6 @@ const docTemplate = `{
} }
} }
}, },
"service_auth.RefreshResult": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
},
"data": {
"$ref": "#/definitions/service_auth.TokenResponse"
}
}
},
"service_auth.TokenData": { "service_auth.TokenData": {
"type": "object", "type": "object",
"properties": { "properties": {
@@ -823,17 +1374,6 @@ const docTemplate = `{
} }
} }
}, },
"service_auth.TokenResult": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
},
"data": {
"$ref": "#/definitions/service_auth.TokenResponse"
}
}
},
"service_event.CheckinQueryResult": { "service_event.CheckinQueryResult": {
"type": "object", "type": "object",
"properties": { "properties": {
@@ -874,14 +1414,6 @@ const docTemplate = `{
} }
} }
}, },
"service_event.CheckinSubmitResult": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
}
}
},
"service_event.InfoResult": { "service_event.InfoResult": {
"type": "object", "type": "object",
"properties": { "properties": {
@@ -936,31 +1468,6 @@ const docTemplate = `{
} }
} }
}, },
"service_user.UserInfoResult": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
},
"data": {
"$ref": "#/definitions/service_user.UserInfoData"
}
}
},
"service_user.UserListResult": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
},
"user_list": {
"type": "array",
"items": {
"$ref": "#/definitions/data.UserSearchDoc"
}
}
}
},
"service_user.UserTableResult": { "service_user.UserTableResult": {
"type": "object", "type": "object",
"properties": { "properties": {
@@ -985,6 +1492,21 @@ const docTemplate = `{
"type": "integer" "type": "integer"
} }
} }
},
"utils.RespStatus": {
"type": "object",
"properties": {
"code": {
"type": "integer"
},
"data": {},
"error_id": {
"type": "string"
},
"status": {
"type": "string"
}
}
} }
} }
}` }`

724
docs/swagger.json
View File

@@ -35,27 +35,75 @@
], ],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Successful exchange",
"schema": { "schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_auth.ExchangeResult" "$ref": "#/definitions/service_auth.ExchangeResult"
} }
}
}
]
}
}, },
"400": { "400": {
"description": "Invalid Input", "description": "Invalid Input",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"401": { "401": {
"description": "Unauthorized", "description": "Unauthorized",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"500": { "500": {
"description": "Internal Server Error", "description": "Internal Server Error",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -87,27 +135,75 @@
], ],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Successful request",
"schema": { "schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_auth.MagicResult" "$ref": "#/definitions/service_auth.MagicResult"
} }
}
}
]
}
}, },
"400": { "400": {
"description": "Invalid Input", "description": "Invalid Input",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"403": { "403": {
"description": "Turnstile Verification Failed", "description": "Turnstile Verification Failed",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"500": { "500": {
"description": "Internal Server Error", "description": "Internal Server Error",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -120,6 +216,7 @@
"application/x-www-form-urlencoded" "application/x-www-form-urlencoded"
], ],
"produces": [ "produces": [
"application/json",
"text/html" "text/html"
], ],
"tags": [ "tags": [
@@ -165,19 +262,55 @@
"400": { "400": {
"description": "Invalid Input / Client Not Found / URI Mismatch", "description": "Invalid Input / Client Not Found / URI Mismatch",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"403": { "403": {
"description": "Invalid or Expired Verification Code", "description": "Invalid or Expired Verification Code",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"500": { "500": {
"description": "Internal Server Error", "description": "Internal Server Error",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -209,27 +342,75 @@
], ],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Successful rotation",
"schema": { "schema": {
"$ref": "#/definitions/service_auth.RefreshResult" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_auth.TokenResponse"
}
}
}
]
} }
}, },
"400": { "400": {
"description": "Invalid Input", "description": "Invalid Input",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"401": { "401": {
"description": "Invalid Refresh Token", "description": "Invalid Refresh Token",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"500": { "500": {
"description": "Internal Server Error", "description": "Internal Server Error",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -261,27 +442,75 @@
], ],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Successful token issuance",
"schema": { "schema": {
"$ref": "#/definitions/service_auth.TokenResult" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_auth.TokenResponse"
}
}
}
]
} }
}, },
"400": { "400": {
"description": "Invalid Input", "description": "Invalid Input",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"403": { "403": {
"description": "Invalid or Expired Code", "description": "Invalid or Expired Code",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"500": { "500": {
"description": "Internal Server Error", "description": "Internal Server Error",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -311,12 +540,60 @@
], ],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Successfully generated code",
"schema": { "schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_event.CheckinResult" "$ref": "#/definitions/service_event.CheckinResult"
} }
} }
} }
]
}
},
"400": {
"description": "Invalid Input",
"schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
}
}
}
} }
}, },
"/event/checkin/query": { "/event/checkin/query": {
@@ -343,12 +620,60 @@
], ],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Current attendance status",
"schema": { "schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_event.CheckinQueryResult" "$ref": "#/definitions/service_event.CheckinQueryResult"
} }
} }
} }
]
}
},
"400": {
"description": "Invalid Input",
"schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
}
},
"404": {
"description": "Record Not Found",
"schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
}
}
}
} }
}, },
"/event/checkin/submit": { "/event/checkin/submit": {
@@ -377,9 +702,39 @@
], ],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Attendance marked successfully",
"schema": { "schema": {
"$ref": "#/definitions/service_event.CheckinSubmitResult" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
}
},
"400": {
"description": "Invalid Code or Input",
"schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -409,27 +764,75 @@
], ],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Successful retrieval",
"schema": { "schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_event.InfoResult" "$ref": "#/definitions/service_event.InfoResult"
} }
}
}
]
}
}, },
"400": { "400": {
"description": "Invalid Input", "description": "Invalid Input",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"404": { "404": {
"description": "Event Not Found", "description": "Event Not Found",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"500": { "500": {
"description": "Internal Server Error", "description": "Internal Server Error",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -455,15 +858,39 @@
"summary": "Get Full User Table", "summary": "Get Full User Table",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Successful retrieval of full user table",
"schema": { "schema": {
"allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_user.UserTableResult" "$ref": "#/definitions/service_user.UserTableResult"
} }
}
}
]
}
}, },
"500": { "500": {
"description": "Internal Server Error (Database Error)", "description": "Internal Server Error (Database Error)",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -489,27 +916,75 @@
"summary": "Get My User Information", "summary": "Get My User Information",
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Successful profile retrieval",
"schema": { "schema": {
"$ref": "#/definitions/service_user.UserInfoResult" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_user.UserInfoData"
}
}
}
]
} }
}, },
"403": { "403": {
"description": "Missing User ID / Unauthorized", "description": "Missing User ID / Unauthorized",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"404": { "404": {
"description": "User Not Found", "description": "User Not Found",
"schema": { "schema": {
"type": "string" "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": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -517,7 +992,7 @@
}, },
"/user/list": { "/user/list": {
"get": { "get": {
"description": "Fetches a list of users with support for pagination via limit and offset.", "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": [ "consumes": [
"application/json" "application/json"
], ],
@@ -545,21 +1020,60 @@
], ],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Successful paginated list retrieval",
"schema": { "schema": {
"$ref": "#/definitions/service_user.UserListResult" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/data.UserSearchDoc"
}
}
}
}
]
} }
}, },
"400": { "400": {
"description": "Invalid Input (Format Error)", "description": "Invalid Input (Format Error)",
"schema": { "schema": {
"type": "string" "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": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -596,27 +1110,75 @@
], ],
"responses": { "responses": {
"200": { "200": {
"description": "OK", "description": "Successful profile update",
"schema": { "schema": {
"$ref": "#/definitions/service_user.UserInfoResult" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"400": { "400": {
"description": "Invalid Input (Validation Failed)", "description": "Invalid Input (Validation Failed)",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"403": { "403": {
"description": "Missing User ID / Unauthorized", "description": "Missing User ID / Unauthorized",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
}, },
"500": { "500": {
"description": "Internal Server Error (Database Error / UUID Parse Failed)", "description": "Internal Server Error (Database Error / UUID Parse Failed)",
"schema": { "schema": {
"type": "string" "allOf": [
{
"$ref": "#/definitions/utils.RespStatus"
},
{
"type": "object",
"properties": {
"data": {
"type": "object"
}
}
}
]
} }
} }
} }
@@ -782,17 +1344,6 @@
} }
} }
}, },
"service_auth.RefreshResult": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
},
"data": {
"$ref": "#/definitions/service_auth.TokenResponse"
}
}
},
"service_auth.TokenData": { "service_auth.TokenData": {
"type": "object", "type": "object",
"properties": { "properties": {
@@ -812,17 +1363,6 @@
} }
} }
}, },
"service_auth.TokenResult": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
},
"data": {
"$ref": "#/definitions/service_auth.TokenResponse"
}
}
},
"service_event.CheckinQueryResult": { "service_event.CheckinQueryResult": {
"type": "object", "type": "object",
"properties": { "properties": {
@@ -863,14 +1403,6 @@
} }
} }
}, },
"service_event.CheckinSubmitResult": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
}
}
},
"service_event.InfoResult": { "service_event.InfoResult": {
"type": "object", "type": "object",
"properties": { "properties": {
@@ -925,31 +1457,6 @@
} }
} }
}, },
"service_user.UserInfoResult": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
},
"data": {
"$ref": "#/definitions/service_user.UserInfoData"
}
}
},
"service_user.UserListResult": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
},
"user_list": {
"type": "array",
"items": {
"$ref": "#/definitions/data.UserSearchDoc"
}
}
}
},
"service_user.UserTableResult": { "service_user.UserTableResult": {
"type": "object", "type": "object",
"properties": { "properties": {
@@ -974,6 +1481,21 @@
"type": "integer" "type": "integer"
} }
} }
},
"utils.RespStatus": {
"type": "object",
"properties": {
"code": {
"type": "integer"
},
"data": {},
"error_id": {
"type": "string"
},
"status": {
"type": "string"
}
}
} }
} }
} }

380
docs/swagger.yaml
View File

@@ -102,13 +102,6 @@ definitions:
refresh_token: refresh_token:
type: string type: string
type: object type: object
service_auth.RefreshResult:
properties:
common:
$ref: '#/definitions/shared.CommonResult'
data:
$ref: '#/definitions/service_auth.TokenResponse'
type: object
service_auth.TokenData: service_auth.TokenData:
properties: properties:
code: code:
@@ -121,13 +114,6 @@ definitions:
refresh_token: refresh_token:
type: string type: string
type: object type: object
service_auth.TokenResult:
properties:
common:
$ref: '#/definitions/shared.CommonResult'
data:
$ref: '#/definitions/service_auth.TokenResponse'
type: object
service_event.CheckinQueryResult: service_event.CheckinQueryResult:
properties: properties:
common: common:
@@ -153,11 +139,6 @@ definitions:
checkin_code: checkin_code:
type: string type: string
type: object type: object
service_event.CheckinSubmitResult:
properties:
common:
$ref: '#/definitions/shared.CommonResult'
type: object
service_event.InfoResult: service_event.InfoResult:
properties: properties:
common: common:
@@ -193,22 +174,6 @@ definitions:
username: username:
type: string type: string
type: object type: object
service_user.UserInfoResult:
properties:
common:
$ref: '#/definitions/shared.CommonResult'
data:
$ref: '#/definitions/service_user.UserInfoData'
type: object
service_user.UserListResult:
properties:
common:
$ref: '#/definitions/shared.CommonResult'
user_list:
items:
$ref: '#/definitions/data.UserSearchDoc'
type: array
type: object
service_user.UserTableResult: service_user.UserTableResult:
properties: properties:
common: common:
@@ -225,6 +190,16 @@ definitions:
httpCode: httpCode:
type: integer type: integer
type: object type: object
utils.RespStatus:
properties:
code:
type: integer
data: {}
error_id:
type: string
status:
type: string
type: object
info: info:
contact: {} contact: {}
paths: paths:
@@ -245,21 +220,41 @@ paths:
- application/json - application/json
responses: responses:
"200": "200":
description: OK description: Successful exchange
schema: schema:
allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
$ref: '#/definitions/service_auth.ExchangeResult' $ref: '#/definitions/service_auth.ExchangeResult'
type: object
"400": "400":
description: Invalid Input description: Invalid Input
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"401": "401":
description: Unauthorized description: Unauthorized
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"500": "500":
description: Internal Server Error description: Internal Server Error
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
security: security:
- ApiKeyAuth: [] - ApiKeyAuth: []
summary: Exchange Auth Code summary: Exchange Auth Code
@@ -282,21 +277,41 @@ paths:
- application/json - application/json
responses: responses:
"200": "200":
description: OK description: Successful request
schema: schema:
allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
$ref: '#/definitions/service_auth.MagicResult' $ref: '#/definitions/service_auth.MagicResult'
type: object
"400": "400":
description: Invalid Input description: Invalid Input
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"403": "403":
description: Turnstile Verification Failed description: Turnstile Verification Failed
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"500": "500":
description: Internal Server Error description: Internal Server Error
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
summary: Request Magic Link summary: Request Magic Link
tags: tags:
- Authentication - Authentication
@@ -328,6 +343,7 @@ paths:
name: state name: state
type: string type: string
produces: produces:
- application/json
- text/html - text/html
responses: responses:
"302": "302":
@@ -337,15 +353,30 @@ paths:
"400": "400":
description: Invalid Input / Client Not Found / URI Mismatch description: Invalid Input / Client Not Found / URI Mismatch
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"403": "403":
description: Invalid or Expired Verification Code description: Invalid or Expired Verification Code
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"500": "500":
description: Internal Server Error description: Internal Server Error
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
summary: Handle Auth Callback and Redirect summary: Handle Auth Callback and Redirect
tags: tags:
- Authentication - Authentication
@@ -366,21 +397,41 @@ paths:
- application/json - application/json
responses: responses:
"200": "200":
description: OK description: Successful rotation
schema: schema:
$ref: '#/definitions/service_auth.RefreshResult' allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
$ref: '#/definitions/service_auth.TokenResponse'
type: object
"400": "400":
description: Invalid Input description: Invalid Input
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"401": "401":
description: Invalid Refresh Token description: Invalid Refresh Token
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"500": "500":
description: Internal Server Error description: Internal Server Error
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
summary: Refresh Access Token summary: Refresh Access Token
tags: tags:
- Authentication - Authentication
@@ -401,21 +452,41 @@ paths:
- application/json - application/json
responses: responses:
"200": "200":
description: OK description: Successful token issuance
schema: schema:
$ref: '#/definitions/service_auth.TokenResult' allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
$ref: '#/definitions/service_auth.TokenResponse'
type: object
"400": "400":
description: Invalid Input description: Invalid Input
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"403": "403":
description: Invalid or Expired Code description: Invalid or Expired Code
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"500": "500":
description: Internal Server Error description: Internal Server Error
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
summary: Exchange Code for Token summary: Exchange Code for Token
tags: tags:
- Authentication - Authentication
@@ -435,9 +506,32 @@ paths:
- application/json - application/json
responses: responses:
"200": "200":
description: OK description: Successfully generated code
schema: schema:
allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
$ref: '#/definitions/service_event.CheckinResult' $ref: '#/definitions/service_event.CheckinResult'
type: object
"400":
description: Invalid Input
schema:
allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"500":
description: Internal Server Error
schema:
allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
summary: Generate Check-in Code summary: Generate Check-in Code
tags: tags:
- Event - Event
@@ -457,9 +551,32 @@ paths:
- application/json - application/json
responses: responses:
"200": "200":
description: OK description: Current attendance status
schema: schema:
allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
$ref: '#/definitions/service_event.CheckinQueryResult' $ref: '#/definitions/service_event.CheckinQueryResult'
type: object
"400":
description: Invalid Input
schema:
allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"404":
description: Record Not Found
schema:
allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
summary: Query Check-in Status summary: Query Check-in Status
tags: tags:
- Event - Event
@@ -479,9 +596,23 @@ paths:
- application/json - application/json
responses: responses:
"200": "200":
description: OK description: Attendance marked successfully
schema: schema:
$ref: '#/definitions/service_event.CheckinSubmitResult' allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"400":
description: Invalid Code or Input
schema:
allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
summary: Submit Check-in Code summary: Submit Check-in Code
tags: tags:
- Event - Event
@@ -501,21 +632,41 @@ paths:
- application/json - application/json
responses: responses:
"200": "200":
description: OK description: Successful retrieval
schema: schema:
allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
$ref: '#/definitions/service_event.InfoResult' $ref: '#/definitions/service_event.InfoResult'
type: object
"400": "400":
description: Invalid Input description: Invalid Input
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"404": "404":
description: Event Not Found description: Event Not Found
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"500": "500":
description: Internal Server Error description: Internal Server Error
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
summary: Get Event Information summary: Get Event Information
tags: tags:
- Event - Event
@@ -529,13 +680,23 @@ paths:
- application/json - application/json
responses: responses:
"200": "200":
description: OK description: Successful retrieval of full user table
schema: schema:
allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
$ref: '#/definitions/service_user.UserTableResult' $ref: '#/definitions/service_user.UserTableResult'
type: object
"500": "500":
description: Internal Server Error (Database Error) description: Internal Server Error (Database Error)
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
security: security:
- ApiKeyAuth: [] - ApiKeyAuth: []
summary: Get Full User Table summary: Get Full User Table
@@ -551,21 +712,41 @@ paths:
- application/json - application/json
responses: responses:
"200": "200":
description: OK description: Successful profile retrieval
schema: schema:
$ref: '#/definitions/service_user.UserInfoResult' allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
$ref: '#/definitions/service_user.UserInfoData'
type: object
"403": "403":
description: Missing User ID / Unauthorized description: Missing User ID / Unauthorized
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"404": "404":
description: User Not Found description: User Not Found
schema: schema:
type: string 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:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
security: security:
- ApiKeyAuth: [] - ApiKeyAuth: []
summary: Get My User Information summary: Get My User Information
@@ -576,7 +757,7 @@ paths:
consumes: consumes:
- application/json - application/json
description: Fetches a list of users with support for pagination via limit and description: Fetches a list of users with support for pagination via limit and
offset. offset. Data is sourced from the search engine for high performance.
parameters: parameters:
- description: Maximum number of users to return (default 0) - description: Maximum number of users to return (default 0)
in: query in: query
@@ -591,17 +772,34 @@ paths:
- application/json - application/json
responses: responses:
"200": "200":
description: OK description: Successful paginated list retrieval
schema: schema:
$ref: '#/definitions/service_user.UserListResult' allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
items:
$ref: '#/definitions/data.UserSearchDoc'
type: array
type: object
"400": "400":
description: Invalid Input (Format Error) description: Invalid Input (Format Error)
schema: schema:
type: string 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:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
summary: List Users summary: List Users
tags: tags:
- User - User
@@ -623,21 +821,41 @@ paths:
- application/json - application/json
responses: responses:
"200": "200":
description: OK description: Successful profile update
schema: schema:
$ref: '#/definitions/service_user.UserInfoResult' allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"400": "400":
description: Invalid Input (Validation Failed) description: Invalid Input (Validation Failed)
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"403": "403":
description: Missing User ID / Unauthorized description: Missing User ID / Unauthorized
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
"500": "500":
description: Internal Server Error (Database Error / UUID Parse Failed) description: Internal Server Error (Database Error / UUID Parse Failed)
schema: schema:
type: string allOf:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
type: object
type: object
security: security:
- ApiKeyAuth: [] - ApiKeyAuth: []
summary: Update User Information summary: Update User Information