diff --git a/controllers/auth.go b/controllers/auth.go index efdfcea1..e5541f77 100644 --- a/controllers/auth.go +++ b/controllers/auth.go @@ -916,7 +916,7 @@ func (c *ApiController) HandleSamlLogin() { } // HandleOfficialAccountEvent ... -// @Tag HandleOfficialAccountEvent API +// @Tag System API // @Title HandleOfficialAccountEvent // @router /webhook [POST] // @Success 200 {object} object.Userinfo The Response object @@ -947,7 +947,7 @@ func (c *ApiController) HandleOfficialAccountEvent() { } // GetWebhookEventType ... -// @Tag GetWebhookEventType API +// @Tag System API // @Title GetWebhookEventType // @router /get-webhook-event [GET] // @Success 200 {object} object.Userinfo The Response object diff --git a/controllers/casbin_api.go b/controllers/casbin_api.go index 15fe2666..5e92e7b9 100644 --- a/controllers/casbin_api.go +++ b/controllers/casbin_api.go @@ -24,7 +24,7 @@ import ( // Enforce // @Title Enforce -// @Tag Enforce API +// @Tag Enforcer API // @Description Call Casbin Enforce API // @Param body body []string true "Casbin request" // @Param permissionId query string false "permission id" @@ -151,7 +151,7 @@ func (c *ApiController) Enforce() { // BatchEnforce // @Title BatchEnforce -// @Tag Enforce API +// @Tag Enforcer API // @Description Call Casbin BatchEnforce API // @Param body body []string true "array of casbin requests" // @Param permissionId query string false "permission id" diff --git a/controllers/get-dashboard.go b/controllers/get-dashboard.go index 9912ee2e..62347366 100644 --- a/controllers/get-dashboard.go +++ b/controllers/get-dashboard.go @@ -18,7 +18,7 @@ import "github.com/casdoor/casdoor/object" // GetDashboard // @Title GetDashboard -// @Tag GetDashboard API +// @Tag System API // @Description get information of dashboard // @Success 200 {object} controllers.Response The Response object // @router /get-dashboard [get] diff --git a/controllers/prometheus.go b/controllers/prometheus.go index b192f8ef..6d019aea 100644 --- a/controllers/prometheus.go +++ b/controllers/prometheus.go @@ -20,7 +20,7 @@ import ( // GetPrometheusInfo // @Title GetPrometheusInfo -// @Tag Prometheus API +// @Tag System API // @Description get Prometheus Info // @Success 200 {object} object.PrometheusInfo The Response object // @router /get-prometheus-info [get] diff --git a/controllers/token.go b/controllers/token.go index 97d6538e..2420bc6d 100644 --- a/controllers/token.go +++ b/controllers/token.go @@ -273,6 +273,7 @@ func (c *ApiController) RefreshToken() { // IntrospectToken // @Title IntrospectToken +// @Tag Login API // @Description The introspection endpoint is an OAuth 2.0 endpoint that takes a // parameter representing an OAuth 2.0 token and returns a JSON document // representing the meta information surrounding the diff --git a/swagger/swagger.json b/swagger/swagger.json index f9576885..cea71611 100644 --- a/swagger/swagger.json +++ b/swagger/swagger.json @@ -734,7 +734,7 @@ "/api/batch-enforce": { "post": { "tags": [ - "Enforce API" + "Enforcer API" ], "description": "Call Casbin BatchEnforce API", "operationId": "ApiController.BatchEnforce", @@ -1493,7 +1493,7 @@ "/api/enforce": { "post": { "tags": [ - "Enforce API" + "Enforcer API" ], "description": "Call Casbin Enforce API", "operationId": "ApiController.Enforce", @@ -1826,7 +1826,7 @@ "/api/get-dashboard": { "get": { "tags": [ - "GetDashboard API" + "System API" ], "description": "get information of dashboard", "operationId": "ApiController.GetDashboard", @@ -2696,7 +2696,7 @@ "/api/get-prometheus-info": { "get": { "tags": [ - "Prometheus API" + "System API" ], "description": "get Prometheus Info", "operationId": "ApiController.GetPrometheusInfo", @@ -3436,7 +3436,7 @@ "/api/get-webhook-event": { "get": { "tags": [ - "GetWebhookEventType API" + "System API" ], "operationId": "ApiController.GetWebhookEventType", "responses": { @@ -3703,6 +3703,9 @@ }, "/api/login/oauth/introspect": { "post": { + "tags": [ + "Login API" + ], "description": "The introspection endpoint is an OAuth 2.0 endpoint that takes a", "operationId": "ApiController.IntrospectToken", "parameters": [ @@ -5306,7 +5309,7 @@ "/api/webhook": { "post": { "tags": [ - "HandleOfficialAccountEvent API" + "System API" ], "operationId": "ApiController.HandleOfficialAccountEvent", "responses": { diff --git a/swagger/swagger.yml b/swagger/swagger.yml index d9ce0c26..4e977fdc 100644 --- a/swagger/swagger.yml +++ b/swagger/swagger.yml @@ -474,7 +474,7 @@ paths: /api/batch-enforce: post: tags: - - Enforce API + - Enforcer API description: Call Casbin BatchEnforce API operationId: ApiController.BatchEnforce parameters: @@ -963,7 +963,7 @@ paths: /api/enforce: post: tags: - - Enforce API + - Enforcer API description: Call Casbin Enforce API operationId: ApiController.Enforce parameters: @@ -1182,7 +1182,7 @@ paths: /api/get-dashboard: get: tags: - - GetDashboard API + - System API description: get information of dashboard operationId: ApiController.GetDashboard responses: @@ -1751,7 +1751,7 @@ paths: /api/get-prometheus-info: get: tags: - - Prometheus API + - System API description: get Prometheus Info operationId: ApiController.GetPrometheusInfo responses: @@ -2238,7 +2238,7 @@ paths: /api/get-webhook-event: get: tags: - - GetWebhookEventType API + - System API operationId: ApiController.GetWebhookEventType responses: "200": @@ -2414,6 +2414,8 @@ paths: $ref: '#/definitions/object.TokenError' /api/login/oauth/introspect: post: + tags: + - Login API description: The introspection endpoint is an OAuth 2.0 endpoint that takes a operationId: ApiController.IntrospectToken parameters: @@ -3467,7 +3469,7 @@ paths: /api/webhook: post: tags: - - HandleOfficialAccountEvent API + - System API operationId: ApiController.HandleOfficialAccountEvent responses: "200":