fix: fix Swagger docs page (#2025)

Signed-off-by: baihhh <2542274498@qq.com>
This commit is contained in:
Baihhh 2023-06-30 00:48:39 +08:00 committed by GitHub
parent 807aea5ec7
commit 91cb5f393a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 744 additions and 94 deletions

View File

@ -247,7 +247,7 @@ func isProxyProviderType(providerType string) bool {
// @Param code_challenge_method query string false code_challenge_method // @Param code_challenge_method query string false code_challenge_method
// @Param code_challenge query string false code_challenge // @Param code_challenge query string false code_challenge
// @Param form body controllers.AuthForm true "Login information" // @Param form body controllers.AuthForm true "Login information"
// @Success 200 {object} Response The Response object // @Success 200 {object} controllers.Response The Response object
// @router /login [post] // @router /login [post]
func (c *ApiController) Login() { func (c *ApiController) Login() {
resp := &Response{} resp := &Response{}

View File

@ -28,7 +28,7 @@ import (
// @param owner form string true "owner of user" // @param owner form string true "owner of user"
// @param name form string true "name of user" // @param name form string true "name of user"
// @param type form string true "MFA auth type" // @param type form string true "MFA auth type"
// @Success 200 {object} The Response object // @Success 200 {object} controllers.Response The Response object
// @router /mfa/setup/initiate [post] // @router /mfa/setup/initiate [post]
func (c *ApiController) MfaSetupInitiate() { func (c *ApiController) MfaSetupInitiate() {
owner := c.Ctx.Request.Form.Get("owner") owner := c.Ctx.Request.Form.Get("owner")

View File

@ -71,7 +71,7 @@ func (c *ApiController) GetPricings() {
// @Tag Pricing API // @Tag Pricing API
// @Description get pricing // @Description get pricing
// @Param id query string true "The id ( owner/name ) of the pricing" // @Param id query string true "The id ( owner/name ) of the pricing"
// @Success 200 {object} object.pricing The Response object // @Success 200 {object} object.Pricing The Response object
// @router /get-pricing [get] // @router /get-pricing [get]
func (c *ApiController) GetPricing() { func (c *ApiController) GetPricing() {
id := c.Input().Get("id") id := c.Input().Get("id")

View File

@ -71,7 +71,7 @@ func (c *ApiController) GetSubscriptions() {
// @Tag Subscription API // @Tag Subscription API
// @Description get subscription // @Description get subscription
// @Param id query string true "The id ( owner/name ) of the subscription" // @Param id query string true "The id ( owner/name ) of the subscription"
// @Success 200 {object} object.subscription The Response object // @Success 200 {object} object.Subscription The Response object
// @router /get-subscription [get] // @router /get-subscription [get]
func (c *ApiController) GetSubscription() { func (c *ApiController) GetSubscription() {
id := c.Input().Get("id") id := c.Input().Get("id")

View File

@ -66,7 +66,7 @@ func (c *ApiController) WebAuthnSignupBegin() {
// @Tag User API // @Tag User API
// @Description WebAuthn Registration Flow 2nd stage // @Description WebAuthn Registration Flow 2nd stage
// @Param body body protocol.CredentialCreationResponse true "authenticator attestation Response" // @Param body body protocol.CredentialCreationResponse true "authenticator attestation Response"
// @Success 200 {object} Response "The Response object" // @Success 200 {object} controllers.Response "The Response object"
// @router /webauthn/signup/finish [post] // @router /webauthn/signup/finish [post]
func (c *ApiController) WebAuthnSignupFinish() { func (c *ApiController) WebAuthnSignupFinish() {
webauthnObj, err := object.GetWebAuthnObject(c.Ctx.Request.Host) webauthnObj, err := object.GetWebAuthnObject(c.Ctx.Request.Host)
@ -150,7 +150,7 @@ func (c *ApiController) WebAuthnSigninBegin() {
// @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"
// @Success 200 {object} Response "The Response object" // @Success 200 {object} controllers.Response "The Response object"
// @router /webauthn/signin/finish [post] // @router /webauthn/signin/finish [post]
func (c *ApiController) WebAuthnSigninFinish() { func (c *ApiController) WebAuthnSigninFinish() {
responseType := c.Input().Get("responseType") responseType := c.Input().Get("responseType")

View File

@ -43,6 +43,34 @@
} }
} }
}, },
"/api/add-adapter": {
"post": {
"tags": [
"Adapter API"
],
"description": "add adapter",
"operationId": "ApiController.AddCasbinAdapter",
"parameters": [
{
"in": "body",
"name": "body",
"description": "The details of the adapter",
"required": true,
"schema": {
"$ref": "#/definitions/object.Adapter"
}
}
],
"responses": {
"200": {
"description": "The Response object",
"schema": {
"$ref": "#/definitions/controllers.Response"
}
}
}
}
},
"/api/add-application": { "/api/add-application": {
"post": { "post": {
"tags": [ "tags": [
@ -127,6 +155,34 @@
} }
} }
}, },
"/api/add-group": {
"post": {
"tags": [
"Group API"
],
"description": "add group",
"operationId": "ApiController.AddGroup",
"parameters": [
{
"in": "body",
"name": "body",
"description": "The details of the group",
"required": true,
"schema": {
"$ref": "#/definitions/object.Group"
}
}
],
"responses": {
"200": {
"description": "The Response object",
"schema": {
"$ref": "#/definitions/controllers.Response"
}
}
}
}
},
"/api/add-ldap": { "/api/add-ldap": {
"post": { "post": {
"tags": [ "tags": [
@ -599,6 +655,14 @@
} }
} }
}, },
"/api/add-user-keys": {
"post": {
"tags": [
"User API"
],
"operationId": "ApiController.AddUserkeys"
}
},
"/api/add-webhook": { "/api/add-webhook": {
"post": { "post": {
"tags": [ "tags": [
@ -782,13 +846,13 @@
"tags": [ "tags": [
"Enforce API" "Enforce API"
], ],
"description": "perform enforce", "description": "Call Casbin BatchEnforce API",
"operationId": "ApiController.BatchEnforce", "operationId": "ApiController.BatchEnforce",
"parameters": [ "parameters": [
{ {
"in": "body", "in": "body",
"name": "body", "name": "body",
"description": "casbin request array", "description": "array of casbin requests",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/object.CasbinRequest" "$ref": "#/definitions/object.CasbinRequest"
@ -858,6 +922,34 @@
"operationId": "ApiController.CheckUserPassword" "operationId": "ApiController.CheckUserPassword"
} }
}, },
"/api/delete-adapter": {
"post": {
"tags": [
"Adapter API"
],
"description": "delete adapter",
"operationId": "ApiController.DeleteCasbinAdapter",
"parameters": [
{
"in": "body",
"name": "body",
"description": "The details of the adapter",
"required": true,
"schema": {
"$ref": "#/definitions/object.Adapter"
}
}
],
"responses": {
"200": {
"description": "The Response object",
"schema": {
"$ref": "#/definitions/controllers.Response"
}
}
}
}
},
"/api/delete-application": { "/api/delete-application": {
"post": { "post": {
"tags": [ "tags": [
@ -942,6 +1034,34 @@
} }
} }
}, },
"/api/delete-group": {
"post": {
"tags": [
"Group API"
],
"description": "delete group",
"operationId": "ApiController.DeleteGroup",
"parameters": [
{
"in": "body",
"name": "body",
"description": "The details of the group",
"required": true,
"schema": {
"$ref": "#/definitions/object.Group"
}
}
],
"responses": {
"200": {
"description": "The Response object",
"schema": {
"$ref": "#/definitions/controllers.Response"
}
}
}
}
},
"/api/delete-ldap": { "/api/delete-ldap": {
"post": { "post": {
"tags": [ "tags": [
@ -1429,13 +1549,13 @@
"tags": [ "tags": [
"Enforce API" "Enforce API"
], ],
"description": "perform enforce", "description": "Call Casbin Enforce API",
"operationId": "ApiController.Enforce", "operationId": "ApiController.Enforce",
"parameters": [ "parameters": [
{ {
"in": "body", "in": "body",
"name": "body", "name": "body",
"description": "casbin request", "description": "Casbin request",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/object.CasbinRequest" "$ref": "#/definitions/object.CasbinRequest"
@ -1487,6 +1607,61 @@
} }
} }
}, },
"/api/get-adapter": {
"get": {
"tags": [
"Adapter API"
],
"description": "get adapter",
"operationId": "ApiController.GetCasbinAdapter",
"parameters": [
{
"in": "query",
"name": "id",
"description": "The id ( owner/name ) of the adapter",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The Response object",
"schema": {
"$ref": "#/definitions/object.Adapter"
}
}
}
}
},
"/api/get-adapters": {
"get": {
"tags": [
"Adapter API"
],
"description": "get adapters",
"operationId": "ApiController.GetCasbinAdapters",
"parameters": [
{
"in": "query",
"name": "owner",
"description": "The owner of adapters",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The Response object",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/object.Adapter"
}
}
}
}
}
},
"/api/get-app-login": { "/api/get-app-login": {
"get": { "get": {
"tags": [ "tags": [
@ -1825,6 +2000,61 @@
} }
} }
}, },
"/api/get-group": {
"get": {
"tags": [
"Group API"
],
"description": "get group",
"operationId": "ApiController.GetGroup",
"parameters": [
{
"in": "query",
"name": "id",
"description": "The id ( owner/name ) of the group",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The Response object",
"schema": {
"$ref": "#/definitions/object.Group"
}
}
}
}
},
"/api/get-groups": {
"get": {
"tags": [
"Group API"
],
"description": "get groups",
"operationId": "ApiController.GetGroups",
"parameters": [
{
"in": "query",
"name": "owner",
"description": "The owner of groups",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The Response object",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/object.Group"
}
}
}
}
}
},
"/api/get-ldap": { "/api/get-ldap": {
"get": { "get": {
"tags": [ "tags": [
@ -2045,7 +2275,7 @@
"tags": [ "tags": [
"Organization API" "Organization API"
], ],
"description": "get all organization names", "description": "get all organization name and displayName",
"operationId": "ApiController.GetOrganizationNames", "operationId": "ApiController.GetOrganizationNames",
"parameters": [ "parameters": [
{ {
@ -2338,7 +2568,7 @@
"200": { "200": {
"description": "The Response object", "description": "The Response object",
"schema": { "schema": {
"$ref": "#/definitions/object.pricing" "$ref": "#/definitions/object.Pricing"
} }
} }
} }
@ -2753,7 +2983,7 @@
"200": { "200": {
"description": "The Response object", "description": "The Response object",
"schema": { "schema": {
"$ref": "#/definitions/object.subscription" "$ref": "#/definitions/object.Subscription"
} }
} }
} }
@ -3328,7 +3558,7 @@
"200": { "200": {
"description": "The Response object", "description": "The Response object",
"schema": { "schema": {
"$ref": "#/definitions/Response" "$ref": "#/definitions/controllers.Response"
} }
} }
} }
@ -3598,9 +3828,9 @@
"operationId": "ApiController.MfaSetupInitiate", "operationId": "ApiController.MfaSetupInitiate",
"responses": { "responses": {
"200": { "200": {
"description": "Response object", "description": "The Response object",
"schema": { "schema": {
"$ref": "#/definitions/The" "$ref": "#/definitions/controllers.Response"
} }
} }
} }
@ -3799,6 +4029,41 @@
] ]
} }
}, },
"/api/update-adapter": {
"post": {
"tags": [
"Adapter API"
],
"description": "update adapter",
"operationId": "ApiController.UpdateCasbinAdapter",
"parameters": [
{
"in": "query",
"name": "id",
"description": "The id ( owner/name ) of the adapter",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "The details of the adapter",
"required": true,
"schema": {
"$ref": "#/definitions/object.Adapter"
}
}
],
"responses": {
"200": {
"description": "The Response object",
"schema": {
"$ref": "#/definitions/controllers.Response"
}
}
}
}
},
"/api/update-application": { "/api/update-application": {
"post": { "post": {
"tags": [ "tags": [
@ -3904,6 +4169,41 @@
} }
} }
}, },
"/api/update-group": {
"post": {
"tags": [
"Group API"
],
"description": "update group",
"operationId": "ApiController.UpdateGroup",
"parameters": [
{
"in": "query",
"name": "id",
"description": "The id ( owner/name ) of the group",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"description": "The details of the group",
"required": true,
"schema": {
"$ref": "#/definitions/object.Group"
}
}
],
"responses": {
"200": {
"description": "The Response object",
"schema": {
"$ref": "#/definitions/controllers.Response"
}
}
}
}
},
"/api/update-ldap": { "/api/update-ldap": {
"post": { "post": {
"tags": [ "tags": [
@ -4579,7 +4879,7 @@
"200": { "200": {
"description": "\"The Response object\"", "description": "\"The Response object\"",
"schema": { "schema": {
"$ref": "#/definitions/Response" "$ref": "#/definitions/controllers.Response"
} }
} }
} }
@ -4624,7 +4924,7 @@
"200": { "200": {
"description": "\"The Response object\"", "description": "\"The Response object\"",
"schema": { "schema": {
"$ref": "#/definitions/Response" "$ref": "#/definitions/controllers.Response"
} }
} }
} }
@ -4632,14 +4932,6 @@
} }
}, },
"definitions": { "definitions": {
"1225.0xc0002e2ae0.false": {
"title": "false",
"type": "object"
},
"1260.0xc0002e2b10.false": {
"title": "false",
"type": "object"
},
"LaravelResponse": { "LaravelResponse": {
"title": "LaravelResponse", "title": "LaravelResponse",
"type": "object" "type": "object"
@ -4648,10 +4940,6 @@
"title": "Response", "title": "Response",
"type": "object" "type": "object"
}, },
"The": {
"title": "The",
"type": "object"
},
"controllers.AuthForm": { "controllers.AuthForm": {
"title": "AuthForm", "title": "AuthForm",
"type": "object" "type": "object"
@ -4685,10 +4973,16 @@
"type": "object", "type": "object",
"properties": { "properties": {
"data": { "data": {
"$ref": "#/definitions/1225.0xc0002e2ae0.false" "additionalProperties": {
"description": "support string | class | List\u003cclass\u003e and os on",
"type": "string"
}
}, },
"data2": { "data2": {
"$ref": "#/definitions/1260.0xc0002e2b10.false" "additionalProperties": {
"description": "support string | class | List\u003cclass\u003e and os on",
"type": "string"
}
}, },
"msg": { "msg": {
"type": "string" "type": "string"
@ -4726,8 +5020,8 @@
"title": "JSONWebKey", "title": "JSONWebKey",
"type": "object" "type": "object"
}, },
"object.\u0026{179844 0xc000a02f90 false}": { "object": {
"title": "\u0026{179844 0xc000a02f90 false}", "title": "object",
"type": "object" "type": "object"
}, },
"object.AccountItem": { "object.AccountItem": {
@ -4917,7 +5211,7 @@
"title": "CasbinRequest", "title": "CasbinRequest",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/object.\u0026{179844 0xc000a02f90 false}" "$ref": "#/definitions/object.CasbinRequest"
} }
}, },
"object.Cert": { "object.Cert": {
@ -5029,6 +5323,63 @@
} }
} }
}, },
"object.Group": {
"title": "Group",
"type": "object",
"properties": {
"children": {
"type": "array",
"items": {
"$ref": "#/definitions/object.Group"
}
},
"contactEmail": {
"type": "string"
},
"createdTime": {
"type": "string"
},
"displayName": {
"type": "string"
},
"isEnabled": {
"type": "boolean"
},
"isTopGroup": {
"type": "boolean"
},
"key": {
"type": "string"
},
"manager": {
"type": "string"
},
"name": {
"type": "string"
},
"owner": {
"type": "string"
},
"parentId": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"updatedTime": {
"type": "string"
},
"users": {
"type": "array",
"items": {
"$ref": "#/definitions/object.User"
}
}
}
},
"object.Header": { "object.Header": {
"title": "Header", "title": "Header",
"type": "object", "type": "object",
@ -5175,12 +5526,15 @@
"countryCode": { "countryCode": {
"type": "string" "type": "string"
}, },
"id": { "enabled": {
"type": "string" "type": "boolean"
}, },
"isPreferred": { "isPreferred": {
"type": "boolean" "type": "boolean"
}, },
"mfaType": {
"type": "string"
},
"recoveryCodes": { "recoveryCodes": {
"type": "array", "type": "array",
"items": { "items": {
@ -5190,9 +5544,6 @@
"secret": { "secret": {
"type": "string" "type": "string"
}, },
"type": {
"type": "string"
},
"url": { "url": {
"type": "string" "type": "string"
} }
@ -5205,6 +5556,9 @@
"createdTime": { "createdTime": {
"type": "string" "type": "string"
}, },
"description": {
"type": "string"
},
"displayName": { "displayName": {
"type": "string" "type": "string"
}, },
@ -5362,6 +5716,12 @@
"owner": { "owner": {
"type": "string" "type": "string"
}, },
"passwordOptions": {
"type": "array",
"items": {
"type": "string"
}
},
"passwordSalt": { "passwordSalt": {
"type": "string" "type": "string"
}, },
@ -5492,6 +5852,9 @@
"createdTime": { "createdTime": {
"type": "string" "type": "string"
}, },
"description": {
"type": "string"
},
"displayName": { "displayName": {
"type": "string" "type": "string"
}, },
@ -5611,9 +5974,6 @@
"displayName": { "displayName": {
"type": "string" "type": "string"
}, },
"hasTrial": {
"type": "boolean"
},
"isEnabled": { "isEnabled": {
"type": "boolean" "type": "boolean"
}, },
@ -5933,6 +6293,9 @@
"createdTime": { "createdTime": {
"type": "string" "type": "string"
}, },
"description": {
"type": "string"
},
"displayName": { "displayName": {
"type": "string" "type": "string"
}, },
@ -6068,6 +6431,9 @@
"isEnabled": { "isEnabled": {
"type": "boolean" "type": "boolean"
}, },
"isReadOnly": {
"type": "boolean"
},
"name": { "name": {
"type": "string" "type": "string"
}, },
@ -6248,6 +6614,12 @@
"title": "User", "title": "User",
"type": "object", "type": "object",
"properties": { "properties": {
"accessKey": {
"type": "string"
},
"accessSecret": {
"type": "string"
},
"address": { "address": {
"type": "array", "type": "array",
"items": { "items": {
@ -6275,6 +6647,9 @@
"avatar": { "avatar": {
"type": "string" "type": "string"
}, },
"avatarType": {
"type": "string"
},
"azuread": { "azuread": {
"type": "string" "type": "string"
}, },
@ -6380,6 +6755,12 @@
"google": { "google": {
"type": "string" "type": "string"
}, },
"groups": {
"type": "array",
"items": {
"type": "string"
}
},
"hash": { "hash": {
"type": "string" "type": "string"
}, },
@ -6480,6 +6861,12 @@
"meetup": { "meetup": {
"type": "string" "type": "string"
}, },
"mfaEmailEnabled": {
"type": "boolean"
},
"mfaPhoneEnabled": {
"type": "boolean"
},
"microsoftonline": { "microsoftonline": {
"type": "string" "type": "string"
}, },
@ -6540,6 +6927,9 @@
"preHash": { "preHash": {
"type": "string" "type": "string"
}, },
"preferredMfaType": {
"type": "string"
},
"properties": { "properties": {
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
@ -6552,6 +6942,12 @@
"type": "integer", "type": "integer",
"format": "int64" "format": "int64"
}, },
"recoveryCodes": {
"type": "array",
"items": {
"type": "string"
}
},
"region": { "region": {
"type": "string" "type": "string"
}, },
@ -6605,6 +7001,9 @@
"title": { "title": {
"type": "string" "type": "string"
}, },
"totpSecret": {
"type": "string"
},
"tumblr": { "tumblr": {
"type": "string" "type": "string"
}, },
@ -6677,15 +7076,18 @@
"email": { "email": {
"type": "string" "type": "string"
}, },
"groups": {
"type": "array",
"items": {
"type": "string"
}
},
"iss": { "iss": {
"type": "string" "type": "string"
}, },
"name": { "name": {
"type": "string" "type": "string"
}, },
"organization": {
"type": "string"
},
"phone": { "phone": {
"type": "string" "type": "string"
}, },
@ -6745,14 +7147,6 @@
} }
} }
}, },
"object.pricing": {
"title": "pricing",
"type": "object"
},
"object.subscription": {
"title": "subscription",
"type": "object"
},
"protocol.CredentialAssertion": { "protocol.CredentialAssertion": {
"title": "CredentialAssertion", "title": "CredentialAssertion",
"type": "object" "type": "object"

View File

@ -28,6 +28,24 @@ paths:
description: "" description: ""
schema: schema:
$ref: '#/definitions/object.OidcDiscovery' $ref: '#/definitions/object.OidcDiscovery'
/api/add-adapter:
post:
tags:
- Adapter API
description: add adapter
operationId: ApiController.AddCasbinAdapter
parameters:
- in: body
name: body
description: The details of the adapter
required: true
schema:
$ref: '#/definitions/object.Adapter'
responses:
"200":
description: The Response object
schema:
$ref: '#/definitions/controllers.Response'
/api/add-application: /api/add-application:
post: post:
tags: tags:
@ -82,6 +100,24 @@ paths:
description: The Response object description: The Response object
schema: schema:
$ref: '#/definitions/controllers.Response' $ref: '#/definitions/controllers.Response'
/api/add-group:
post:
tags:
- Group API
description: add group
operationId: ApiController.AddGroup
parameters:
- in: body
name: body
description: The details of the group
required: true
schema:
$ref: '#/definitions/object.Group'
responses:
"200":
description: The Response object
schema:
$ref: '#/definitions/controllers.Response'
/api/add-ldap: /api/add-ldap:
post: post:
tags: tags:
@ -386,6 +422,11 @@ paths:
description: The Response object description: The Response object
schema: schema:
$ref: '#/definitions/controllers.Response' $ref: '#/definitions/controllers.Response'
/api/add-user-keys:
post:
tags:
- User API
operationId: ApiController.AddUserkeys
/api/add-webhook: /api/add-webhook:
post: post:
tags: tags:
@ -506,12 +547,12 @@ paths:
post: post:
tags: tags:
- Enforce API - Enforce API
description: perform enforce description: Call Casbin BatchEnforce API
operationId: ApiController.BatchEnforce operationId: ApiController.BatchEnforce
parameters: parameters:
- in: body - in: body
name: body name: body
description: casbin request array description: array of casbin requests
required: true required: true
schema: schema:
$ref: '#/definitions/object.CasbinRequest' $ref: '#/definitions/object.CasbinRequest'
@ -555,6 +596,24 @@ paths:
tags: tags:
- User API - User API
operationId: ApiController.CheckUserPassword operationId: ApiController.CheckUserPassword
/api/delete-adapter:
post:
tags:
- Adapter API
description: delete adapter
operationId: ApiController.DeleteCasbinAdapter
parameters:
- in: body
name: body
description: The details of the adapter
required: true
schema:
$ref: '#/definitions/object.Adapter'
responses:
"200":
description: The Response object
schema:
$ref: '#/definitions/controllers.Response'
/api/delete-application: /api/delete-application:
post: post:
tags: tags:
@ -609,6 +668,24 @@ paths:
description: The Response object description: The Response object
schema: schema:
$ref: '#/definitions/controllers.Response' $ref: '#/definitions/controllers.Response'
/api/delete-group:
post:
tags:
- Group API
description: delete group
operationId: ApiController.DeleteGroup
parameters:
- in: body
name: body
description: The details of the group
required: true
schema:
$ref: '#/definitions/object.Group'
responses:
"200":
description: The Response object
schema:
$ref: '#/definitions/controllers.Response'
/api/delete-ldap: /api/delete-ldap:
post: post:
tags: tags:
@ -923,12 +1000,12 @@ paths:
post: post:
tags: tags:
- Enforce API - Enforce API
description: perform enforce description: Call Casbin Enforce API
operationId: ApiController.Enforce operationId: ApiController.Enforce
parameters: parameters:
- in: body - in: body
name: body name: body
description: casbin request description: Casbin request
required: true required: true
schema: schema:
$ref: '#/definitions/object.CasbinRequest' $ref: '#/definitions/object.CasbinRequest'
@ -960,6 +1037,42 @@ paths:
description: The Response object description: The Response object
schema: schema:
$ref: '#/definitions/controllers.Response' $ref: '#/definitions/controllers.Response'
/api/get-adapter:
get:
tags:
- Adapter API
description: get adapter
operationId: ApiController.GetCasbinAdapter
parameters:
- in: query
name: id
description: The id ( owner/name ) of the adapter
required: true
type: string
responses:
"200":
description: The Response object
schema:
$ref: '#/definitions/object.Adapter'
/api/get-adapters:
get:
tags:
- Adapter API
description: get adapters
operationId: ApiController.GetCasbinAdapters
parameters:
- in: query
name: owner
description: The owner of adapters
required: true
type: string
responses:
"200":
description: The Response object
schema:
type: array
items:
$ref: '#/definitions/object.Adapter'
/api/get-app-login: /api/get-app-login:
get: get:
tags: tags:
@ -1183,6 +1296,42 @@ paths:
type: array type: array
items: items:
$ref: '#/definitions/object.Cert' $ref: '#/definitions/object.Cert'
/api/get-group:
get:
tags:
- Group API
description: get group
operationId: ApiController.GetGroup
parameters:
- in: query
name: id
description: The id ( owner/name ) of the group
required: true
type: string
responses:
"200":
description: The Response object
schema:
$ref: '#/definitions/object.Group'
/api/get-groups:
get:
tags:
- Group API
description: get groups
operationId: ApiController.GetGroups
parameters:
- in: query
name: owner
description: The owner of groups
required: true
type: string
responses:
"200":
description: The Response object
schema:
type: array
items:
$ref: '#/definitions/object.Group'
/api/get-ldap: /api/get-ldap:
get: get:
tags: tags:
@ -1327,7 +1476,7 @@ paths:
get: get:
tags: tags:
- Organization API - Organization API
description: get all organization names description: get all organization name and displayName
operationId: ApiController.GetOrganizationNames operationId: ApiController.GetOrganizationNames
parameters: parameters:
- in: query - in: query
@ -1521,7 +1670,7 @@ paths:
"200": "200":
description: The Response object description: The Response object
schema: schema:
$ref: '#/definitions/object.pricing' $ref: '#/definitions/object.Pricing'
/api/get-pricings: /api/get-pricings:
get: get:
tags: tags:
@ -1793,7 +1942,7 @@ paths:
"200": "200":
description: The Response object description: The Response object
schema: schema:
$ref: '#/definitions/object.subscription' $ref: '#/definitions/object.Subscription'
/api/get-subscriptions: /api/get-subscriptions:
get: get:
tags: tags:
@ -2172,7 +2321,7 @@ paths:
"200": "200":
description: The Response object description: The Response object
schema: schema:
$ref: '#/definitions/Response' $ref: '#/definitions/controllers.Response'
/api/login/oauth/access_token: /api/login/oauth/access_token:
post: post:
tags: tags:
@ -2351,9 +2500,9 @@ paths:
operationId: ApiController.MfaSetupInitiate operationId: ApiController.MfaSetupInitiate
responses: responses:
"200": "200":
description: Response object description: The Response object
schema: schema:
$ref: '#/definitions/The' $ref: '#/definitions/controllers.Response'
/api/mfa/setup/verify: /api/mfa/setup/verify:
post: post:
tags: tags:
@ -2480,6 +2629,29 @@ paths:
post: post:
tags: tags:
- Login API - Login API
/api/update-adapter:
post:
tags:
- Adapter API
description: update adapter
operationId: ApiController.UpdateCasbinAdapter
parameters:
- in: query
name: id
description: The id ( owner/name ) of the adapter
required: true
type: string
- in: body
name: body
description: The details of the adapter
required: true
schema:
$ref: '#/definitions/object.Adapter'
responses:
"200":
description: The Response object
schema:
$ref: '#/definitions/controllers.Response'
/api/update-application: /api/update-application:
post: post:
tags: tags:
@ -2549,6 +2721,29 @@ paths:
description: The Response object description: The Response object
schema: schema:
$ref: '#/definitions/controllers.Response' $ref: '#/definitions/controllers.Response'
/api/update-group:
post:
tags:
- Group API
description: update group
operationId: ApiController.UpdateGroup
parameters:
- in: query
name: id
description: The id ( owner/name ) of the group
required: true
type: string
- in: body
name: body
description: The details of the group
required: true
schema:
$ref: '#/definitions/object.Group'
responses:
"200":
description: The Response object
schema:
$ref: '#/definitions/controllers.Response'
/api/update-ldap: /api/update-ldap:
post: post:
tags: tags:
@ -2994,7 +3189,7 @@ paths:
"200": "200":
description: '"The Response object"' description: '"The Response object"'
schema: schema:
$ref: '#/definitions/Response' $ref: '#/definitions/controllers.Response'
/api/webauthn/signup/begin: /api/webauthn/signup/begin:
get: get:
tags: tags:
@ -3023,23 +3218,14 @@ paths:
"200": "200":
description: '"The Response object"' description: '"The Response object"'
schema: schema:
$ref: '#/definitions/Response' $ref: '#/definitions/controllers.Response'
definitions: definitions:
1225.0xc0002e2ae0.false:
title: "false"
type: object
1260.0xc0002e2b10.false:
title: "false"
type: object
LaravelResponse: LaravelResponse:
title: LaravelResponse title: LaravelResponse
type: object type: object
Response: Response:
title: Response title: Response
type: object type: object
The:
title: The
type: object
controllers.AuthForm: controllers.AuthForm:
title: AuthForm title: AuthForm
type: object type: object
@ -3064,9 +3250,13 @@ definitions:
type: object type: object
properties: properties:
data: data:
$ref: '#/definitions/1225.0xc0002e2ae0.false' additionalProperties:
description: support string | class | List<class> and os on
type: string
data2: data2:
$ref: '#/definitions/1260.0xc0002e2b10.false' additionalProperties:
description: support string | class | List<class> and os on
type: string
msg: msg:
type: string type: string
name: name:
@ -3090,8 +3280,8 @@ definitions:
jose.JSONWebKey: jose.JSONWebKey:
title: JSONWebKey title: JSONWebKey
type: object type: object
object.&{179844 0xc000a02f90 false}: object:
title: '&{179844 0xc000a02f90 false}' title: object
type: object type: object
object.AccountItem: object.AccountItem:
title: AccountItem title: AccountItem
@ -3220,7 +3410,7 @@ definitions:
title: CasbinRequest title: CasbinRequest
type: array type: array
items: items:
$ref: '#/definitions/object.&{179844 0xc000a02f90 false}' $ref: '#/definitions/object.CasbinRequest'
object.Cert: object.Cert:
title: Cert title: Cert
type: object type: object
@ -3295,6 +3485,44 @@ definitions:
throughput: throughput:
type: number type: number
format: double format: double
object.Group:
title: Group
type: object
properties:
children:
type: array
items:
$ref: '#/definitions/object.Group'
contactEmail:
type: string
createdTime:
type: string
displayName:
type: string
isEnabled:
type: boolean
isTopGroup:
type: boolean
key:
type: string
manager:
type: string
name:
type: string
owner:
type: string
parentId:
type: string
title:
type: string
type:
type: string
updatedTime:
type: string
users:
type: array
items:
$ref: '#/definitions/object.User'
object.Header: object.Header:
title: Header title: Header
type: object type: object
@ -3395,18 +3623,18 @@ definitions:
properties: properties:
countryCode: countryCode:
type: string type: string
id: enabled:
type: string type: boolean
isPreferred: isPreferred:
type: boolean type: boolean
mfaType:
type: string
recoveryCodes: recoveryCodes:
type: array type: array
items: items:
type: string type: string
secret: secret:
type: string type: string
type:
type: string
url: url:
type: string type: string
object.Model: object.Model:
@ -3415,6 +3643,8 @@ definitions:
properties: properties:
createdTime: createdTime:
type: string type: string
description:
type: string
displayName: displayName:
type: string type: string
isEnabled: isEnabled:
@ -3520,6 +3750,10 @@ definitions:
type: string type: string
owner: owner:
type: string type: string
passwordOptions:
type: array
items:
type: string
passwordSalt: passwordSalt:
type: string type: string
passwordType: passwordType:
@ -3607,6 +3841,8 @@ definitions:
type: string type: string
createdTime: createdTime:
type: string type: string
description:
type: string
displayName: displayName:
type: string type: string
domains: domains:
@ -3687,8 +3923,6 @@ definitions:
type: string type: string
displayName: displayName:
type: string type: string
hasTrial:
type: boolean
isEnabled: isEnabled:
type: boolean type: boolean
name: name:
@ -3904,6 +4138,8 @@ definitions:
properties: properties:
createdTime: createdTime:
type: string type: string
description:
type: string
displayName: displayName:
type: string type: string
domains: domains:
@ -3995,6 +4231,8 @@ definitions:
type: string type: string
isEnabled: isEnabled:
type: boolean type: boolean
isReadOnly:
type: boolean
name: name:
type: string type: string
organization: organization:
@ -4117,6 +4355,10 @@ definitions:
title: User title: User
type: object type: object
properties: properties:
accessKey:
type: string
accessSecret:
type: string
address: address:
type: array type: array
items: items:
@ -4135,6 +4377,8 @@ definitions:
type: string type: string
avatar: avatar:
type: string type: string
avatarType:
type: string
azuread: azuread:
type: string type: string
baidu: baidu:
@ -4205,6 +4449,10 @@ definitions:
type: string type: string
google: google:
type: string type: string
groups:
type: array
items:
type: string
hash: hash:
type: string type: string
heroku: heroku:
@ -4272,6 +4520,10 @@ definitions:
$ref: '#/definitions/object.ManagedAccount' $ref: '#/definitions/object.ManagedAccount'
meetup: meetup:
type: string type: string
mfaEmailEnabled:
type: boolean
mfaPhoneEnabled:
type: boolean
microsoftonline: microsoftonline:
type: string type: string
multiFactorAuths: multiFactorAuths:
@ -4312,6 +4564,8 @@ definitions:
type: string type: string
preHash: preHash:
type: string type: string
preferredMfaType:
type: string
properties: properties:
additionalProperties: additionalProperties:
type: string type: string
@ -4320,6 +4574,10 @@ definitions:
ranking: ranking:
type: integer type: integer
format: int64 format: int64
recoveryCodes:
type: array
items:
type: string
region: region:
type: string type: string
roles: roles:
@ -4356,6 +4614,8 @@ definitions:
type: string type: string
title: title:
type: string type: string
totpSecret:
type: string
tumblr: tumblr:
type: string type: string
twitch: twitch:
@ -4404,12 +4664,14 @@ definitions:
type: string type: string
email: email:
type: string type: string
groups:
type: array
items:
type: string
iss: iss:
type: string type: string
name: name:
type: string type: string
organization:
type: string
phone: phone:
type: string type: string
picture: picture:
@ -4448,12 +4710,6 @@ definitions:
type: string type: string
url: url:
type: string type: string
object.pricing:
title: pricing
type: object
object.subscription:
title: subscription
type: object
protocol.CredentialAssertion: protocol.CredentialAssertion:
title: CredentialAssertion title: CredentialAssertion
type: object type: object