pkg.gl

Categorygithub.com/ChanJuiHuang/go-backend-frameworkinternalhttpcontrolleradminpermission

package

2.10.3+incompatible

Repository: https://github.com/chanjuihuang/go-backend-framework.git

Documentation: pkg.go.dev

# Functions

Create

@tags admin-permission @accept json @produce json @param X-XSRF-TOKEN header string true "csrf token" @param Authorization header string true "bearer token" @param request body permission.PermissionCreateRequest true "create permission" @success 200 {object} response.Response{data=permission.PermissionCreateData} @failure 400 {object} response.ErrorResponse "code: 400-001(Bad Request), 400-002(request validation failed)" @failure 401 {object} response.ErrorResponse "code: 401-001(Unauthorized)" @failure 403 {object} response.ErrorResponse "code: 403-001(Forbidden)" @failure 500 {object} response.ErrorResponse "code: 500-001(Internal Server Error)" @router /api/admin/permission [post].

CreateRole

@tags admin-permission @accept json @produce json @param X-XSRF-TOKEN header string true "csrf token" @param Authorization header string true "bearer token" @param request body permission.RoleCreateRequest true "create role" @success 200 {object} response.Response{data=permission.RoleData} @failure 400 {object} response.ErrorResponse "code: 400-001(Bad Request), 400-002(request validation failed)" @failure 401 {object} response.ErrorResponse "code: 401-001(Unauthorized)" @failure 403 {object} response.ErrorResponse "code: 403-001(Forbidden)" @failure 500 {object} response.ErrorResponse "code: 500-001(Internal Server Error)" @router /api/admin/role [post].

Delete

@tags admin-permission @accept json @produce json @param X-XSRF-TOKEN header string true "csrf token" @param Authorization header string true "bearer token" @param id path string true "id" @param request body permission.PermissionDeleteRequest true "delete permissions" @success 204 "no content" @failure 400 {object} response.ErrorResponse "code: 400-001(Bad Request), 400-002(request validation failed)" @failure 401 {object} response.ErrorResponse "code: 401-001(Unauthorized)" @failure 403 {object} response.ErrorResponse "code: 403-001(Forbidden)" @failure 500 {object} response.ErrorResponse "code: 500-001(Internal Server Error)" @router /api/admin/permission [delete].

DeleteRoles

@tags admin-permission @accept json @produce json @param X-XSRF-TOKEN header string true "csrf token" @param Authorization header string true "bearer token" @param id path string true "id" @param request body permission.RoleDeleteRequest true "delete roles" @success 204 "no content" @failure 400 {object} response.ErrorResponse "code: 400-001(Bad Request), 400-002(request validation failed)" @failure 401 {object} response.ErrorResponse "code: 401-001(Unauthorized)" @failure 403 {object} response.ErrorResponse "code: 403-001(Forbidden)" @failure 500 {object} response.ErrorResponse "code: 500-001(Internal Server Error)" @router /api/admin/role [delete].

Get

@tags admin-permission @accept json @produce json @param Authorization header string true "bearer token" @param id path string true "id" @success 200 {object} response.Response{data=permission.PermissionGetData} @failure 400 {object} response.ErrorResponse "code: 400-001(Bad Request), 400-002(request validation failed)" @failure 401 {object} response.ErrorResponse "code: 401-001(Unauthorized)" @failure 403 {object} response.ErrorResponse "code: 403-001(Forbidden)" @failure 500 {object} response.ErrorResponse "code: 500-001(Internal Server Error)" @router /api/admin/permission/{id} [get].

Reload

@tags admin-permission @accept json @produce json @param X-XSRF-TOKEN header string true "csrf token" @param Authorization header string true "bearer token" @success 204 "no content" @failure 400 {object} response.ErrorResponse "code: 400-001(Bad Request)" @failure 401 {object} response.ErrorResponse "code: 401-001(Unauthorized)" @failure 403 {object} response.ErrorResponse "code: 403-001(Forbidden)" @failure 500 {object} response.ErrorResponse "code: 500-001(Internal Server Error)" @router /api/admin/permission/reload [post].

@tags admin-permission @accept json @produce json @param Authorization header string true "bearer token" @param request body permission.PermissionSearchRequest true "search permissions" @success 200 {object} response.Response{data=permission.PermissionSearchData} @failure 400 {object} response.ErrorResponse "code: 400-001(Bad Request), 400-002(request validation failed)" @failure 401 {object} response.ErrorResponse "code: 401-001(Unauthorized)" @failure 403 {object} response.ErrorResponse "code: 403-001(Forbidden)" @failure 500 {object} response.ErrorResponse "code: 500-001(Internal Server Error)" @router /api/admin/permission [get].

SearchRoles

@tags admin-permission @accept json @produce json @param Authorization header string true "bearer token" @param request body permission.RoleSearchRequest true "search roles" @success 200 {object} response.Response{data=permission.RoleSearchData} @failure 400 {object} response.ErrorResponse "code: 400-001(Bad Request), 400-002(request validation failed)" @failure 401 {object} response.ErrorResponse "code: 401-001(Unauthorized)" @failure 403 {object} response.ErrorResponse "code: 403-001(Forbidden)" @failure 500 {object} response.ErrorResponse "code: 500-001(Internal Server Error)" @router /api/admin/role [get].

Update

@tags admin-permission @accept json @produce json @param X-XSRF-TOKEN header string true "csrf token" @param Authorization header string true "bearer token" @param id path string true "id" @param request body permission.PermissionUpdateRequest true "update permission" @success 200 {object} response.Response{data=permission.PermissionUpdateData} @failure 400 {object} response.ErrorResponse "code: 400-001(Bad Request), 400-002(request validation failed)" @failure 401 {object} response.ErrorResponse "code: 401-001(Unauthorized)" @failure 403 {object} response.ErrorResponse "code: 403-001(Forbidden)" @failure 500 {object} response.ErrorResponse "code: 500-001(Internal Server Error)" @router /api/admin/permission/{id} [put].

UpdateRole

@tags admin-permission @accept json @produce json @param X-XSRF-TOKEN header string true "csrf token" @param Authorization header string true "bearer token" @param id path string true "id" @param request body permission.RoleUpdateRequest true "update role" @success 200 {object} response.Response{data=permission.RoleData} @failure 400 {object} response.ErrorResponse "code: 400-001(Bad Request), 400-002(request validation failed)" @failure 401 {object} response.ErrorResponse "code: 401-001(Unauthorized)" @failure 403 {object} response.ErrorResponse "code: 403-001(Forbidden)" @failure 500 {object} response.ErrorResponse "code: 500-001(Internal Server Error)" @router /api/admin/role/{id} [put].