apierrors

Documentation

Index

• type APIError
  • func NewAPIError(status int, err error) *APIError
  • func NewBadRequestError(err error) *APIError
  • func NewInternalServerError(err error) *APIError
  • func NewNotFoundError(err error) *APIError
  • func NewUnauthorizedError(err error) *APIError
  • func (e *APIError) Error() string

Types

type APIError

type APIError struct {
	// The timestamp of the error.
	// in: body
	// required: true
	Timestamp string `json:"timestamp"`
	// The HTTP status code.
	// in: body
	// required: true
	Status int `json:"status"`
	// The status error message.
	// in: body
	// required: true
	ErrMsg string `json:"error"`
	// The error message.
	// in: body
	// required: true
	Message string `json:"message"`
}

APIError is the error response for the API.

swagger:model APIError

func NewAPIError

func NewAPIError(status int, err error) *APIError

NewAPIError returns a new APIError.

func NewBadRequestError

func NewBadRequestError(err error) *APIError

NewBadRequestError returns a new bad request error.

func NewInternalServerError

func NewInternalServerError(err error) *APIError

NewInternalServerError returns a new internal server error.

func NewNotFoundError

func NewNotFoundError(err error) *APIError

NewNotFoundError returns a new not found error.

func NewUnauthorizedError

func NewUnauthorizedError(err error) *APIError

NewUnauthorizedError returns a new unauthorized error.

func (*APIError) Error

func (e *APIError) Error() string