resterrors

Documentation

Index

• Variables
• type Detail
  • func (d *Detail) Copy() *Detail
• type Error
  • func (r *Error) AddDetailInfo(infos ...string)
  • func (r *Error) AddLink(urlBase string) error
  • func (r *Error) Compare(err Error) bool
  • func (r *Error) Error() string
  • func (r Error) New() *Error
• type ErrorLink

Variables

var (
	ErrWarning = Error{
		Code: "WAR001", Title: "Warning",
		Detail: &Detail{Title: "The warning notification occured."},
		Status: "200",
	}

	// STATUS 400 - CODE: 'BRQXXX'
	ErrHeadersNotSupported = Error{
		Code: "BRQ001", Title: "Condition headers not supported",
		Detail: &Detail{Title: `The conditional headers provided in the request are not supported, by the server.`},
		Status: "400",
	}

	ErrInvalidAuthenticationInfo = Error{
		Code: "BRQ002", Title: "Invalid authentication info",
		Detail: &Detail{Title: `The authentication information was not provided in the correct format. 
			Verify the value of Authorization header.`},
		Status: "400",
	}

	ErrInvalidHeaderValue = Error{
		Code: "BRQ003", Title: "Invalid header value",
		Detail: &Detail{Title: "The value provided in one of the HTTP headers was not in the correct format."},
		Status: "400",
	}

	ErrInvalidInput = Error{
		Code: "BRQ004", Title: "Invalid input",
		Detail: &Detail{Title: "One of the request inputs is not valid."},
		Status: "400",
	}

	ErrInvalidQueryParameter = Error{
		Code: "BRQ005", Title: "Invalid query parameter value",
		Detail: &Detail{Title: "An invalid value was specified for one of the query parameters in the request URI"},
		Status: "400",
	}

	ErrInvalidResourceName = Error{
		Code: "BRQ006", Title: "Invalid resource name",
		Detail: &Detail{Title: "The specified resource name contains invalid characters"},
		Status: "400",
	}

	ErrInvalidURI = Error{
		Code: "BRQ007", Title: "Invalid URI",
		Detail: &Detail{Title: "The requested URI does not represent any resource on the server"},
		Status: "400",
	}

	ErrInvalidJSONDocument = Error{
		Code: "BRQ008", Title: "Invalid JSON document",
		Detail: &Detail{Title: "The specified JSON is not syntatically valid."},
		Status: "400",
	}

	ErrInvalidJSONFieldValue = Error{
		Code: "BRQ009", Title: "Invalid JSON field value",
		Detail: &Detail{Title: "The value provided for one of the JSON fields in the requested body was not in the correct format"},
		Status: "400",
	}

	ErrMD5Mismatch = Error{
		Code: "BRQ010", Title: "MD5 mismatch",
		Detail: &Detail{Title: "The MD5 value specified in the request did not match the MD5 value calculated by the server"},
		Status: "400",
	}

	ErrMetadataTooLarge = Error{
		Code: "BRQ011", Title: "Metadata too large",
		Detail: &Detail{Title: "The size of the specified metada exceeds the maximum size permitted"},
		Status: "400",
	}

	ErrMissingRequiredQueryParam = Error{
		Code: "BRQ012", Title: "Missing required query parameter",
		Detail: &Detail{Title: "A required query parameter was not specified for this request"},
		Status: "400",
	}

	ErrMissingRequiredHeader = Error{
		Code: "BRQ013", Title: "Missing required header",
		Detail: &Detail{Title: "A required HTTP header was not specified"},
		Status: "400",
	}

	ErrMissingRequiredJSONField = Error{
		Code: "BRQ014", Title: "Missing required JSON field",
		Detail: &Detail{Title: "A required JSON field was not specified in the request body"},
		Status: "400",
	}

	ErrOutOfRangeInput = Error{
		Code: "BRQ015", Title: "Request input out of range",
		Detail: &Detail{Title: "One of the request inputs is out of range"},
		Status: "400",
	}

	ErrOutOfRangeQueryParameterValue = Error{
		Code: "BRQ016", Title: "Query parameter value out of range",
		Detail: &Detail{Title: "A query parameter specified in the request URI is outside the permissible range"},
		Status: "400",
	}

	ErrUnsupportedHeader = Error{
		Code: "BRQ017", Title: "Unsupported header",
		Detail: &Detail{Title: "One of the HTTP headers specified in the request is not supported"},
		Status: "400",
	}

	ErrUnsupportedJSONField = Error{
		Code: "BRQ018", Title: "Unsupported JSON field.",
		Detail: &Detail{Title: "One of the JSON fields specified in the request body is not supported."},
		Status: "400",
	}

	ErrUnsupportedQueryParameter = Error{
		Code: "BRQ019", Title: "Unsupported query parameter.",
		Detail: &Detail{Title: "One of the query parameters in the request URI is not supported"},
		Status: "400",
	}

	// STATUS 403, CODE: 'AUTHXX'
	ErrAccountDisabled = Error{
		Code: "AUTH01", Title: "Accound disabled",
		Detail: &Detail{Title: "The specified account is disabled"},
		Status: "403",
	}

	ErrAuthenticationFailed = Error{
		Code: "AUTH02", Title: "Authentication failed",
		Detail: &Detail{Title: `Server failed to authenticate the request. Make sure the value of 
		Authorization header is formed correctly including the signature`},
		Status: "403",
	}

	ErrInsufficientAccPerm = Error{
		Code: "AUTH03", Title: "Insufficient account permissions",
		Detail: &Detail{Title: "The account being accessed does not have sufficient permissions to execute this operation."},
		Status: "403",
	}
	ErrAuthInvalidCredentials = Error{
		Code: "AUTH04", Title: "Invalid credentials",
		Detail: &Detail{Title: "Access is denied due to invalid credentials."},
		Status: "403",
	}

	// STATUS 404, CODE: 'NTFXXX'
	ErrResourceNotFound = Error{
		Code: "NTF001", Title: "Resource not found.",
		Detail: &Detail{Title: "The specified resource does not exists."},
		Status: "404",
	}

	// STATUS 405, CODE: "MNAXXX"
	ErrMethodNotAllowed = Error{
		Code: "MNA001", Title: "Unsupported http verb",
		Detail: &Detail{Title: "The resource doesn't support the specified HTTP verb."},
		Status: "405",
	}

	// STATUS 409, CODE: "CON001"
	ErrAccountAlreadyExists = Error{
		Code: "CON001", Title: "Account already exists",
		Detail: &Detail{Title: "The Specified account already exists"},
		Status: "409",
	}

	ErrResourceAlreadyExists = Error{
		Code: "CON002", Title: "Resource already exists.",
		Detail: &Detail{Title: "The specified resource already exists."},
		Status: "409",
	}

	// STATUS 413, CODE: 'RTLXXX'
	ErrRequestBodyTooLarge = Error{
		Code: "RTL001", Title: "Request body too large.",
		Detail: &Detail{Title: "The size of the request body exceeds the maximum size permitted"},
		Status: "413",
	}

	// STATUS 500, CODE: 'INTXXX'
	ErrInternalError = Error{
		Code: "INT001", Title: "Internal server error",
		Detail: &Detail{Title: "The server encountered an internal error. Please retry the request."},
		Status: "500",
	}

	ErrOperatinTimedOut = Error{
		Code: "INT002", Title: "Operation timed out",
		Detail: &Detail{Title: "The operation could not be completed within the permitted time"},
		Status: "500",
	}

	// STATUS 503, CODE: 'UNAVXX'
	ErrServerBusy1 = Error{
		Code: "UNAV01", Title: "Server busy",
		Detail: &Detail{Title: "The server is currently unable to receive requests. Please retry your request."},
		Status: "503",
	}
	ErrServerBusy2 = Error{
		Code: "UNAV02", Title: "Server busy",
		Detail: &Detail{Title: "Operations per second is over the account limit"},
		Status: "503",
	}
)

List of REST API errors

var (
	ErrNilPointerProvided = errors.New("Provided nil pointer")
	ErrPtrNotProvided     = errors.New("Provided arugment is raw struct type. Provide a pointer to struct")
	ErrUnknownType        = errors.New("Unknown type of the field")
)

Types

type Detail

type Detail struct {
	Title string   `json:"title,omitempty"`
	Info  []string `json:"info,omitempty"`
}

Detail contains human readable detailed information about the specific problem If more specific information is available, it may be stored in the 'Info' field.

func (*Detail) Copy

func (d *Detail) Copy() *Detail

Copy creates a copy of the Detail entity

type Error

type Error struct {
	// ID is a unique identifier for this particular occurence of the problem
	ID string `json:"id,omitempty"`

	// Links contains the the link that leads to further details about this particular occurrence
	// of the problem
	Links *ErrorLink `json:"links,omitempty"`

	// Status is the HTTP status code applicable to this problem, expressed as a string value.
	Status string `json:"status,omitempty"`

	// Code is an application-specific code, expressed as code
	Code string `json:"code,omitempty"`

	// Title is a short human-readable summary of the problem. SHOULD NOT change from occurrence to
	// occurrence of the problem
	Title string `json:"title,omitempty"`

	// Detail is a human-readable explanation of the problem that SHOULD describe specific
	// occurrence of the problem.
	Detail *Detail `json:"detail,omitempty"`
}

Error represents full JSON-API error. It's easier to

func (*Error) AddDetailInfo

func (r *Error) AddDetailInfo(infos ...string)

AddDetailInfo appends the provided 'infos' argument to the given Error's Detail field. If the Detail field is nil the new Detail entity would be created.

func (*Error) AddLink

func (r *Error) AddLink(urlBase string) error

AddLink adds the link to the Error Category. Parameters: - urlBase - string representing the url link to the error category The method checks if the urlBase is a correct url and then appends the error category code to the urlBase

func (*Error) Compare

func (r *Error) Compare(err Error) bool

Compare compares the given Error entity with an Error prototype 'err' If both error and prototype has the same code the method returns 'true'.

func (*Error) Error

func (r *Error) Error() string

Error implements error interface

func (Error) New

func (r Error) New() *Error

New creates new *Error entity that is a copy of given Error prototype.

type ErrorLink

type ErrorLink struct {
	About string `json:"about"`
}

ErrorLink is an object that contains link that leads to further details about this particular occurrence of the problem.