httperrors

Documentation

Index

• Constants
• Variables
• type HTTPError
  • func NewHTTPError(code int, errorType string, title string) *HTTPError
  • func NewHTTPErrorWithDetail(code int, errorType string, title string, detail string) *HTTPError
  • func (e *HTTPError) Error() string
• type HTTPValidationError
  • func NewHTTPValidationError(code int, errorType string, title string, ...) *HTTPValidationError
  • func NewHTTPValidationErrorWithDetail(code int, errorType string, title string, ...) *HTTPValidationError
  • func (e *HTTPValidationError) Error() string

Constants

const (
	// HTTPErrorTypeGeneric represents the generic error type returned as default for all HTTP errors without a type defined.
	HTTPErrorTypeGeneric string = "generic"
)

Variables

var (
	ErrBadRequestInvalidPassword = NewHTTPErrorWithDetail(http.StatusBadRequest, "INVALID_PASSWORD", "The password provided was invalid", "Password was either too weak or did not match other criteria")
	ErrForbiddenNotLocalUser     = NewHTTPError(http.StatusForbidden, "NOT_LOCAL_USER", "User account is not valid for local authentication")
	ErrNotFoundTokenNotFound     = NewHTTPError(http.StatusNotFound, "TOKEN_NOT_FOUND", "Provided token was not found")
	ErrConflictTokenExpired      = NewHTTPError(http.StatusConflict, "TOKEN_EXPIRED", "Provided token has expired and is no longer valid")
	ErrConflictUserAlreadyExists = NewHTTPError(http.StatusConflict, "USER_ALREADY_EXISTS", "User with given username already exists")
)

Types

type HTTPError

type HTTPError struct {
	types.PublicHTTPError
	Internal       error                  `json:"-"`
	AdditionalData map[string]interface{} `json:"-"`
}

func NewHTTPError

func NewHTTPError(code int, errorType string, title string) *HTTPError

func NewHTTPErrorWithDetail

func NewHTTPErrorWithDetail(code int, errorType string, title string, detail string) *HTTPError

func (*HTTPError) Error

func (e *HTTPError) Error() string

type HTTPValidationError

type HTTPValidationError struct {
	types.PublicHTTPValidationError
	Internal       error                  `json:"-"`
	AdditionalData map[string]interface{} `json:"-"`
}

func NewHTTPValidationError

func NewHTTPValidationError(code int, errorType string, title string, validationErrors []*types.HTTPValidationErrorDetail) *HTTPValidationError

func NewHTTPValidationErrorWithDetail

func NewHTTPValidationErrorWithDetail(code int, errorType string, title string, validationErrors []*types.HTTPValidationErrorDetail, detail string) *HTTPValidationError

func (*HTTPValidationError) Error

func (e *HTTPValidationError) Error() string