errors

Documentation

Index

• type APIError
  • func New(defaults *APIError, overrides *APIError) *APIError
  • func NewInternalError(overrides *APIError) *APIError
  • func NewUnauthorizedError(overrides *APIError) *APIError

Types

type APIError

type APIError struct {
	Name       string `json:"name"`
	AppCode    string `json:"appCode,omitempty"`
	StatusCode int    `json:"statusCode"`
	Detail     string `json:"detail"`
	Pointer    string `json:"pointer"`
}

APIError is the generic structure for any api error

func New

func New(defaults *APIError, overrides *APIError) *APIError

New instantiates a new error from the inputted map of values

func NewInternalError

func NewInternalError(overrides *APIError) *APIError

NewInternalError instantiates a new internal error instance, populating defaults

func NewUnauthorizedError

func NewUnauthorizedError(overrides *APIError) *APIError

NewUnauthorizedError instantiates a new unauthorized error instance, populating defaults