Documentation
¶
Index ¶
- func Attribute() func(c *gin.Context)
- func CalcSumOfTwo() func(c *gin.Context)
- func CreateUser(db *pgxpool.Pool) func(c *gin.Context)
- func DeleteUser(db *pgxpool.Pool) func(c *gin.Context)
- func GetAccountIDInGroup() func(c *gin.Context)
- func GetAllUsers(db *pgxpool.Pool) func(c *gin.Context)
- func GetPong() func(c *gin.Context)
- func GetSpecificUser(db *pgxpool.Pool) func(c *gin.Context)
- func ReplaceUser(db *pgxpool.Pool) func(c *gin.Context)
- func Securities() func(c *gin.Context)
- func UpdateUser(db *pgxpool.Pool) func(c *gin.Context)
- func UseHeader() func(c *gin.Context)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Attribute ¶
Attribute godoc @Summary attribute example @Description attribute @Tags examples @Accept json @Produce json @Param enumstring query string false "string enums" Enums(A, B, C) @Param enumint query int false "int enums" Enums(1, 2, 3) @Param enumnumber query number false "int enums" Enums(1.1, 1.2, 1.3) @Param string query string false "string valid" minlength(5) maxlength(10) @Param int query int false "int valid" mininum(1) maxinum(10) @Param default query string false "string default" default(A) @Success 200 {string} string "answer" @Failure 400 {string} string "ok" @Failure 404 {string} string "ok" @Failure 500 {string} string "ok" @Router /v0alpha/examples/attribute [get]
func CalcSumOfTwo ¶
CalcSumOfTwo godoc @Summary calc example @Description plus @Tags examples @Accept json @Produce json @Param val1 query int true "used for calc" @Param val2 query int true "used for calc" @Success 200 {integer} string "answer" @Failure 400 {string} string "ok" @Failure 404 {string} string "ok" @Failure 500 {string} string "ok" @Router /v0alpha/examples/calc [get]
func CreateUser ¶
CreateUser godoc @Summary creates a database entry for the user @Description creates user @Tags user crud @Accept json @Produce json @Param UserRequest body model.UserRequest false "User's data" @Success 201 {object} model.UserResponse @Failure 500 {object} common.HTTPError @Router /v0alpha/crud/users [post]
func DeleteUser ¶
DeleteUser godoc @Summary delete a database entry for the user @Description delete a user @Tags user crud @Accept json @Produce json @Param user_id path string true "User GUID" @Success 204 "" @Failure 400 {object} common.HTTPError @Failure 500 {object} common.HTTPError @Router /v0alpha/crud/users/{user_id} [delete]
func GetAccountIDInGroup ¶
GetAccountIDInGroup godoc @Summary path params example @Description path params @Tags examples @Accept json @Produce json @Param group_id path int true "Group ID" @Param account_id path int true "Account ID" @Success 200 {string} string "answer" @Failure 400 {string} string "ok" @Failure 404 {string} string "ok" @Failure 500 {string} string "ok" @Router /v0alpha/examples/groups/{group_id}/accounts/{account_id} [get]
func GetAllUsers ¶
GetAllUsers godoc @Summary fetches all users from the database @Description fetch all users @Tags user crud @Produce json @Success 200 {object} model.UserResponse[] @Failure 400 {object} common.HTTPError @Failure 500 {object} common.HTTPError @Router /v0alpha/crud/users [get]
func GetPong ¶
GetPong godoc @Summary Get pong @Description display pong @Produce json @Success 200 {string} string "pong" @Router /v0alpha/ping [get]
func GetSpecificUser ¶
GetSpecificUser godoc @Summary fetches a user from the database given the user's GUID @Description fetch a user's data @Tags user crud @Accept json @Produce json @Param user_id path string true "User GUID" @Success 200 {object} model.UserResponse @Failure 400 {object} common.HTTPError @Failure 500 {object} common.HTTPError @Router /v0alpha/crud/users/{user_id} [get]
func ReplaceUser ¶
ReplaceUser godoc @Summary replaces a database entry for the user @Description replace user @Tags user crud @Accept json @Produce json @Param user_id path string true "User GUID" @Param UserRequest body model.UserRequest false "User's data" @Success 200 {object} model.UserResponse @Failure 400 {object} common.HTTPError @Failure 500 {object} common.HTTPError @Router /v0alpha/crud/users/{user_id} [put]
func Securities ¶
Securities godoc @Summary custome header example @Description custome header @Tags examples @Accept json @Produce json @Param Authorization header string true "Authentication header" @Success 200 {string} string "answer" @Failure 400 {string} string "ok" @Failure 404 {string} string "ok" @Failure 500 {string} string "ok" @Security ApiKeyAuth @Security OAuth2Implicit[admin, write] @Router /v0alpha/examples/securities [get]
func UpdateUser ¶
UpdateUser godoc @Summary updates a database entry for the user @Description update a user's database entry @Tags user crud @Accept json @Produce json @Param user_id path string true "User GUID" @Param UserRequest body model.UserRequest false "User's data" @Success 200 {object} model.UserResponse @Failure 400 {object} common.HTTPError @Failure 500 {object} common.HTTPError @Router /v0alpha/crud/users/{user_id} [patch]
func UseHeader ¶
UseHeader godoc @Summary custome header example @Description custome header @Tags examples @Accept json @Produce json @Param Authorization header string true "Authentication header" @Success 200 {string} string "answer" @Failure 400 {string} string "ok" @Failure 404 {string} string "ok" @Failure 500 {string} string "ok" @Router /v0alpha/examples/header [get]
Types ¶
This section is empty.
Source Files