mirror of
https://github.com/casdoor/casdoor.git
synced 2025-07-03 04:10:20 +08:00
docs: Upgrade to swagger UI 4.1.0 (#319)
* docs: update swagger docs Signed-off-by: “seriouszyx” <seriouszyx@foxmail.com> * docs: upgrade to Swagger UI 4.1.0 Signed-off-by: “seriouszyx” <seriouszyx@foxmail.com>
This commit is contained in:
Yixiang Zhao
@ -150,6 +150,118 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/add-webhook": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"api"
|
||||
],
|
||||
"description": "add webhook",
|
||||
"operationId": "ApiController.AddWebhook",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"description": "The details of the webhook",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/object.Webhook"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "The Response object",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/controllers.Response"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/api/send-email": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"api"
|
||||
],
|
||||
"description": "This API is not for Casdoor frontend to call, it is for Casdoor SDKs.",
|
||||
"operationId": "ApiController.SendEmail",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"name": "clientId",
|
||||
"description": "The clientId of the application",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "clientSecret",
|
||||
"description": "The clientSecret of the application",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"description": "Details of the email request",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/emailForm"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "object",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/Response"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/api/send-sms": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"api"
|
||||
],
|
||||
"description": "This API is not for Casdoor frontend to call, it is for Casdoor SDKs.",
|
||||
"operationId": "ApiController.SendSms",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"name": "clientId",
|
||||
"description": "The clientId of the application",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "clientSecret",
|
||||
"description": "The clientSecret of the application",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"description": "Details of the sms request",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/smsForm"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "object",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/Response"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/delete-application": {
|
||||
"post": {
|
||||
"tags": [
|
||||
@ -290,6 +402,34 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/delete-webhook": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"api"
|
||||
],
|
||||
"description": "delete webhook",
|
||||
"operationId": "ApiController.DeleteWebhook",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"description": "The details of the webhook",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/object.Webhook"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "The Response object",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/controllers.Response"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/get-account": {
|
||||
"get": {
|
||||
"tags": [
|
||||
@ -362,32 +502,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/get-default-application": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"api"
|
||||
],
|
||||
"description": "get the detail of the default application",
|
||||
"operationId": "ApiController.GetDefaultApplication",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"name": "owner",
|
||||
"description": "The owner of the application.",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "The Response object",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/object.Application"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/get-email-and-phone": {
|
||||
"post": {
|
||||
"tags": [
|
||||
@ -558,6 +672,22 @@
|
||||
],
|
||||
"description": "get all records",
|
||||
"operationId": "ApiController.GetRecords",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"name": "pageSize",
|
||||
"description": "The size of each page",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "p",
|
||||
"description": "The number of the page",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "The Response object",
|
||||
@ -642,6 +772,20 @@
|
||||
"description": "The owner of tokens",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "pageSize",
|
||||
"description": "The size of each page",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "p",
|
||||
"description": "The number of the page",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
@ -683,6 +827,32 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/get-user-application": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"api"
|
||||
],
|
||||
"description": "get the detail of the user's application",
|
||||
"operationId": "ApiController.GetUserApplication",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"name": "id",
|
||||
"description": "The id of the user",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "The Response object",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/object.Application"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/get-users": {
|
||||
"get": {
|
||||
"tags": [
|
||||
@ -711,6 +881,61 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/get-webhook": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"api"
|
||||
],
|
||||
"description": "get webhook",
|
||||
"operationId": "ApiController.GetWebhook",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"name": "id",
|
||||
"description": "The id of the webhook",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "The Response object",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/object.Webhook"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/get-webhooks": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"api"
|
||||
],
|
||||
"description": "get webhooks",
|
||||
"operationId": "ApiController.GetWebhooks",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"name": "owner",
|
||||
"description": "The owner of webhooks",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "The Response object",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/object.Webhook"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/login": {
|
||||
"post": {
|
||||
"tags": [
|
||||
@ -751,34 +976,95 @@
|
||||
"tags": [
|
||||
"api"
|
||||
],
|
||||
"description": "get oAuth token",
|
||||
"description": "get OAuth access token",
|
||||
"operationId": "ApiController.GetOAuthToken",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"name": "grant_type",
|
||||
"description": "oAuth grant type",
|
||||
"description": "OAuth grant type",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "client_id",
|
||||
"description": "oAuth client id",
|
||||
"description": "OAuth client id",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "client_secret",
|
||||
"description": "oAuth client secret",
|
||||
"description": "OAuth client secret",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "code",
|
||||
"description": "oAuth code",
|
||||
"description": "OAuth code",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "The Response object",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/object.TokenWrapper"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/login/oauth/code": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"api"
|
||||
],
|
||||
"description": "get OAuth code",
|
||||
"operationId": "ApiController.GetOAuthCode",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"name": "user_id",
|
||||
"description": "The id of user",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "client_id",
|
||||
"description": "OAuth client id",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "response_type",
|
||||
"description": "OAuth response type",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "redirect_uri",
|
||||
"description": "OAuth redirect URI",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "scope",
|
||||
"description": "OAuth scope",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "state",
|
||||
"description": "OAuth state",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@ -1117,27 +1403,29 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/upload-avatar": {
|
||||
"/api/update-webhook": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"api"
|
||||
],
|
||||
"description": "upload avatar",
|
||||
"operationId": "ApiController.UploadAvatar",
|
||||
"description": "update webhook",
|
||||
"operationId": "ApiController.UpdateWebhook",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "formData",
|
||||
"name": "avatarfile",
|
||||
"description": "The base64 encode of avatarfile",
|
||||
"in": "query",
|
||||
"name": "id",
|
||||
"description": "The id of the webhook",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "formData",
|
||||
"name": "password",
|
||||
"description": "The password",
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"description": "The details of the webhook",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
"schema": {
|
||||
"$ref": "#/definitions/object.Webhook"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
@ -1152,11 +1440,11 @@
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"1671.0xc00044ab10.false": {
|
||||
"1773.0xc000093bf0.false": {
|
||||
"title": "false",
|
||||
"type": "object"
|
||||
},
|
||||
"1705.0xc00044ab40.false": {
|
||||
"1808.0xc000093c20.false": {
|
||||
"title": "false",
|
||||
"type": "object"
|
||||
},
|
||||
@ -1164,15 +1452,19 @@
|
||||
"title": "RequestForm",
|
||||
"type": "object"
|
||||
},
|
||||
"Response": {
|
||||
"title": "Response",
|
||||
"type": "object"
|
||||
},
|
||||
"controllers.Response": {
|
||||
"title": "Response",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/1671.0xc00044ab10.false"
|
||||
"$ref": "#/definitions/1773.0xc000093bf0.false"
|
||||
},
|
||||
"data2": {
|
||||
"$ref": "#/definitions/1705.0xc00044ab40.false"
|
||||
"$ref": "#/definitions/1808.0xc000093c20.false"
|
||||
},
|
||||
"msg": {
|
||||
"type": "string"
|
||||
@ -1187,10 +1479,10 @@
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/1671.0xc00044ab10.false"
|
||||
"$ref": "#/definitions/1773.0xc000093bf0.false"
|
||||
},
|
||||
"data2": {
|
||||
"$ref": "#/definitions/1705.0xc00044ab40.false"
|
||||
"$ref": "#/definitions/1808.0xc000093c20.false"
|
||||
},
|
||||
"msg": {
|
||||
"type": "string"
|
||||
@ -1200,6 +1492,10 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"emailForm": {
|
||||
"title": "emailForm",
|
||||
"type": "object"
|
||||
},
|
||||
"object.Application": {
|
||||
"title": "Application",
|
||||
"type": "object",
|
||||
@ -1265,9 +1561,15 @@
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"signinHtml": {
|
||||
"type": "string"
|
||||
},
|
||||
"signinUrl": {
|
||||
"type": "string"
|
||||
},
|
||||
"signupHtml": {
|
||||
"type": "string"
|
||||
},
|
||||
"signupItems": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
@ -1276,6 +1578,9 @@
|
||||
},
|
||||
"signupUrl": {
|
||||
"type": "string"
|
||||
},
|
||||
"termsOfUse": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
@ -1292,9 +1597,15 @@
|
||||
"displayName": {
|
||||
"type": "string"
|
||||
},
|
||||
"enableSoftDeletion": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"favicon": {
|
||||
"type": "string"
|
||||
},
|
||||
"masterPassword": {
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
@ -1322,6 +1633,9 @@
|
||||
"appId": {
|
||||
"type": "string"
|
||||
},
|
||||
"bucket": {
|
||||
"type": "string"
|
||||
},
|
||||
"category": {
|
||||
"type": "string"
|
||||
},
|
||||
@ -1340,9 +1654,18 @@
|
||||
"displayName": {
|
||||
"type": "string"
|
||||
},
|
||||
"domain": {
|
||||
"type": "string"
|
||||
},
|
||||
"endpoint": {
|
||||
"type": "string"
|
||||
},
|
||||
"host": {
|
||||
"type": "string"
|
||||
},
|
||||
"method": {
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
@ -1402,16 +1725,7 @@
|
||||
},
|
||||
"object.Records": {
|
||||
"title": "Records",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"Record": {
|
||||
"$ref": "#/definitions/util.Record"
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
}
|
||||
}
|
||||
"type": "object"
|
||||
},
|
||||
"object.SignupItem": {
|
||||
"title": "SignupItem",
|
||||
@ -1509,6 +1823,9 @@
|
||||
"avatar": {
|
||||
"type": "string"
|
||||
},
|
||||
"bio": {
|
||||
"type": "string"
|
||||
},
|
||||
"createdTime": {
|
||||
"type": "string"
|
||||
},
|
||||
@ -1530,27 +1847,51 @@
|
||||
"github": {
|
||||
"type": "string"
|
||||
},
|
||||
"gitlab": {
|
||||
"type": "string"
|
||||
},
|
||||
"google": {
|
||||
"type": "string"
|
||||
},
|
||||
"hash": {
|
||||
"type": "string"
|
||||
},
|
||||
"homepage": {
|
||||
"type": "string"
|
||||
},
|
||||
"id": {
|
||||
"type": "string"
|
||||
},
|
||||
"isAdmin": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"isDeleted": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"isForbidden": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"isGlobalAdmin": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"isOnline": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"language": {
|
||||
"type": "string"
|
||||
},
|
||||
"lark": {
|
||||
"type": "string"
|
||||
},
|
||||
"ldap": {
|
||||
"type": "string"
|
||||
},
|
||||
"linkedin": {
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
@ -1560,6 +1901,12 @@
|
||||
"password": {
|
||||
"type": "string"
|
||||
},
|
||||
"passwordSalt": {
|
||||
"type": "string"
|
||||
},
|
||||
"permanentAvatar": {
|
||||
"type": "string"
|
||||
},
|
||||
"phone": {
|
||||
"type": "string"
|
||||
},
|
||||
@ -1574,6 +1921,13 @@
|
||||
"qq": {
|
||||
"type": "string"
|
||||
},
|
||||
"ranking": {
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
},
|
||||
"region": {
|
||||
"type": "string"
|
||||
},
|
||||
"score": {
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
@ -1584,6 +1938,9 @@
|
||||
"tag": {
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"type": "string"
|
||||
},
|
||||
@ -1593,34 +1950,47 @@
|
||||
"wechat": {
|
||||
"type": "string"
|
||||
},
|
||||
"wecom": {
|
||||
"type": "string"
|
||||
},
|
||||
"weibo": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"util.Record": {
|
||||
"title": "Record",
|
||||
"object.Webhook": {
|
||||
"title": "Webhook",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"ip": {
|
||||
"contentType": {
|
||||
"type": "string"
|
||||
},
|
||||
"createdTime": {
|
||||
"type": "string"
|
||||
},
|
||||
"events": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"organization": {
|
||||
"type": "string"
|
||||
},
|
||||
"requestTime": {
|
||||
"owner": {
|
||||
"type": "string"
|
||||
},
|
||||
"requestUri": {
|
||||
"type": "string"
|
||||
},
|
||||
"urlpath": {
|
||||
"type": "string"
|
||||
},
|
||||
"username": {
|
||||
"url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"smsForm": {
|
||||
"title": "smsForm",
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user