errors

Documentation

Index

• func MapToUserFacing(err error, resp *http.Response) error
• type APIError
  • func (e *APIError) Error() string

Functions

func MapToUserFacing

func MapToUserFacing(err error, resp *http.Response) error

MapToUserFacing maps the error to a custom user facing error type.

Types

type APIError

type APIError struct {
	HttpStatusCode int
	Code           string // A short string representing the reported error. Can be used to handle errors programmatically.
	Message        string // A human-readable message providing more details about the error.
	CorrelationId  string // A correlation ID that can be used to help debug the error.
}

APIError is a custom error type for API errors.

func (*APIError) Error

func (e *APIError) Error() string