mirror of
https://github.com/casdoor/casdoor.git
synced 2025-07-02 03:00:18 +08:00
fix: fix Swagger docs by improving comments
This commit is contained in:
@ -238,7 +238,7 @@ func (c *ApiController) Signup() {
|
|||||||
// @Param post_logout_redirect_uri query string false "post_logout_redirect_uri"
|
// @Param post_logout_redirect_uri query string false "post_logout_redirect_uri"
|
||||||
// @Param state query string false "state"
|
// @Param state query string false "state"
|
||||||
// @Success 200 {object} controllers.Response The Response object
|
// @Success 200 {object} controllers.Response The Response object
|
||||||
// @router /logout [get,post]
|
// @router /logout [post]
|
||||||
func (c *ApiController) Logout() {
|
func (c *ApiController) Logout() {
|
||||||
// https://openid.net/specs/openid-connect-rpinitiated-1_0-final.html
|
// https://openid.net/specs/openid-connect-rpinitiated-1_0-final.html
|
||||||
accessToken := c.Input().Get("id_token_hint")
|
accessToken := c.Input().Get("id_token_hint")
|
||||||
@ -454,6 +454,7 @@ func (c *ApiController) GetUserinfo2() {
|
|||||||
// @Tag Login API
|
// @Tag Login API
|
||||||
// @Title GetCaptcha
|
// @Title GetCaptcha
|
||||||
// @router /api/get-captcha [get]
|
// @router /api/get-captcha [get]
|
||||||
|
// @Success 200 {object} object.Userinfo The Response object
|
||||||
func (c *ApiController) GetCaptcha() {
|
func (c *ApiController) GetCaptcha() {
|
||||||
applicationId := c.Input().Get("applicationId")
|
applicationId := c.Input().Get("applicationId")
|
||||||
isCurrentProvider := c.Input().Get("isCurrentProvider")
|
isCurrentProvider := c.Input().Get("isCurrentProvider")
|
||||||
|
@ -887,6 +887,7 @@ func (c *ApiController) HandleSamlLogin() {
|
|||||||
// @Tag HandleOfficialAccountEvent API
|
// @Tag HandleOfficialAccountEvent API
|
||||||
// @Title HandleOfficialAccountEvent
|
// @Title HandleOfficialAccountEvent
|
||||||
// @router /api/webhook [POST]
|
// @router /api/webhook [POST]
|
||||||
|
// @Success 200 {object} object.Userinfo The Response object
|
||||||
func (c *ApiController) HandleOfficialAccountEvent() {
|
func (c *ApiController) HandleOfficialAccountEvent() {
|
||||||
respBytes, err := ioutil.ReadAll(c.Ctx.Request.Body)
|
respBytes, err := ioutil.ReadAll(c.Ctx.Request.Body)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@ -917,6 +918,7 @@ func (c *ApiController) HandleOfficialAccountEvent() {
|
|||||||
// @Tag GetWebhookEventType API
|
// @Tag GetWebhookEventType API
|
||||||
// @Title GetWebhookEventType
|
// @Title GetWebhookEventType
|
||||||
// @router /api/get-webhook-event [GET]
|
// @router /api/get-webhook-event [GET]
|
||||||
|
// @Success 200 {object} object.Userinfo The Response object
|
||||||
func (c *ApiController) GetWebhookEventType() {
|
func (c *ApiController) GetWebhookEventType() {
|
||||||
lock.Lock()
|
lock.Lock()
|
||||||
defer lock.Unlock()
|
defer lock.Unlock()
|
||||||
@ -964,6 +966,7 @@ func (c *ApiController) GetCaptchaStatus() {
|
|||||||
// @Tag Callback API
|
// @Tag Callback API
|
||||||
// @Description Get Login Error Counts
|
// @Description Get Login Error Counts
|
||||||
// @router /api/Callback [post]
|
// @router /api/Callback [post]
|
||||||
|
// @Success 200 {object} object.Userinfo The Response object
|
||||||
func (c *ApiController) Callback() {
|
func (c *ApiController) Callback() {
|
||||||
code := c.GetString("code")
|
code := c.GetString("code")
|
||||||
state := c.GetString("state")
|
state := c.GetString("state")
|
||||||
|
@ -71,7 +71,7 @@ func (c *ApiController) GetEnforcers() {
|
|||||||
// @Tag Enforcer API
|
// @Tag Enforcer API
|
||||||
// @Description get enforcer
|
// @Description get enforcer
|
||||||
// @Param id query string true "The id ( owner/name ) of enforcer"
|
// @Param id query string true "The id ( owner/name ) of enforcer"
|
||||||
// @Success 200 {object} object
|
// @Success 200 {object} object.Enforcer
|
||||||
// @router /get-enforcer [get]
|
// @router /get-enforcer [get]
|
||||||
func (c *ApiController) GetEnforcer() {
|
func (c *ApiController) GetEnforcer() {
|
||||||
id := c.Input().Get("id")
|
id := c.Input().Get("id")
|
||||||
@ -99,7 +99,7 @@ func (c *ApiController) GetEnforcer() {
|
|||||||
// @Description update enforcer
|
// @Description update enforcer
|
||||||
// @Param id query string true "The id ( owner/name ) of enforcer"
|
// @Param id query string true "The id ( owner/name ) of enforcer"
|
||||||
// @Param enforcer body object true "The enforcer object"
|
// @Param enforcer body object true "The enforcer object"
|
||||||
// @Success 200 {object} object
|
// @Success 200 {object} object.Enforcer
|
||||||
// @router /update-enforcer [post]
|
// @router /update-enforcer [post]
|
||||||
func (c *ApiController) UpdateEnforcer() {
|
func (c *ApiController) UpdateEnforcer() {
|
||||||
id := c.Input().Get("id")
|
id := c.Input().Get("id")
|
||||||
@ -120,7 +120,7 @@ func (c *ApiController) UpdateEnforcer() {
|
|||||||
// @Tag Enforcer API
|
// @Tag Enforcer API
|
||||||
// @Description add enforcer
|
// @Description add enforcer
|
||||||
// @Param enforcer body object true "The enforcer object"
|
// @Param enforcer body object true "The enforcer object"
|
||||||
// @Success 200 {object} object
|
// @Success 200 {object} object.Enforcer
|
||||||
// @router /add-enforcer [post]
|
// @router /add-enforcer [post]
|
||||||
func (c *ApiController) AddEnforcer() {
|
func (c *ApiController) AddEnforcer() {
|
||||||
enforcer := object.Enforcer{}
|
enforcer := object.Enforcer{}
|
||||||
@ -139,7 +139,7 @@ func (c *ApiController) AddEnforcer() {
|
|||||||
// @Tag Enforcer API
|
// @Tag Enforcer API
|
||||||
// @Description delete enforcer
|
// @Description delete enforcer
|
||||||
// @Param body body object.Enforce true "The enforcer object"
|
// @Param body body object.Enforce true "The enforcer object"
|
||||||
// @Success 200 {object} object
|
// @Success 200 {object} object.Enforcer
|
||||||
// @router /delete-enforcer [post]
|
// @router /delete-enforcer [post]
|
||||||
func (c *ApiController) DeleteEnforcer() {
|
func (c *ApiController) DeleteEnforcer() {
|
||||||
var enforcer object.Enforcer
|
var enforcer object.Enforcer
|
||||||
|
@ -26,8 +26,10 @@ type LinkForm struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Unlink ...
|
// Unlink ...
|
||||||
// @router /unlink [post]
|
|
||||||
// @Tag Login API
|
// @Tag Login API
|
||||||
|
// @Title Unlink
|
||||||
|
// @router /unlink [post]
|
||||||
|
// @Success 200 {object} object.Userinfo The Response object
|
||||||
func (c *ApiController) Unlink() {
|
func (c *ApiController) Unlink() {
|
||||||
user, ok := c.RequireSignedInUser()
|
user, ok := c.RequireSignedInUser()
|
||||||
if !ok {
|
if !ok {
|
||||||
|
@ -510,6 +510,7 @@ func (c *ApiController) SetPassword() {
|
|||||||
// @Title CheckUserPassword
|
// @Title CheckUserPassword
|
||||||
// @router /check-user-password [post]
|
// @router /check-user-password [post]
|
||||||
// @Tag User API
|
// @Tag User API
|
||||||
|
// @Success 200 {object} object.Userinfo The Response object
|
||||||
func (c *ApiController) CheckUserPassword() {
|
func (c *ApiController) CheckUserPassword() {
|
||||||
var user object.User
|
var user object.User
|
||||||
err := json.Unmarshal(c.Ctx.Input.RequestBody, &user)
|
err := json.Unmarshal(c.Ctx.Input.RequestBody, &user)
|
||||||
@ -580,6 +581,7 @@ func (c *ApiController) GetUserCount() {
|
|||||||
// @Title AddUserKeys
|
// @Title AddUserKeys
|
||||||
// @router /add-user-keys [post]
|
// @router /add-user-keys [post]
|
||||||
// @Tag User API
|
// @Tag User API
|
||||||
|
// @Success 200 {object} object.Userinfo The Response object
|
||||||
func (c *ApiController) AddUserKeys() {
|
func (c *ApiController) AddUserKeys() {
|
||||||
var user object.User
|
var user object.User
|
||||||
err := json.Unmarshal(c.Ctx.Input.RequestBody, &user)
|
err := json.Unmarshal(c.Ctx.Input.RequestBody, &user)
|
||||||
|
@ -39,6 +39,7 @@ const (
|
|||||||
// @Title SendVerificationCode
|
// @Title SendVerificationCode
|
||||||
// @Tag Verification API
|
// @Tag Verification API
|
||||||
// @router /send-verification-code [post]
|
// @router /send-verification-code [post]
|
||||||
|
// @Success 200 {object} object.Userinfo The Response object
|
||||||
func (c *ApiController) SendVerificationCode() {
|
func (c *ApiController) SendVerificationCode() {
|
||||||
var vform form.VerificationForm
|
var vform form.VerificationForm
|
||||||
err := c.ParseForm(&vform)
|
err := c.ParseForm(&vform)
|
||||||
@ -229,6 +230,7 @@ func (c *ApiController) SendVerificationCode() {
|
|||||||
// @Title VerifyCaptcha
|
// @Title VerifyCaptcha
|
||||||
// @Tag Verification API
|
// @Tag Verification API
|
||||||
// @router /verify-captcha [post]
|
// @router /verify-captcha [post]
|
||||||
|
// @Success 200 {object} object.Userinfo The Response object
|
||||||
func (c *ApiController) VerifyCaptcha() {
|
func (c *ApiController) VerifyCaptcha() {
|
||||||
var vform form.VerificationForm
|
var vform form.VerificationForm
|
||||||
err := c.ParseForm(&vform)
|
err := c.ParseForm(&vform)
|
||||||
@ -271,6 +273,7 @@ func (c *ApiController) VerifyCaptcha() {
|
|||||||
// @Tag Account API
|
// @Tag Account API
|
||||||
// @Title ResetEmailOrPhone
|
// @Title ResetEmailOrPhone
|
||||||
// @router /api/reset-email-or-phone [post]
|
// @router /api/reset-email-or-phone [post]
|
||||||
|
// @Success 200 {object} object.Userinfo The Response object
|
||||||
func (c *ApiController) ResetEmailOrPhone() {
|
func (c *ApiController) ResetEmailOrPhone() {
|
||||||
user, ok := c.RequireSignedInUser()
|
user, ok := c.RequireSignedInUser()
|
||||||
if !ok {
|
if !ok {
|
||||||
@ -365,6 +368,7 @@ func (c *ApiController) ResetEmailOrPhone() {
|
|||||||
// @Tag Verification API
|
// @Tag Verification API
|
||||||
// @Title VerifyCode
|
// @Title VerifyCode
|
||||||
// @router /api/verify-code [post]
|
// @router /api/verify-code [post]
|
||||||
|
// @Success 200 {object} object.Userinfo The Response object
|
||||||
func (c *ApiController) VerifyCode() {
|
func (c *ApiController) VerifyCode() {
|
||||||
var authForm form.AuthForm
|
var authForm form.AuthForm
|
||||||
err := json.Unmarshal(c.Ctx.Input.RequestBody, &authForm)
|
err := json.Unmarshal(c.Ctx.Input.RequestBody, &authForm)
|
||||||
|
@ -146,7 +146,7 @@ func (c *ApiController) WebAuthnSigninBegin() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// WebAuthnSigninFinish
|
// WebAuthnSigninFinish
|
||||||
// @Title WebAuthnSigninBegin
|
// @Title WebAuthnSigninFinish
|
||||||
// @Tag Login API
|
// @Tag Login API
|
||||||
// @Description WebAuthn Login Flow 2nd stage
|
// @Description WebAuthn Login Flow 2nd stage
|
||||||
// @Param body body protocol.CredentialAssertionResponse true "authenticator assertion Response"
|
// @Param body body protocol.CredentialAssertionResponse true "authenticator assertion Response"
|
||||||
|
File diff suppressed because it is too large
Load Diff
@ -102,7 +102,7 @@ paths:
|
|||||||
"200":
|
"200":
|
||||||
description: ""
|
description: ""
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/definitions/object'
|
$ref: '#/definitions/object.Enforcer'
|
||||||
/api/add-group:
|
/api/add-group:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
@ -283,24 +283,6 @@ paths:
|
|||||||
description: The Response object
|
description: The Response object
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/definitions/controllers.Response'
|
$ref: '#/definitions/controllers.Response'
|
||||||
/api/add-record:
|
|
||||||
post:
|
|
||||||
tags:
|
|
||||||
- Record API
|
|
||||||
description: add a record
|
|
||||||
operationId: ApiController.AddRecord
|
|
||||||
parameters:
|
|
||||||
- in: body
|
|
||||||
name: body
|
|
||||||
description: The details of the record
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
$ref: '#/definitions/object.Record'
|
|
||||||
responses:
|
|
||||||
"200":
|
|
||||||
description: The Response object
|
|
||||||
schema:
|
|
||||||
$ref: '#/definitions/controllers.Response'
|
|
||||||
/api/add-resource:
|
/api/add-resource:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
@ -436,7 +418,12 @@ paths:
|
|||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
- User API
|
- User API
|
||||||
operationId: ApiController.AddUserkeys
|
operationId: ApiController.AddUserKeys
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The Response object
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/object.Userinfo'
|
||||||
/api/add-webhook:
|
/api/add-webhook:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
@ -455,11 +442,27 @@ paths:
|
|||||||
description: The Response object
|
description: The Response object
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/definitions/controllers.Response'
|
$ref: '#/definitions/controllers.Response'
|
||||||
|
/api/api/Callback:
|
||||||
|
post:
|
||||||
|
tags:
|
||||||
|
- Callback API
|
||||||
|
description: Get Login Error Counts
|
||||||
|
operationId: ApiController.Callback
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The Response object
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/object.Userinfo'
|
||||||
/api/api/get-captcha:
|
/api/api/get-captcha:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
- Login API
|
- Login API
|
||||||
operationId: ApiController.GetCaptcha
|
operationId: ApiController.GetCaptcha
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The Response object
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/object.Userinfo'
|
||||||
/api/api/get-captcha-status:
|
/api/api/get-captcha-status:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
@ -482,11 +485,21 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- GetWebhookEventType API
|
- GetWebhookEventType API
|
||||||
operationId: ApiController.GetWebhookEventType
|
operationId: ApiController.GetWebhookEventType
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The Response object
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/object.Userinfo'
|
||||||
/api/api/reset-email-or-phone:
|
/api/api/reset-email-or-phone:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
- Account API
|
- Account API
|
||||||
operationId: ApiController.ResetEmailOrPhone
|
operationId: ApiController.ResetEmailOrPhone
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The Response object
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/object.Userinfo'
|
||||||
/api/api/send-email:
|
/api/api/send-email:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
@ -515,6 +528,24 @@ paths:
|
|||||||
description: object
|
description: object
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/definitions/Response'
|
$ref: '#/definitions/Response'
|
||||||
|
/api/api/send-notification:
|
||||||
|
post:
|
||||||
|
tags:
|
||||||
|
- Service API
|
||||||
|
description: This API is not for Casdoor frontend to call, it is for Casdoor SDKs.
|
||||||
|
operationId: ApiController.SendNotification
|
||||||
|
parameters:
|
||||||
|
- in: body
|
||||||
|
name: from
|
||||||
|
description: Details of the notification request
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/controllers.NotificationForm'
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: object
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/Response'
|
||||||
/api/api/send-sms:
|
/api/api/send-sms:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
@ -548,11 +579,21 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- Verification API
|
- Verification API
|
||||||
operationId: ApiController.VerifyCode
|
operationId: ApiController.VerifyCode
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The Response object
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/object.Userinfo'
|
||||||
/api/api/webhook:
|
/api/api/webhook:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
- HandleOfficialAccountEvent API
|
- HandleOfficialAccountEvent API
|
||||||
operationId: ApiController.HandleOfficialAccountEvent
|
operationId: ApiController.HandleOfficialAccountEvent
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The Response object
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/object.Userinfo'
|
||||||
/api/batch-enforce:
|
/api/batch-enforce:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
@ -606,6 +647,11 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- User API
|
- User API
|
||||||
operationId: ApiController.CheckUserPassword
|
operationId: ApiController.CheckUserPassword
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The Response object
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/object.Userinfo'
|
||||||
/api/delete-adapter:
|
/api/delete-adapter:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
@ -677,7 +723,7 @@ paths:
|
|||||||
"200":
|
"200":
|
||||||
description: ""
|
description: ""
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/definitions/object'
|
$ref: '#/definitions/object.Enforcer'
|
||||||
/api/delete-group:
|
/api/delete-group:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
@ -1265,7 +1311,7 @@ paths:
|
|||||||
"200":
|
"200":
|
||||||
description: ""
|
description: ""
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/definitions/object'
|
$ref: '#/definitions/object.Enforcer'
|
||||||
/api/get-enforcers:
|
/api/get-enforcers:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
@ -1285,6 +1331,19 @@ paths:
|
|||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '#/definitions/object.Enforcer'
|
$ref: '#/definitions/object.Enforcer'
|
||||||
|
/api/get-global-certs:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- Cert API
|
||||||
|
description: get globle certs
|
||||||
|
operationId: ApiController.GetGlobalCerts
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The Response object
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/definitions/object.Cert'
|
||||||
/api/get-global-providers:
|
/api/get-global-providers:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
@ -1311,19 +1370,6 @@ paths:
|
|||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '#/definitions/object.User'
|
$ref: '#/definitions/object.User'
|
||||||
/api/get-global-certs:
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- Cert API
|
|
||||||
description: get globle certs
|
|
||||||
operationId: ApiController.GetGlobalCerts
|
|
||||||
responses:
|
|
||||||
"200":
|
|
||||||
description: The Response object
|
|
||||||
schema:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: '#/definitions/object.Cert'
|
|
||||||
/api/get-group:
|
/api/get-group:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
@ -1779,47 +1825,6 @@ paths:
|
|||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '#/definitions/object.Provider'
|
$ref: '#/definitions/object.Provider'
|
||||||
/api/get-records:
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- Record API
|
|
||||||
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
|
|
||||||
schema:
|
|
||||||
$ref: '#/definitions/object.Record'
|
|
||||||
/api/get-records-filter:
|
|
||||||
post:
|
|
||||||
tags:
|
|
||||||
- Record API
|
|
||||||
description: get records by filter
|
|
||||||
operationId: ApiController.GetRecordsByFilter
|
|
||||||
parameters:
|
|
||||||
- in: body
|
|
||||||
name: filter
|
|
||||||
description: filter Record message
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
type: string
|
|
||||||
responses:
|
|
||||||
"200":
|
|
||||||
description: The Response object
|
|
||||||
schema:
|
|
||||||
$ref: '#/definitions/object.Record'
|
|
||||||
/api/get-resource:
|
/api/get-resource:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
@ -2387,46 +2392,6 @@ paths:
|
|||||||
description: The Response object
|
description: The Response object
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/definitions/controllers.Response'
|
$ref: '#/definitions/controllers.Response'
|
||||||
/api/login/oauth/access_token:
|
|
||||||
post:
|
|
||||||
tags:
|
|
||||||
- Token API
|
|
||||||
description: get OAuth access token
|
|
||||||
operationId: ApiController.GetOAuthToken
|
|
||||||
parameters:
|
|
||||||
- in: query
|
|
||||||
name: grant_type
|
|
||||||
description: OAuth grant type
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
- in: query
|
|
||||||
name: client_id
|
|
||||||
description: OAuth client id
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
- in: query
|
|
||||||
name: client_secret
|
|
||||||
description: OAuth client secret
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
- in: query
|
|
||||||
name: code
|
|
||||||
description: OAuth code
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
responses:
|
|
||||||
"200":
|
|
||||||
description: The Response object
|
|
||||||
schema:
|
|
||||||
$ref: '#/definitions/object.TokenWrapper'
|
|
||||||
"400":
|
|
||||||
description: The Response object
|
|
||||||
schema:
|
|
||||||
$ref: '#/definitions/object.TokenError'
|
|
||||||
"401":
|
|
||||||
description: The Response object
|
|
||||||
schema:
|
|
||||||
$ref: '#/definitions/object.TokenError'
|
|
||||||
/api/login/oauth/introspect:
|
/api/login/oauth/introspect:
|
||||||
post:
|
post:
|
||||||
description: The introspection endpoint is an OAuth 2.0 endpoint that takes a
|
description: The introspection endpoint is an OAuth 2.0 endpoint that takes a
|
||||||
@ -2500,29 +2465,6 @@ paths:
|
|||||||
schema:
|
schema:
|
||||||
$ref: '#/definitions/object.TokenError'
|
$ref: '#/definitions/object.TokenError'
|
||||||
/api/logout:
|
/api/logout:
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- Login API
|
|
||||||
description: logout the current user
|
|
||||||
operationId: ApiController.Logout
|
|
||||||
parameters:
|
|
||||||
- in: query
|
|
||||||
name: id_token_hint
|
|
||||||
description: id_token_hint
|
|
||||||
type: string
|
|
||||||
- in: query
|
|
||||||
name: post_logout_redirect_uri
|
|
||||||
description: post_logout_redirect_uri
|
|
||||||
type: string
|
|
||||||
- in: query
|
|
||||||
name: state
|
|
||||||
description: state
|
|
||||||
type: string
|
|
||||||
responses:
|
|
||||||
"200":
|
|
||||||
description: The Response object
|
|
||||||
schema:
|
|
||||||
$ref: '#/definitions/controllers.Response'
|
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
- Login API
|
- Login API
|
||||||
@ -2620,6 +2562,11 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- Verification API
|
- Verification API
|
||||||
operationId: ApiController.SendVerificationCode
|
operationId: ApiController.SendVerificationCode
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The Response object
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/object.Userinfo'
|
||||||
/api/set-password:
|
/api/set-password:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
@ -2706,6 +2653,12 @@ paths:
|
|||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
- Login API
|
- Login API
|
||||||
|
operationId: ApiController.Unlink
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The Response object
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/object.Userinfo'
|
||||||
/api/update-adapter:
|
/api/update-adapter:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
@ -2797,7 +2750,7 @@ paths:
|
|||||||
"200":
|
"200":
|
||||||
description: ""
|
description: ""
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/definitions/object'
|
$ref: '#/definitions/object.Enforcer'
|
||||||
/api/update-group:
|
/api/update-group:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
@ -3283,6 +3236,11 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- Verification API
|
- Verification API
|
||||||
operationId: ApiController.VerifyCaptcha
|
operationId: ApiController.VerifyCaptcha
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The Response object
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/object.Userinfo'
|
||||||
/api/webauthn/signin/begin:
|
/api/webauthn/signin/begin:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
@ -3310,7 +3268,7 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- Login API
|
- Login API
|
||||||
description: WebAuthn Login Flow 2nd stage
|
description: WebAuthn Login Flow 2nd stage
|
||||||
operationId: ApiController.WebAuthnSigninBegin
|
operationId: ApiController.WebAuthnSigninFinish
|
||||||
parameters:
|
parameters:
|
||||||
- in: body
|
- in: body
|
||||||
name: body
|
name: body
|
||||||
@ -3352,13 +3310,47 @@ paths:
|
|||||||
description: '"The Response object"'
|
description: '"The Response object"'
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/definitions/controllers.Response'
|
$ref: '#/definitions/controllers.Response'
|
||||||
|
/apiapi/login/oauth/access_token:
|
||||||
|
post:
|
||||||
|
tags:
|
||||||
|
- Token API
|
||||||
|
description: get OAuth access token
|
||||||
|
operationId: ApiController.GetOAuthToken
|
||||||
|
parameters:
|
||||||
|
- in: query
|
||||||
|
name: grant_type
|
||||||
|
description: OAuth grant type
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
- in: query
|
||||||
|
name: client_id
|
||||||
|
description: OAuth client id
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
- in: query
|
||||||
|
name: client_secret
|
||||||
|
description: OAuth client secret
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
- in: query
|
||||||
|
name: code
|
||||||
|
description: OAuth code
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The Response object
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/object.TokenWrapper'
|
||||||
|
"400":
|
||||||
|
description: The Response object
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/object.TokenError'
|
||||||
|
"401":
|
||||||
|
description: The Response object
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/object.TokenError'
|
||||||
definitions:
|
definitions:
|
||||||
1183.0xc000639290.false:
|
|
||||||
title: "false"
|
|
||||||
type: object
|
|
||||||
1217.0xc0006392c0.false:
|
|
||||||
title: "false"
|
|
||||||
type: object
|
|
||||||
LaravelResponse:
|
LaravelResponse:
|
||||||
title: LaravelResponse
|
title: LaravelResponse
|
||||||
type: object
|
type: object
|
||||||
@ -3393,14 +3385,24 @@ definitions:
|
|||||||
type: string
|
type: string
|
||||||
title:
|
title:
|
||||||
type: string
|
type: string
|
||||||
|
controllers.NotificationForm:
|
||||||
|
title: NotificationForm
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
content:
|
||||||
|
type: string
|
||||||
controllers.Response:
|
controllers.Response:
|
||||||
title: Response
|
title: Response
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
data:
|
data:
|
||||||
$ref: '#/definitions/1183.0xc000639290.false'
|
additionalProperties:
|
||||||
|
description: support string, struct or []struct
|
||||||
|
type: string
|
||||||
data2:
|
data2:
|
||||||
$ref: '#/definitions/1217.0xc0006392c0.false'
|
additionalProperties:
|
||||||
|
description: support string, struct or []struct
|
||||||
|
type: string
|
||||||
msg:
|
msg:
|
||||||
type: string
|
type: string
|
||||||
name:
|
name:
|
||||||
@ -3430,9 +3432,6 @@ definitions:
|
|||||||
object:
|
object:
|
||||||
title: object
|
title: object
|
||||||
type: object
|
type: object
|
||||||
object.&{197049 0xc000a2cd50 false}:
|
|
||||||
title: '&{197049 0xc000a2cd50 false}'
|
|
||||||
type: object
|
|
||||||
object.AccountItem:
|
object.AccountItem:
|
||||||
title: AccountItem
|
title: AccountItem
|
||||||
type: object
|
type: object
|
||||||
@ -3468,10 +3467,10 @@ definitions:
|
|||||||
format: int64
|
format: int64
|
||||||
table:
|
table:
|
||||||
type: string
|
type: string
|
||||||
tableNamePrefix:
|
|
||||||
type: string
|
|
||||||
type:
|
type:
|
||||||
type: string
|
type: string
|
||||||
|
useSameDb:
|
||||||
|
type: boolean
|
||||||
user:
|
user:
|
||||||
type: string
|
type: string
|
||||||
object.Application:
|
object.Application:
|
||||||
@ -3482,6 +3481,8 @@ definitions:
|
|||||||
type: string
|
type: string
|
||||||
cert:
|
cert:
|
||||||
type: string
|
type: string
|
||||||
|
certPublicKey:
|
||||||
|
type: string
|
||||||
clientId:
|
clientId:
|
||||||
type: string
|
type: string
|
||||||
clientSecret:
|
clientSecret:
|
||||||
@ -3500,6 +3501,8 @@ definitions:
|
|||||||
type: boolean
|
type: boolean
|
||||||
enablePassword:
|
enablePassword:
|
||||||
type: boolean
|
type: boolean
|
||||||
|
enableSamlC14n10:
|
||||||
|
type: boolean
|
||||||
enableSamlCompress:
|
enableSamlCompress:
|
||||||
type: boolean
|
type: boolean
|
||||||
enableSignUp:
|
enableSignUp:
|
||||||
@ -3530,6 +3533,10 @@ definitions:
|
|||||||
type: string
|
type: string
|
||||||
homepageUrl:
|
homepageUrl:
|
||||||
type: string
|
type: string
|
||||||
|
invitationCodes:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
logo:
|
logo:
|
||||||
type: string
|
type: string
|
||||||
name:
|
name:
|
||||||
@ -3553,6 +3560,10 @@ definitions:
|
|||||||
refreshExpireInHours:
|
refreshExpireInHours:
|
||||||
type: integer
|
type: integer
|
||||||
format: int64
|
format: int64
|
||||||
|
samlAttributes:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/definitions/object.SamlItem'
|
||||||
samlReplyUrl:
|
samlReplyUrl:
|
||||||
type: string
|
type: string
|
||||||
signinHtml:
|
signinHtml:
|
||||||
@ -3581,15 +3592,11 @@ definitions:
|
|||||||
title: CasbinRequest
|
title: CasbinRequest
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '#/definitions/object.&{197049 0xc000a2cd50 false}'
|
$ref: '#/definitions/object.CasbinRequest'
|
||||||
object.Cert:
|
object.Cert:
|
||||||
title: Cert
|
title: Cert
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
authorityPublicKey:
|
|
||||||
type: string
|
|
||||||
authorityRootPublicKey:
|
|
||||||
type: string
|
|
||||||
bitSize:
|
bitSize:
|
||||||
type: integer
|
type: integer
|
||||||
format: int64
|
format: int64
|
||||||
@ -3905,6 +3912,8 @@ definitions:
|
|||||||
type: string
|
type: string
|
||||||
defaultAvatar:
|
defaultAvatar:
|
||||||
type: string
|
type: string
|
||||||
|
defaultPassword:
|
||||||
|
type: string
|
||||||
displayName:
|
displayName:
|
||||||
type: string
|
type: string
|
||||||
enableSoftDeletion:
|
enableSoftDeletion:
|
||||||
@ -3922,6 +3931,8 @@ definitions:
|
|||||||
type: string
|
type: string
|
||||||
masterPassword:
|
masterPassword:
|
||||||
type: string
|
type: string
|
||||||
|
masterVerificationCode:
|
||||||
|
type: string
|
||||||
mfaItems:
|
mfaItems:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
@ -4011,6 +4022,8 @@ definitions:
|
|||||||
type: string
|
type: string
|
||||||
state:
|
state:
|
||||||
$ref: '#/definitions/pp.PaymentState'
|
$ref: '#/definitions/pp.PaymentState'
|
||||||
|
successUrl:
|
||||||
|
type: string
|
||||||
tag:
|
tag:
|
||||||
type: string
|
type: string
|
||||||
type:
|
type:
|
||||||
@ -4043,6 +4056,10 @@ definitions:
|
|||||||
type: string
|
type: string
|
||||||
effect:
|
effect:
|
||||||
type: string
|
type: string
|
||||||
|
groups:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
isEnabled:
|
isEnabled:
|
||||||
type: boolean
|
type: boolean
|
||||||
model:
|
model:
|
||||||
@ -4091,12 +4108,17 @@ definitions:
|
|||||||
type: string
|
type: string
|
||||||
owner:
|
owner:
|
||||||
type: string
|
type: string
|
||||||
pricePerMonth:
|
paymentProviders:
|
||||||
type: number
|
type: array
|
||||||
format: double
|
items:
|
||||||
pricePerYear:
|
type: string
|
||||||
|
period:
|
||||||
|
type: string
|
||||||
|
price:
|
||||||
type: number
|
type: number
|
||||||
format: double
|
format: double
|
||||||
|
product:
|
||||||
|
type: string
|
||||||
role:
|
role:
|
||||||
type: string
|
type: string
|
||||||
object.Pricing:
|
object.Pricing:
|
||||||
@ -4105,10 +4127,6 @@ definitions:
|
|||||||
properties:
|
properties:
|
||||||
application:
|
application:
|
||||||
type: string
|
type: string
|
||||||
approveTime:
|
|
||||||
type: string
|
|
||||||
approver:
|
|
||||||
type: string
|
|
||||||
createdTime:
|
createdTime:
|
||||||
type: string
|
type: string
|
||||||
description:
|
description:
|
||||||
@ -4125,10 +4143,6 @@ definitions:
|
|||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
state:
|
|
||||||
type: string
|
|
||||||
submitter:
|
|
||||||
type: string
|
|
||||||
trialDuration:
|
trialDuration:
|
||||||
type: integer
|
type: integer
|
||||||
format: int64
|
format: int64
|
||||||
@ -4278,8 +4292,6 @@ definitions:
|
|||||||
title: ProviderItem
|
title: ProviderItem
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
alertType:
|
|
||||||
type: string
|
|
||||||
canSignIn:
|
canSignIn:
|
||||||
type: boolean
|
type: boolean
|
||||||
canSignUp:
|
canSignUp:
|
||||||
@ -4296,36 +4308,7 @@ definitions:
|
|||||||
$ref: '#/definitions/object.Provider'
|
$ref: '#/definitions/object.Provider'
|
||||||
rule:
|
rule:
|
||||||
type: string
|
type: string
|
||||||
object.Record:
|
signupGroup:
|
||||||
title: Record
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
action:
|
|
||||||
type: string
|
|
||||||
clientIp:
|
|
||||||
type: string
|
|
||||||
createdTime:
|
|
||||||
type: string
|
|
||||||
extendedUser:
|
|
||||||
$ref: '#/definitions/object.User'
|
|
||||||
id:
|
|
||||||
type: integer
|
|
||||||
format: int64
|
|
||||||
isTriggered:
|
|
||||||
type: boolean
|
|
||||||
method:
|
|
||||||
type: string
|
|
||||||
name:
|
|
||||||
type: string
|
|
||||||
object:
|
|
||||||
type: string
|
|
||||||
organization:
|
|
||||||
type: string
|
|
||||||
owner:
|
|
||||||
type: string
|
|
||||||
requestUri:
|
|
||||||
type: string
|
|
||||||
user:
|
|
||||||
type: string
|
type: string
|
||||||
object.Resource:
|
object.Resource:
|
||||||
title: Resource
|
title: Resource
|
||||||
@ -4374,6 +4357,10 @@ definitions:
|
|||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
|
groups:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
isEnabled:
|
isEnabled:
|
||||||
type: boolean
|
type: boolean
|
||||||
name:
|
name:
|
||||||
@ -4388,12 +4375,26 @@ definitions:
|
|||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
|
object.SamlItem:
|
||||||
|
title: SamlItem
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
nameformat:
|
||||||
|
type: string
|
||||||
|
value:
|
||||||
|
type: string
|
||||||
object.SignupItem:
|
object.SignupItem:
|
||||||
title: SignupItem
|
title: SignupItem
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
label:
|
||||||
|
type: string
|
||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
|
placeholder:
|
||||||
|
type: string
|
||||||
prompted:
|
prompted:
|
||||||
type: boolean
|
type: boolean
|
||||||
required:
|
required:
|
||||||
@ -4406,39 +4407,45 @@ definitions:
|
|||||||
title: Subscription
|
title: Subscription
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
approveTime:
|
|
||||||
type: string
|
|
||||||
approver:
|
|
||||||
type: string
|
|
||||||
createdTime:
|
createdTime:
|
||||||
type: string
|
type: string
|
||||||
description:
|
description:
|
||||||
type: string
|
type: string
|
||||||
displayName:
|
displayName:
|
||||||
type: string
|
type: string
|
||||||
duration:
|
endTime:
|
||||||
type: integer
|
|
||||||
format: int64
|
|
||||||
endDate:
|
|
||||||
type: string
|
type: string
|
||||||
format: datetime
|
format: datetime
|
||||||
isEnabled:
|
|
||||||
type: boolean
|
|
||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
owner:
|
owner:
|
||||||
type: string
|
type: string
|
||||||
|
payment:
|
||||||
|
type: string
|
||||||
|
period:
|
||||||
|
type: string
|
||||||
plan:
|
plan:
|
||||||
type: string
|
type: string
|
||||||
startDate:
|
pricing:
|
||||||
|
type: string
|
||||||
|
startTime:
|
||||||
type: string
|
type: string
|
||||||
format: datetime
|
format: datetime
|
||||||
state:
|
state:
|
||||||
type: string
|
$ref: '#/definitions/object.SubscriptionState'
|
||||||
submitter:
|
|
||||||
type: string
|
|
||||||
user:
|
user:
|
||||||
type: string
|
type: string
|
||||||
|
object.SubscriptionState:
|
||||||
|
title: SubscriptionState
|
||||||
|
type: string
|
||||||
|
enum:
|
||||||
|
- SubStatePending = "Pending"
|
||||||
|
- SubStateError = "Error"
|
||||||
|
- SubStateSuspended = "Suspended"
|
||||||
|
- SubStateActive = "Active"
|
||||||
|
- SubStateUpcoming = "Upcoming"
|
||||||
|
- SubStateExpired = "Expired"
|
||||||
|
example: Pending
|
||||||
object.Syncer:
|
object.Syncer:
|
||||||
title: Syncer
|
title: Syncer
|
||||||
type: object
|
type: object
|
||||||
@ -4472,6 +4479,8 @@ definitions:
|
|||||||
port:
|
port:
|
||||||
type: integer
|
type: integer
|
||||||
format: int64
|
format: int64
|
||||||
|
sslMode:
|
||||||
|
type: string
|
||||||
syncInterval:
|
syncInterval:
|
||||||
type: integer
|
type: integer
|
||||||
format: int64
|
format: int64
|
||||||
@ -4524,6 +4533,8 @@ definitions:
|
|||||||
properties:
|
properties:
|
||||||
accessToken:
|
accessToken:
|
||||||
type: string
|
type: string
|
||||||
|
accessTokenHash:
|
||||||
|
type: string
|
||||||
application:
|
application:
|
||||||
type: string
|
type: string
|
||||||
code:
|
code:
|
||||||
@ -4548,6 +4559,8 @@ definitions:
|
|||||||
type: string
|
type: string
|
||||||
refreshToken:
|
refreshToken:
|
||||||
type: string
|
type: string
|
||||||
|
refreshTokenHash:
|
||||||
|
type: string
|
||||||
scope:
|
scope:
|
||||||
type: string
|
type: string
|
||||||
tokenType:
|
tokenType:
|
||||||
@ -4609,6 +4622,8 @@ definitions:
|
|||||||
type: string
|
type: string
|
||||||
azuread:
|
azuread:
|
||||||
type: string
|
type: string
|
||||||
|
azureadb2c:
|
||||||
|
type: string
|
||||||
baidu:
|
baidu:
|
||||||
type: string
|
type: string
|
||||||
battlenet:
|
battlenet:
|
||||||
@ -4659,6 +4674,8 @@ definitions:
|
|||||||
type: boolean
|
type: boolean
|
||||||
eveonline:
|
eveonline:
|
||||||
type: string
|
type: string
|
||||||
|
externalId:
|
||||||
|
type: string
|
||||||
facebook:
|
facebook:
|
||||||
type: string
|
type: string
|
||||||
firstName:
|
firstName:
|
||||||
@ -4894,6 +4911,8 @@ definitions:
|
|||||||
type: string
|
type: string
|
||||||
email:
|
email:
|
||||||
type: string
|
type: string
|
||||||
|
email_verified:
|
||||||
|
type: boolean
|
||||||
groups:
|
groups:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
|
Reference in New Issue
Block a user