Documentation
¶
Overview ¶
Package handler provides HTTP handlers for the web API.
Index ¶
- Variables
- type AuthHandler
- func (h *AuthHandler) GetCurrentUserInfo(c *gin.Context)
- func (h *AuthHandler) GetProfile(c *gin.Context)
- func (h *AuthHandler) GetRSAPublicKey(c *gin.Context)
- func (h *AuthHandler) Login(c *gin.Context)
- func (h *AuthHandler) Logout(c *gin.Context)
- func (h *AuthHandler) NewCaptcha(c *gin.Context)
- func (h *AuthHandler) RefreshToken(c *gin.Context)
- func (h *AuthHandler) ReloadCaptcha(c *gin.Context)
- func (h *AuthHandler) UpdateProfile(c *gin.Context)
- type DepartmentHandler
- func (h *DepartmentHandler) CreateDepartment(c *gin.Context)
- func (h *DepartmentHandler) DeleteDepartment(c *gin.Context)
- func (h *DepartmentHandler) GetDepartment(c *gin.Context)
- func (h *DepartmentHandler) GetDepartmentFormData(c *gin.Context)
- func (h *DepartmentHandler) GetDepartmentOptions(c *gin.Context)
- func (h *DepartmentHandler) ListDepartments(c *gin.Context)
- func (h *DepartmentHandler) UpdateDepartment(c *gin.Context)
- func (h *DepartmentHandler) UpdateDepartmentEnabled(c *gin.Context)
- type PermissionHandler
- type RoleHandler
- func (h *RoleHandler) CreateRole(c *gin.Context)
- func (h *RoleHandler) DeleteRole(c *gin.Context)
- func (h *RoleHandler) GetRole(c *gin.Context)
- func (h *RoleHandler) GetRoleFormData(c *gin.Context)
- func (h *RoleHandler) GetRoleOptions(c *gin.Context)
- func (h *RoleHandler) ListRoles(c *gin.Context)
- func (h *RoleHandler) UpdateRole(c *gin.Context)
- func (h *RoleHandler) UpdateRoleEnabled(c *gin.Context)
- type UserHandler
- func (h *UserHandler) CreateUser(c *gin.Context)
- func (h *UserHandler) DeleteUser(c *gin.Context)
- func (h *UserHandler) GetUser(c *gin.Context)
- func (h *UserHandler) GetUserFormData(c *gin.Context)
- func (h *UserHandler) ListUsers(c *gin.Context)
- func (h *UserHandler) UpdateUser(c *gin.Context)
- func (h *UserHandler) UpdateUserEnabled(c *gin.Context)
Constants ¶
This section is empty.
Variables ¶
var ProviderSet = wire.NewSet( NewAuthHandler, NewDepartmentHandler, NewPermissionHandler, NewRoleHandler, NewUserHandler, )
ProviderSet provides all handler dependencies.
Functions ¶
This section is empty.
Types ¶
type AuthHandler ¶
type AuthHandler struct {
// contains filtered or unexported fields
}
func NewAuthHandler ¶
func NewAuthHandler(authService *service.AuthService, authMW *jwt.GinJWTMiddleware, logger *zap.Logger) *AuthHandler
NewAuthHandler creates a new instance of AuthHandler.
func (*AuthHandler) GetCurrentUserInfo ¶
func (h *AuthHandler) GetCurrentUserInfo(c *gin.Context)
GetCurrentUserInfo godoc
@ID GetCurrentUserInfo
@Summary Get Current User Info
@Description Retrieves a single Current User Info
@Tags auth
@Accept json
@Produce json
@Param req query types.GetCurrentUserInfoReq false "req"
@Success 200 {object} types.Response{data=types.GetCurrentUserInfoResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /users/current [get]
func (*AuthHandler) GetProfile ¶
func (h *AuthHandler) GetProfile(c *gin.Context)
GetProfile godoc
@ID GetProfile
@Summary Get Profile
@Description Retrieves a single Profile
@Tags auth
@Accept json
@Produce json
@Param req query types.GetProfileReq false "req"
@Success 200 {object} types.Response{data=types.GetProfileResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /profile [get]
func (*AuthHandler) GetRSAPublicKey ¶
func (h *AuthHandler) GetRSAPublicKey(c *gin.Context)
GetRSAPublicKey godoc
@ID GetRSAPublicKey
@Summary Get RSAPublic Key
@Description Retrieves a single RSAPublic Key
@Tags auth
@Accept json
@Produce json
@Param req body types.GetRSAPublicKeyReq true "req"
@Success 201 {object} types.Response{data=types.GetRSAPublicKeyResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Router /public_key [post]
func (*AuthHandler) Login ¶
func (h *AuthHandler) Login(c *gin.Context)
Login godoc
@ID Login
@Summary Login
@Description Login
@Tags auth
@Accept json
@Produce json
@Param req body types.LoginReq true "req"
@Success 201 {object} types.Response{data=types.LoginResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Router /login [post]
func (*AuthHandler) Logout ¶
func (h *AuthHandler) Logout(c *gin.Context)
Logout godoc
@ID Logout
@Summary Logout
@Description Logout
@Tags auth
@Accept json
@Produce json
@Param req body types.LogoutReq true "req"
@Success 201 {object} types.Response{data=types.LogoutResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /logout [post]
func (*AuthHandler) NewCaptcha ¶
func (h *AuthHandler) NewCaptcha(c *gin.Context)
NewCaptcha godoc
@ID NewCaptcha
@Summary New Captcha
@Description New Captcha
@Tags auth
@Accept json
@Produce json
@Param req body types.NewCaptchaReq true "req"
@Success 201 {object} types.Response{data=types.NewCaptchaResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Router /captcha/new [post]
func (*AuthHandler) RefreshToken ¶
func (h *AuthHandler) RefreshToken(c *gin.Context)
RefreshToken godoc
@ID RefreshToken
@Summary Refresh Token
@Description Refresh Token
@Tags auth
@Accept json
@Produce json
@Param req query types.RefreshTokenReq false "req"
@Success 200 {object} types.Response{data=types.RefreshTokenResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Router /refresh_token [get]
func (*AuthHandler) ReloadCaptcha ¶
func (h *AuthHandler) ReloadCaptcha(c *gin.Context)
ReloadCaptcha godoc
@ID ReloadCaptcha
@Summary Reload Captcha
@Description Reload Captcha
@Tags auth
@Accept json
@Produce json
@Param id path string true "id"
@Param req body types.ReloadCaptchaReq true "req"
@Success 201 {object} types.Response{data=types.ReloadCaptchaResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Router /captcha/{id}/reload [post]
func (*AuthHandler) UpdateProfile ¶
func (h *AuthHandler) UpdateProfile(c *gin.Context)
UpdateProfile godoc
@ID UpdateProfile
@Summary Update Profile
@Description Updates an existing Profile
@Tags auth
@Accept json
@Produce json
@Param req body types.UpdateProfileReq true "req"
@Success 200 {object} types.Response{data=types.UpdateProfileResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /profile [put]
type DepartmentHandler ¶
type DepartmentHandler struct {
// contains filtered or unexported fields
}
DepartmentHandler defines the department HTTP handlers.
func NewDepartmentHandler ¶
func NewDepartmentHandler(departmentService *service.DepartmentService, logger *zap.Logger) *DepartmentHandler
NewDepartmentHandler creates a new instance of DepartmentHandler.
func (*DepartmentHandler) CreateDepartment ¶
func (h *DepartmentHandler) CreateDepartment(c *gin.Context)
CreateDepartment godoc
@ID CreateDepartment
@Summary Create Department
@Description Creates a new Department
@Tags department
@Accept json
@Produce json
@Param req body types.CreateDepartmentReq true "req"
@Success 201 {object} types.Response{data=types.CreateDepartmentResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /departments [post]
func (*DepartmentHandler) DeleteDepartment ¶
func (h *DepartmentHandler) DeleteDepartment(c *gin.Context)
DeleteDepartment godoc
@ID DeleteDepartment
@Summary Delete Department
@Description Deletes an existing Department
@Tags department
@Accept json
@Produce json
@Param id path integer true "id"
@Param req body types.DeleteDepartmentReq true "req"
@Success 204 {object} types.Response{data=types.DeleteDepartmentResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /departments/{id} [delete]
func (*DepartmentHandler) GetDepartment ¶
func (h *DepartmentHandler) GetDepartment(c *gin.Context)
GetDepartment godoc
@ID GetDepartment
@Summary Get Department
@Description Retrieves a single Department
@Tags department
@Accept json
@Produce json
@Param id path integer true "id"
@Param req query types.GetDepartmentReq false "req"
@Success 200 {object} types.Response{data=types.GetDepartmentResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /departments/{id} [get]
func (*DepartmentHandler) GetDepartmentFormData ¶
func (h *DepartmentHandler) GetDepartmentFormData(c *gin.Context)
GetDepartmentFormData godoc
@ID GetDepartmentFormData
@Summary Get Department Form Data
@Description Retrieves a single Department Form Data
@Tags department
@Accept json
@Produce json
@Param id path integer true "id"
@Param req query types.GetDepartmentFormDataReq false "req"
@Success 200 {object} types.Response{data=types.GetDepartmentFormDataResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /departments/{id}/form [get]
func (*DepartmentHandler) GetDepartmentOptions ¶
func (h *DepartmentHandler) GetDepartmentOptions(c *gin.Context)
GetDepartmentOptions godoc
@ID GetDepartmentOptions
@Summary Get Department Options
@Description Retrieves a single Department Options
@Tags department
@Accept json
@Produce json
@Param req query types.GetDepartmentOptionsReq false "req"
@Success 200 {object} types.Response{data=types.GetDepartmentOptionsResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /departments/options [get]
func (*DepartmentHandler) ListDepartments ¶
func (h *DepartmentHandler) ListDepartments(c *gin.Context)
ListDepartments godoc
@ID ListDepartments
@Summary List Departments
@Description Retrieves a list of Departments
@Tags department
@Accept json
@Produce json
@Param req query types.ListDepartmentsReq false "req"
@Success 200 {object} types.Response{data=types.ListDepartmentsResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /departments [get]
func (*DepartmentHandler) UpdateDepartment ¶
func (h *DepartmentHandler) UpdateDepartment(c *gin.Context)
UpdateDepartment godoc
@ID UpdateDepartment
@Summary Update Department
@Description Updates an existing Department
@Tags department
@Accept json
@Produce json
@Param id path integer true "id"
@Param req body types.UpdateDepartmentReq true "req"
@Success 200 {object} types.Response{data=types.UpdateDepartmentResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /departments/{id} [put]
func (*DepartmentHandler) UpdateDepartmentEnabled ¶
func (h *DepartmentHandler) UpdateDepartmentEnabled(c *gin.Context)
UpdateDepartmentEnabled godoc
@ID UpdateDepartmentEnabled
@Summary Update Department Enabled
@Description Updates an existing Department Enabled
@Tags department
@Accept json
@Produce json
@Param id path integer true "id"
@Param req body types.UpdateDepartmentEnabledReq true "req"
@Success 200 {object} types.Response{data=types.UpdateDepartmentEnabledResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /departments/{id}/enabled [patch]
type PermissionHandler ¶
type PermissionHandler struct {
// contains filtered or unexported fields
}
PermissionHandler handles permission related requests
func NewPermissionHandler ¶
func NewPermissionHandler(permissionService *service.PermissionService, logger *zap.Logger) *PermissionHandler
NewPermissionHandler creates a new instance of PermissionHandler
func (*PermissionHandler) GetPermissionTree ¶
func (h *PermissionHandler) GetPermissionTree(c *gin.Context)
GetPermissionTree godoc
@ID GetPermissionTree
@Summary Get Permission Tree
@Description Retrieves a single Permission Tree
@Tags permission
@Accept json
@Produce json
@Param req query types.GetPermissionTreeReq false "req"
@Success 200 {object} types.Response{data=types.GetPermissionTreeResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /permissions/tree [get]
func (*PermissionHandler) GetRolePermissions ¶
func (h *PermissionHandler) GetRolePermissions(c *gin.Context)
GetRolePermissions godoc
@ID GetRolePermissions
@Summary Get Role Permissions
@Description Retrieves a single Role Permissions
@Tags permission
@Accept json
@Produce json
@Param id path integer true "id"
@Param req query types.GetRolePermissionsReq false "req"
@Success 200 {object} types.Response{data=types.GetRolePermissionsResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /roles/{id}/permissions [get]
func (*PermissionHandler) UpdateRolePermissions ¶
func (h *PermissionHandler) UpdateRolePermissions(c *gin.Context)
UpdateRolePermissions godoc
@ID UpdateRolePermissions
@Summary Update Role Permissions
@Description Updates an existing Role Permissions
@Tags permission
@Accept json
@Produce json
@Param id path integer true "id"
@Param req body types.UpdateRolePermissionsReq true "req"
@Success 200 {object} types.Response{data=types.UpdateRolePermissionsResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /roles/{id}/permissions [put]
type RoleHandler ¶
type RoleHandler struct {
// contains filtered or unexported fields
}
RoleHandler defines the role HTTP handlers.
func NewRoleHandler ¶
func NewRoleHandler(roleService *service.RoleService, logger *zap.Logger) *RoleHandler
NewRoleHandler creates a new instance of RoleHandler.
func (*RoleHandler) CreateRole ¶
func (h *RoleHandler) CreateRole(c *gin.Context)
CreateRole godoc
@ID CreateRole
@Summary Create Role
@Description Creates a new Role
@Tags role
@Accept json
@Produce json
@Param req body types.CreateRoleReq true "req"
@Success 201 {object} types.Response{data=types.CreateRoleResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /roles [post]
func (*RoleHandler) DeleteRole ¶
func (h *RoleHandler) DeleteRole(c *gin.Context)
DeleteRole godoc
@ID DeleteRole
@Summary Delete Role
@Description Deletes an existing Role
@Tags role
@Accept json
@Produce json
@Param id path integer true "id"
@Param req body types.DeleteRoleReq true "req"
@Success 204 {object} types.Response{data=types.DeleteRoleResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /roles/{id} [delete]
func (*RoleHandler) GetRole ¶
func (h *RoleHandler) GetRole(c *gin.Context)
GetRole godoc
@ID GetRole
@Summary Get Role
@Description Retrieves a single Role
@Tags role
@Accept json
@Produce json
@Param id path integer true "id"
@Param req query types.GetRoleReq false "req"
@Success 200 {object} types.Response{data=types.GetRoleResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /roles/{id} [get]
func (*RoleHandler) GetRoleFormData ¶
func (h *RoleHandler) GetRoleFormData(c *gin.Context)
GetRoleFormData godoc
@ID GetRoleFormData
@Summary Get Role Form Data
@Description Retrieves a single Role Form Data
@Tags role
@Accept json
@Produce json
@Param id path integer true "id"
@Param req query types.GetRoleFormDataReq false "req"
@Success 200 {object} types.Response{data=types.GetRoleFormDataResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /roles/{id}/form [get]
func (*RoleHandler) GetRoleOptions ¶
func (h *RoleHandler) GetRoleOptions(c *gin.Context)
GetRoleOptions godoc
@ID GetRoleOptions
@Summary Get Role Options
@Description Retrieves a single Role Options
@Tags role
@Accept json
@Produce json
@Param req query types.GetRoleOptionsReq false "req"
@Success 200 {object} types.Response{data=types.GetRoleOptionsResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /roles/options [get]
func (*RoleHandler) ListRoles ¶
func (h *RoleHandler) ListRoles(c *gin.Context)
ListRoles godoc
@ID ListRoles
@Summary List Roles
@Description Retrieves a list of Roles
@Tags role
@Accept json
@Produce json
@Param req query types.ListRolesReq false "req"
@Success 200 {object} types.Response{data=types.ListRolesResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /roles [get]
func (*RoleHandler) UpdateRole ¶
func (h *RoleHandler) UpdateRole(c *gin.Context)
UpdateRole godoc
@ID UpdateRole
@Summary Update Role
@Description Updates an existing Role
@Tags role
@Accept json
@Produce json
@Param id path integer true "id"
@Param req body types.UpdateRoleReq true "req"
@Success 200 {object} types.Response{data=types.UpdateRoleResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /roles/{id} [put]
func (*RoleHandler) UpdateRoleEnabled ¶
func (h *RoleHandler) UpdateRoleEnabled(c *gin.Context)
UpdateRoleEnabled godoc
@ID UpdateRoleEnabled
@Summary Update Role Enabled
@Description Updates an existing Role Enabled
@Tags role
@Accept json
@Produce json
@Param id path integer true "id"
@Param req body types.UpdateRoleEnabledReq true "req"
@Success 200 {object} types.Response{data=types.UpdateRoleEnabledResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /roles/{id}/enabled [patch]
type UserHandler ¶
type UserHandler struct {
// contains filtered or unexported fields
}
UserHandler defines the user HTTP handlers.
func NewUserHandler ¶
func NewUserHandler(userService *service.UserService, logger *zap.Logger) *UserHandler
NewUserHandler creates a new instance of UserHandler.
func (*UserHandler) CreateUser ¶
func (h *UserHandler) CreateUser(c *gin.Context)
CreateUser godoc
@ID CreateUser
@Summary Create User
@Description Creates a new User
@Tags user
@Accept json
@Produce json
@Param req body types.CreateUserReq true "req"
@Success 201 {object} types.Response{data=types.CreateUserResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /users [post]
func (*UserHandler) DeleteUser ¶
func (h *UserHandler) DeleteUser(c *gin.Context)
DeleteUser godoc
@ID DeleteUser
@Summary Delete User
@Description Deletes an existing User
@Tags user
@Accept json
@Produce json
@Param id path integer true "id"
@Param req body types.DeleteUserReq true "req"
@Success 204 {object} types.Response{data=types.DeleteUserResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /users/{id} [delete]
func (*UserHandler) GetUser ¶
func (h *UserHandler) GetUser(c *gin.Context)
GetUser godoc
@ID GetUser
@Summary Get User
@Description Retrieves a single User
@Tags user
@Accept json
@Produce json
@Param id path integer true "id"
@Param req query types.GetUserReq false "req"
@Success 200 {object} types.Response{data=types.GetUserResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /users/{id} [get]
func (*UserHandler) GetUserFormData ¶
func (h *UserHandler) GetUserFormData(c *gin.Context)
GetUserFormData godoc
@ID GetUserFormData
@Summary Get User Form Data
@Description Retrieves a single User Form Data
@Tags user
@Accept json
@Produce json
@Param id path integer true "id"
@Param req query types.GetUserFormDataReq false "req"
@Success 200 {object} types.Response{data=types.GetUserFormDataResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /users/{id}/form [get]
func (*UserHandler) ListUsers ¶
func (h *UserHandler) ListUsers(c *gin.Context)
ListUsers godoc
@ID ListUsers
@Summary List Users
@Description Retrieves a list of Users
@Tags user
@Accept json
@Produce json
@Param req query types.ListUsersReq false "req"
@Success 200 {object} types.Response{data=types.ListUsersResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /users [get]
func (*UserHandler) UpdateUser ¶
func (h *UserHandler) UpdateUser(c *gin.Context)
UpdateUser godoc
@ID UpdateUser
@Summary Update User
@Description Updates an existing User
@Tags user
@Accept json
@Produce json
@Param id path integer true "id"
@Param req body types.UpdateUserReq true "req"
@Success 200 {object} types.Response{data=types.UpdateUserResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /users/{id} [put]
func (*UserHandler) UpdateUserEnabled ¶
func (h *UserHandler) UpdateUserEnabled(c *gin.Context)
UpdateUserEnabled godoc
@ID UpdateUserEnabled
@Summary Update User Enabled
@Description Updates an existing User Enabled
@Tags user
@Accept json
@Produce json
@Param id path integer true "id"
@Param req body types.UpdateUserEnabledReq true "req"
@Success 200 {object} types.Response{data=types.UpdateUserEnabledResp} "Success"
@Failure 400 {object} types.Response "Bad request"
@Failure 401 {object} types.Response "Unauthorized"
@Failure 500 {object} types.Response "Internal server error"
@Security BearerAuth
@Router /users/{id}/enabled [patch]