bulk

Documentation

Index

• Constants
• func ClassifyError(err error) string
• type ReadRequest
  • func (r ReadRequest) OK() error
• type ResponseError
  • func NewResponseError(err error) *ResponseError

Constants

const (
	// ErrorNotFound indicates the given resource was not found.
	ErrorNotFound = "NotFound"
	//ErrorForbidden indicates the given resource was not accessible by the user making the request.
	ErrorForbidden = "Forbidden"
	// ErrorInternalServerError indicates a server side error occured.
	ErrorInternalServerError = "InternalServerError"
)

Error categories.

Functions

func ClassifyError

func ClassifyError(err error) string

ClassifyError takes an error and tries to bucket it into one of the error categories.

Types

type ReadRequest

type ReadRequest struct {
	IDs []string `json:"ids"`
}

ReadRequest is a request to read multiple IDs of a single resource type.

func (ReadRequest) OK

func (r ReadRequest) OK() error

OK validates the request.

type ResponseError

type ResponseError struct {
	Message string `json:"message"`
	Type    string `json:"type"`
}

ResponseError captures information about an error for a specific resource.

func NewResponseError

func NewResponseError(err error) *ResponseError

NewResponseError initializes a NewResponseError