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
7 changed files with 744 additions and 94 deletions

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": {
"post": {
"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": {
"post": {
"tags": [
@ -599,6 +655,14 @@
}
}
},
"/api/add-user-keys": {
"post": {
"tags": [
"User API"
],
"operationId": "ApiController.AddUserkeys"
}
},
"/api/add-webhook": {
"post": {
"tags": [
@ -782,13 +846,13 @@
"tags": [
"Enforce API"
],
"description": "perform enforce",
"description": "Call Casbin BatchEnforce API",
"operationId": "ApiController.BatchEnforce",
"parameters": [
{
"in": "body",
"name": "body",
"description": "casbin request array",
"description": "array of casbin requests",
"required": true,
"schema": {
"$ref": "#/definitions/object.CasbinRequest"
@ -858,6 +922,34 @@
"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": {
"post": {
"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": {
"post": {
"tags": [
@ -1429,13 +1549,13 @@
"tags": [
"Enforce API"
],
"description": "perform enforce",
"description": "Call Casbin Enforce API",
"operationId": "ApiController.Enforce",
"parameters": [
{
"in": "body",
"name": "body",
"description": "casbin request",
"description": "Casbin request",
"required": true,
"schema": {
"$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": {
"get": {
"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": {
"get": {
"tags": [
@ -2045,7 +2275,7 @@
"tags": [
"Organization API"
],
"description": "get all organization names",
"description": "get all organization name and displayName",
"operationId": "ApiController.GetOrganizationNames",
"parameters": [
{
@ -2338,7 +2568,7 @@
"200": {
"description": "The Response object",
"schema": {
"$ref": "#/definitions/object.pricing"
"$ref": "#/definitions/object.Pricing"
}
}
}
@ -2753,7 +2983,7 @@
"200": {
"description": "The Response object",
"schema": {
"$ref": "#/definitions/object.subscription"
"$ref": "#/definitions/object.Subscription"
}
}
}
@ -3328,7 +3558,7 @@
"200": {
"description": "The Response object",
"schema": {
"$ref": "#/definitions/Response"
"$ref": "#/definitions/controllers.Response"
}
}
}
@ -3598,9 +3828,9 @@
"operationId": "ApiController.MfaSetupInitiate",
"responses": {
"200": {
"description": "Response object",
"description": "The Response object",
"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": {
"post": {
"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": {
"post": {
"tags": [
@ -4579,7 +4879,7 @@
"200": {
"description": "\"The Response object\"",
"schema": {
"$ref": "#/definitions/Response"
"$ref": "#/definitions/controllers.Response"
}
}
}
@ -4624,7 +4924,7 @@
"200": {
"description": "\"The Response object\"",
"schema": {
"$ref": "#/definitions/Response"
"$ref": "#/definitions/controllers.Response"
}
}
}
@ -4632,14 +4932,6 @@
}
},
"definitions": {
"1225.0xc0002e2ae0.false": {
"title": "false",
"type": "object"
},
"1260.0xc0002e2b10.false": {
"title": "false",
"type": "object"
},
"LaravelResponse": {
"title": "LaravelResponse",
"type": "object"
@ -4648,10 +4940,6 @@
"title": "Response",
"type": "object"
},
"The": {
"title": "The",
"type": "object"
},
"controllers.AuthForm": {
"title": "AuthForm",
"type": "object"
@ -4685,10 +4973,16 @@
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/1225.0xc0002e2ae0.false"
"additionalProperties": {
"description": "support string | class | List\u003cclass\u003e and os on",
"type": "string"
}
},
"data2": {
"$ref": "#/definitions/1260.0xc0002e2b10.false"
"additionalProperties": {
"description": "support string | class | List\u003cclass\u003e and os on",
"type": "string"
}
},
"msg": {
"type": "string"
@ -4726,8 +5020,8 @@
"title": "JSONWebKey",
"type": "object"
},
"object.\u0026{179844 0xc000a02f90 false}": {
"title": "\u0026{179844 0xc000a02f90 false}",
"object": {
"title": "object",
"type": "object"
},
"object.AccountItem": {
@ -4917,7 +5211,7 @@
"title": "CasbinRequest",
"type": "array",
"items": {
"$ref": "#/definitions/object.\u0026{179844 0xc000a02f90 false}"
"$ref": "#/definitions/object.CasbinRequest"
}
},
"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": {
"title": "Header",
"type": "object",
@ -5175,12 +5526,15 @@
"countryCode": {
"type": "string"
},
"id": {
"type": "string"
"enabled": {
"type": "boolean"
},
"isPreferred": {
"type": "boolean"
},
"mfaType": {
"type": "string"
},
"recoveryCodes": {
"type": "array",
"items": {
@ -5190,9 +5544,6 @@
"secret": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
@ -5205,6 +5556,9 @@
"createdTime": {
"type": "string"
},
"description": {
"type": "string"
},
"displayName": {
"type": "string"
},
@ -5362,6 +5716,12 @@
"owner": {
"type": "string"
},
"passwordOptions": {
"type": "array",
"items": {
"type": "string"
}
},
"passwordSalt": {
"type": "string"
},
@ -5492,6 +5852,9 @@
"createdTime": {
"type": "string"
},
"description": {
"type": "string"
},
"displayName": {
"type": "string"
},
@ -5611,9 +5974,6 @@
"displayName": {
"type": "string"
},
"hasTrial": {
"type": "boolean"
},
"isEnabled": {
"type": "boolean"
},
@ -5933,6 +6293,9 @@
"createdTime": {
"type": "string"
},
"description": {
"type": "string"
},
"displayName": {
"type": "string"
},
@ -6068,6 +6431,9 @@
"isEnabled": {
"type": "boolean"
},
"isReadOnly": {
"type": "boolean"
},
"name": {
"type": "string"
},
@ -6248,6 +6614,12 @@
"title": "User",
"type": "object",
"properties": {
"accessKey": {
"type": "string"
},
"accessSecret": {
"type": "string"
},
"address": {
"type": "array",
"items": {
@ -6275,6 +6647,9 @@
"avatar": {
"type": "string"
},
"avatarType": {
"type": "string"
},
"azuread": {
"type": "string"
},
@ -6380,6 +6755,12 @@
"google": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "string"
}
},
"hash": {
"type": "string"
},
@ -6480,6 +6861,12 @@
"meetup": {
"type": "string"
},
"mfaEmailEnabled": {
"type": "boolean"
},
"mfaPhoneEnabled": {
"type": "boolean"
},
"microsoftonline": {
"type": "string"
},
@ -6540,6 +6927,9 @@
"preHash": {
"type": "string"
},
"preferredMfaType": {
"type": "string"
},
"properties": {
"additionalProperties": {
"type": "string"
@ -6552,6 +6942,12 @@
"type": "integer",
"format": "int64"
},
"recoveryCodes": {
"type": "array",
"items": {
"type": "string"
}
},
"region": {
"type": "string"
},
@ -6605,6 +7001,9 @@
"title": {
"type": "string"
},
"totpSecret": {
"type": "string"
},
"tumblr": {
"type": "string"
},
@ -6677,15 +7076,18 @@
"email": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "string"
}
},
"iss": {
"type": "string"
},
"name": {
"type": "string"
},
"organization": {
"type": "string"
},
"phone": {
"type": "string"
},
@ -6745,14 +7147,6 @@
}
}
},
"object.pricing": {
"title": "pricing",
"type": "object"
},
"object.subscription": {
"title": "subscription",
"type": "object"
},
"protocol.CredentialAssertion": {
"title": "CredentialAssertion",
"type": "object"