api

Documentation

Index

• Variables
• func BasicAuthValidator(basicAuthUser string, basicAuthPassword string) middleware.BasicAuthValidator
• func CustomErrorHandler[E ApiError](errorHandler ErrorHandler[E]) func(error, echo.Context)
• func LogHttpError(logger *logrus.Entry, path string, code int, err error)
• type ApiError
• type Error
  • func Errorf(code string, format string, args ...any) Error
  • func (e Error) Error() string
  • func (e Error) ToErrorResponse() ErrorResponse
  • func (e Error) Unwrap() error
  • func (e Error) WithBaseError(err error) Error
  • func (e Error) WithDescription(format string, args ...any) Error
• type ErrorHandler
  • func (eh *ErrorHandler[E]) HandleError(ctx context.Context, c echo.Context, err error)
• type ErrorResponse
  • func NewErrorResponse(errorCode string, errorDescription string, field string, ...) ErrorResponse
  • func (e ErrorResponse) Error() string
• type SiteId
  • func GetSiteFromHeader(header http.Header) (SiteId, error)
  • func (s SiteId) ToLower() SiteId
  • func (s SiteId) ToUpper() SiteId

Variables

var (
	ErrSiteMissing         = Error{ErrorCode: "SITE_MISSING", ErrorDescription: "missing site", HttpStatusCode: http.StatusBadRequest}
	ErrUnknown             = Error{ErrorCode: "UNKNOWN_ERROR", ErrorDescription: "error is unknown", HttpStatusCode: http.StatusInternalServerError}
	ErrTimeout             = Error{ErrorCode: "TIMEOUT", ErrorDescription: "request timeout", HttpStatusCode: 499}
	ErrInternalServerError = Error{ErrorCode: "INTERNAL_SERVER_ERROR", ErrorDescription: "internal server error", HttpStatusCode: http.StatusInternalServerError}
)

Functions

func BasicAuthValidator

func BasicAuthValidator(basicAuthUser string, basicAuthPassword string) middleware.BasicAuthValidator

func CustomErrorHandler

func CustomErrorHandler[E ApiError](errorHandler ErrorHandler[E]) func(error, echo.Context)

func LogHttpError

func LogHttpError(logger *logrus.Entry, path string, code int, err error)

LogHttpError logs errors with a different log level depending on the http status code.

Types

type ApiError

type ApiError interface {
	error
	ToErrorResponse() ErrorResponse
}

type Error

type Error struct {
	ErrorCode        string                  `json:"errorCode"`
	ErrorDescription string                  `json:"errorDescription"`
	Field            *string                 `json:"field,omitempty"`
	Info             *map[string]interface{} `json:"info,omitempty"`
	HttpStatusCode   int                     `json:"-"`
	BaseError        error                   `json:"-"`
}

func Errorf

func Errorf(code string, format string, args ...any) Error

func (Error) Error

func (e Error) Error() string

func (Error) ToErrorResponse

func (e Error) ToErrorResponse() ErrorResponse

func (Error) Unwrap

func (e Error) Unwrap() error

func (Error) WithBaseError

func (e Error) WithBaseError(err error) Error

func (Error) WithDescription

func (e Error) WithDescription(format string, args ...any) Error

type ErrorHandler

type ErrorHandler[E ApiError] struct {
	UnknownError   func(msg string) error
	TimeoutError   func(msg string) ApiError
	HttpStatusFrom func(ctx context.Context, err error) int
	ToApiError     func(err error) E
}

func (*ErrorHandler[E]) HandleError

func (eh *ErrorHandler[E]) HandleError(ctx context.Context, c echo.Context, err error)

type ErrorResponse

type ErrorResponse struct {
	MainError Error   `json:"mainError"`
	AllErrors []Error `json:"allErrors"`
}

func NewErrorResponse

func NewErrorResponse(errorCode string, errorDescription string, field string, info map[string]interface{}) ErrorResponse

func (ErrorResponse) Error

func (e ErrorResponse) Error() string

type SiteId

type SiteId string

func GetSiteFromHeader

func GetSiteFromHeader(header http.Header) (SiteId, error)

func (SiteId) ToLower

func (s SiteId) ToLower() SiteId

func (SiteId) ToUpper

func (s SiteId) ToUpper() SiteId