package
0.0.0-20241212055342-bf028c80b18a
Repository: https://github.com/bytesbyharsh/go-my-info.git
Documentation: pkg.go.dev
# Functions
AddAccount godoc
@Summary Create Account @Description create new bank account @Tags Bank Accounts @Accept json @Produce json @Param account body models.AddBankAccountReq true "Bank Account Body" @Success 201 {object} models.BankAccount @Failure 400 {object} models.JSONerrResponse @Router /accounts/ [post].
No description provided by the author
CreateBank godoc
@Summary Create Bank @Description create a new bank @Tags Bank @Accept json @Produce json @Param page body models.CreateBankReq true "Create Bank Body" @Success 201 {object} models.Bank @Failure 400 {object} models.JSONerrResponse @Router /banks/register [post].
CreateUser godoc
@Summary Create User @Description create new user @Tags Users @Accept json @Produce json @Param user body models.CreateUserReq true "User Body" @Success 201 {object} models.User @Failure 400 {object} models.JSONerrResponse @Router /users/register [post].
CreateUserByAdmin godoc
@Summary Create User By Admin @Description create new user by admin @Tags Users @Accept json @Produce json @Param user body models.CreateUserByAdminReq true "User Body" @Success 201 {object} models.User @Failure 400 {object} models.JSONerrResponse @Router /users/add [post].
DbDeleteUser godoc
@Summary Delete user from DB @Description delete user from db by admin @Tags Users @Accept json @Produce json @Param username path string true "Username" @Success 201 {object} models.JSONerrResponse @Failure 400 {object} models.JSONerrResponse @Router /users/{username} [delete].
DeleteUser godoc
@Summary Delete user @Description delete user @Tags Users @Accept json @Produce json @Success 201 {object} models.JSONerrResponse @Failure 400 {object} models.JSONerrResponse @Router /users/me [delete].
GetAccount godoc
@Summary Get Account @Description get bank account details @Tags Bank Accounts @Accept json @Produce json @Param account_id path string true "Bank Account ID" @Success 201 {object} models.BankAccount @Failure 400 {object} models.JSONerrResponse @Router /accounts/{account_id} [get].
GetAllAccounts godoc
@Summary Get All Account @Description get all bank account @Tags Bank Accounts @Accept json @Produce json @Param page query int32 true "Page Number" @Param items_per_page query int32 true "Items Per Page" @Success 200 {object} models.PaginatedListResp[models.BankAccount] @Failure 400 {object} models.JSONerrResponse @Router /accounts/ [get].
No description provided by the author
GetAnotherUser godoc
@Summary Get User @Description get another user details @Tags Users @Accept json @Produce json @Param username path string true "Username" @Success 200 {object} models.User @Failure 400 {object} models.JSONerrResponse @Router /users/{username} [get].
GetBankList godoc
@Summary Get Bank List @Description get all bank list @Tags Bank @Accept json @Produce json @Param page query int32 true "Page Number" @Param items_per_page query int32 true "Items Per Page" @Success 200 {object} models.PaginatedListResp[models.Bank] @Failure 400 {object} models.JSONerrResponse @Router /banks/list [get].
No description provided by the author
GetUser godoc
@Summary Get User @Description get user details @Tags Users @Accept json @Produce json @Success 200 {object} models.User @Failure 400 {object} models.JSONerrResponse @Router /users/me [get].
GetUserList godoc
@Summary Get User List @Description user list @Tags Users @Accept json @Produce json @Param page query int32 true "Page Number" @Param items_per_page query int32 true "Items Per Page" @Success 200 {object} models.PaginatedListResp[models.User] @Failure 400 {object} models.JSONerrResponse @Router /users/list [get].
No description provided by the author
Hello godoc @Summary Hello API @Description get string by ID @Tags Ping @Produce json @Success 200 {object} models.JSONResp @Router / [get].
No description provided by the author
LoginUser godoc
@Summary Login User @Description get login token @Tags Authentication @Accept json @Produce json @Param login body models.AuthReq true "Login Body" @Success 201 {object} models.AuthResp @Failure 400 {object} models.JSONerrResponse @Router /users/login [post].
No description provided by the author
UpdateAccount godoc
@Summary Update Account @Description update bank account details @Tags Bank Accounts @Accept json @Produce json @Param account_id path string true "Bank Account ID" @Param account body models.UpdateBankAccountReq true "Bank Account Body" @Success 201 {object} models.JSONerrResponse @Failure 400 {object} models.JSONerrResponse @Router /accounts/{account_id} [put].
UpdateAnotherUser godoc
@Summary Create User By Admin @Description create new user by admin @Tags Users @Accept json @Produce json @Param username path string true "Username" @Param user body models.UpdateUserReq true "User Body" @Success 201 {object} models.JSONerrResponse @Failure 400 {object} models.JSONerrResponse @Router /users/{username} [post].
No description provided by the author
No description provided by the author
No description provided by the author
UpdateUser godoc
@Summary update User @Description update user details @Tags Users @Accept json @Produce json @Param user body models.UpdateUserReq true "User Body" @Success 201 {object} models.JSONerrResponse @Failure 400 {object} models.JSONerrResponse @Router /users/me [put].
UpdateUserPassword godoc
@Summary Update User Password @Description update user password @Tags Users @Accept json @Produce json @Param password body models.UpdatePasswordReq true "Password Body" @Success 201 {object} models.JSONerrResponse @Failure 400 {object} models.JSONerrResponse @Router /users/me/password [put].
# Constants
No description provided by the author
No description provided by the author