apierror

README

apierror

A common package for mapping API errors.

Author

E Camden Fisher camden.fisher@yale.edu

License

GNU Affero General Public License v3.0 (GNU AGPLv3) Copyright (c) 2020 Yale University

Documentation

Index

• Constants
• type Error
  • func New(code, message string, err error) Error
  • func (e Error) Error() string
  • func (e Error) String() string
  • func (e Error) Unwrap() error

Constants

const ErrBadRequest = "BadRequest"

ErrBadRequest indicates a bad request or input

const ErrConflict = "Conflict"

ErrConflict indicates a conflict with an existing resource

const ErrForbidden = "Forbidden"

ErrForbidden indicates a lack of permissions for the given resource

const ErrInternalError = "InternalError"

ErrInternalError indicates an unknown internal error occurred

const ErrLimitExceeded = "LimitExceeded"

ErrLimitExceeded indicates a service or rate limit has been exceeded

const ErrNotFound = "NotFound"

ErrNotFound indicates a the requested object is missing/not found

const ErrServiceUnavailable = "ServiceUnavailable"

ErrServiceUnavailable indicates an internal or external service is not available

Types

type Error

type Error struct {
	Code    string
	Message string
	OrigErr error
}

Error wraps lower level errors with code, message and an original error. This is modelled after the awserr with the intention of standardizing the output.

func New

func New(code, message string, err error) Error

New constructs an Error and returns it as an error

func (Error) Error

func (e Error) Error() string

Error Satisfies the Error interface

func (Error) String

func (e Error) String() string

String returns the error as string

func (Error) Unwrap

func (e Error) Unwrap() error