apierrors

Documentation

Index

• Variables
• type APIError
• type FieldErrors
  • func SingleFieldError(message, code string) FieldErrors
• type RequestError

Variables

var (
	InternalAPIError APIError = APIError{
		Message: "Internal Server Error",
		Code:    "internal_error",
	}
	MissingFieldError FieldErrors = FieldErrors{
		APIError{
			Message: "This field is required.",
			Code:    "required",
		}}
)

Types

type APIError

type APIError struct {
	Message string `json:"message"`
	Code    string `json:"code"`
}

type FieldErrors

type FieldErrors []APIError

func SingleFieldError

func SingleFieldError(message, code string) FieldErrors

type RequestError

type RequestError struct {
	Message string                 `json:"message"`
	Code    string                 `json:"status"`
	Errors  map[string]FieldErrors `json:"errors,omitempty"`
}

RequestError is returned when the API has errors not associated with the request content