shared

Documentation

Index

• Constants
• func ApiOutputAbort(c *gin.Context, err error)
• func ApiOutputError(c *gin.Context, err error)
• func ApiOutputSuccess(c *gin.Context, body interface{}, status int)
• func GetUser(c *gin.Context) (*common.User, bool)
• type ApiBody
• type ResponsePipelines
• type TypedApiBody

Constants

const BadRequestBody = "bad request body format"

Functions

func ApiOutputAbort

func ApiOutputAbort(c *gin.Context, err error)

ApiOutputAbort writes the HTTP response code header and saves the error internally, but doesn't push it to the response

func ApiOutputError

func ApiOutputError(c *gin.Context, err error)

ApiOutputError writes a JSON error message to the HTTP response body

func ApiOutputSuccess

func ApiOutputSuccess(c *gin.Context, body interface{}, status int)

ApiOutputSuccess writes a JSON success message to the HTTP response body

func GetUser

func GetUser(c *gin.Context) (*common.User, bool)

Types

type ApiBody

type ApiBody TypedApiBody[interface{}]

type ResponsePipelines

type ResponsePipelines struct {
	Count     int64              `json:"count"`
	Pipelines []*models.Pipeline `json:"pipelines"`
}

type TypedApiBody

type TypedApiBody[T any] struct {
	Success bool     `json:"success"`
	Message string   `json:"message"`
	Causes  []string `json:"causes"`
	Data    T        `json:"data"`
}