request

Documentation

Index

• func ID(c *gin.Context) (int, error)
• type Credentials
  • func Login(c *gin.Context) (*Credentials, error)
• type Pagination
  • func Paginate(c *gin.Context) (*Pagination, error)
• type Password
  • func PasswordChange(c *gin.Context) (*Password, error)
• type Register
  • func AccountCreate(c *gin.Context) (*Register, error)
• type UpdateUser
  • func UserUpdate(c *gin.Context) (*UpdateUser, error)

Functions

func ID

func ID(c *gin.Context) (int, error)

ID returns id url parameter. In case of conversion error to int, request will be aborted with StatusBadRequest.

Types

type Credentials

type Credentials struct {
	Username string `json:"username" binding:"required"`
	Password string `json:"password" binding:"required"`
}

Credentials contains login request

func Login

func Login(c *gin.Context) (*Credentials, error)

Login validates login request

type Pagination

type Pagination struct {
	Limit  int `form:"limit"`
	Page   int `form:"page" binding:"min=0"`
	Offset int `json:"-"`
}

Pagination contains pagination request

func Paginate

func Paginate(c *gin.Context) (*Pagination, error)

Paginate validates pagination requests

type Password

type Password struct {
	ID                 int    `json:"-"`
	OldPassword        string `json:"old_password" binding:"required,min=8"`
	NewPassword        string `json:"new_password" binding:"required,min=8"`
	NewPasswordConfirm string `json:"new_password_confirm" binding:"required"`
}

Password contains password change request

func PasswordChange

func PasswordChange(c *gin.Context) (*Password, error)

PasswordChange validates password change request

type Register

type Register struct {
	FirstName       string `json:"first_name" binding:"required"`
	LastName        string `json:"last_name" binding:"required"`
	Username        string `json:"username" binding:"required,min=3,alphanum"`
	Password        string `json:"password" binding:"required,min=8"`
	PasswordConfirm string `json:"password_confirm" binding:"required"`
	Email           string `json:"email" binding:"required,email"`

	CompanyID  int `json:"company_id" binding:"required"`
	LocationID int `json:"location_id" binding:"required"`
	RoleID     int `json:"role_id" binding:"required"`
}

Register contains registration request

func AccountCreate

func AccountCreate(c *gin.Context) (*Register, error)

AccountCreate validates account creation request

type UpdateUser

type UpdateUser struct {
	ID        int     `json:"-"`
	FirstName *string `json:"first_name,omitempty" binding:"omitempty,min=2"`
	LastName  *string `json:"last_name,omitempty" binding:"omitempty,min=2"`
	Mobile    *string `json:"mobile,omitempty"`
	Phone     *string `json:"phone,omitempty"`
	Address   *string `json:"address,omitempty"`
}

UpdateUser contains user update data from json request

func UserUpdate

func UserUpdate(c *gin.Context) (*UpdateUser, error)

UserUpdate validates user update request