api

Documentation

Index

• Variables
• type Error
• type Response
  • func ErrorResponse(errors []Error) *Response
  • func SuccessResponse(payload interface{}) *Response

Variables

var (
	ErrorAuthForbidden = Error{
		Type:  "auth",
		Error: "forbidden",
	}

	ErrorNotAllowed = Error{
		Type:  "access",
		Error: "not allowed",
	}

	ErrorUrlInvalid = Error{
		Type:  "query",
		Field: "url",
		Error: "invalid",
	}

	ErrorHashInvalid = Error{
		Type:  "query",
		Field: "md5",
		Error: "invalid",
	}
)

var EmptyPayload interface{}

Types

type Error

type Error struct {
	Type  string `json:"type"`
	Field string `json:"field,omitempty"`
	Error string `json:"error"`
}

type Response

type Response struct {
	Success   bool        `json:"success"`
	Errors    []Error     `json:"errors,omitempty"`
	Payload   interface{} `json:"payload,omitempty"`
	Timestamp int64       `json:"ts,omitempty"`
}

func ErrorResponse

func ErrorResponse(errors []Error) *Response

func SuccessResponse

func SuccessResponse(payload interface{}) *Response