response

Documentation

Index

• Constants
• func BadRequest(c *gin.Context, additionalReasons ...string)
• func Conflict(c *gin.Context, reason string)
• func Forbidden(c *gin.Context, additionalReasons ...string)
• func InternalError(c *gin.Context)
• func NotFound(c *gin.Context)
• func Ok(c *gin.Context, data interface{})
• type BasicApiResponse
• type BasicApiResponseError
  • func NewApiErrorResponse(errors []string) BasicApiResponseError
• type BasicApiResponseOk
  • func NewApiOkResponse(data interface{}) BasicApiResponseOk

Constants

const (
	ErrorBadRequest                         = "ERR_BAD_REQUEST"
	ErrorDuplicateUsername                  = "ERR_DUPLICATE_USERNAME"
	ErrorInternal                           = "ERR_INTERNAL"
	ErrorNotFound                           = "ERR_NOT_FOUND"
	ErrorForbidden                          = "ERR_FORBIDDEN"
	ErrorPasswordRequirementsNotMet         = "ERR_PASSWORD_REQUIREMENTS_NOT_MET"
	ErrorNoValidBearerSupplied              = "ERR_NO_VALID_BEARER_SUPPLIED"
	ErrorCardTextInvalid                    = "ERR_CARD_TEXT_INVALID"
	ErrorDeckOfficialButNotAdmin            = "ERR_DECK_OFFICIAL_BUT_NOT_ADMIN"
	ErrorCardAmountInvalid                  = "ERR_CARD_AMOUNT_INVALID"
	ErrorValidGameServerAccessTokenRequired = "ERR_VALID_GS_ACCESS_TOKEN_REQUIRED"
)

Functions

func BadRequest

func BadRequest(c *gin.Context, additionalReasons ...string)

func Conflict

func Conflict(c *gin.Context, reason string)

func Forbidden

func Forbidden(c *gin.Context, additionalReasons ...string)

func InternalError

func InternalError(c *gin.Context)

func NotFound

func NotFound(c *gin.Context)

func Ok

func Ok(c *gin.Context, data interface{})

Types

type BasicApiResponse

type BasicApiResponse struct {
	ErrorOccurred bool `json:"err"`
}

Every response from the api contains this.

type BasicApiResponseError

type BasicApiResponseError struct {
	BasicApiResponse
	Errors []string `json:"errors"`
}

Every error response from the api is in this format.

func NewApiErrorResponse

func NewApiErrorResponse(errors []string) BasicApiResponseError

Returns an instance of BasicApiResponseError which is with the supplied errors.

type BasicApiResponseOk

type BasicApiResponseOk struct {
	BasicApiResponse
	Data interface{} `json:"data"`
}

Every response that is ok/was successful from the api is in this format.

func NewApiOkResponse

func NewApiOkResponse(data interface{}) BasicApiResponseOk

Returns an instance of BasicApiResponseOk which is with the supplied parameters.