api

Documentation

Index

• Variables
• func HTTPErrorResponse(response *http.Response, err error) error
• func RequestRetry(c *http.Client, req *http.Request) (*http.Response, error)
• type ContextKey
• type Error
  • func (e *Error) Error() string
• type Errors
• type GenericErrorResponse

Variables

var (
	ErrFileNotFound       = stderrors.New("File not found")
	ForbiddenErr    error = &Error{
		StatusCode: 403,
		Err:        stderrors.New("403 Forbidden"),
	}
	UnavailableErr error = &Error{
		StatusCode: 503,
		Err:        stderrors.New("503 Service Unavailable"),
	}
)

Functions

func HTTPErrorResponse

func HTTPErrorResponse(response *http.Response, err error) error

func RequestRetry

func RequestRetry(c *http.Client, req *http.Request) (*http.Response, error)

Types

type ContextKey

type ContextKey string

const ContextAcceptValue ContextKey = "Accept"

type Error

type Error struct {
	StatusCode int
	Err        error
	RequestURL *string
	Errors     []error
}

func (*Error) Error

func (e *Error) Error() string

type Errors

type Errors struct {
	Field   string `json:"field,omitempty"`
	Message string `json:"message,omitempty"`
}

type GenericErrorResponse

type GenericErrorResponse struct {
	ID      string   `json:"id,omitempty"`
	Message string   `json:"message,omitempty"`
	Errors  []Errors `json:"errors,omitempty"`
}