commons

Documentation

Index

• Constants
• func IsEmpty(str string) bool
• func MakeResp(payload interface{}, code string, err error) []byte
• func ToString(value url.Values) string
• func Validate(entity interface{}) (bool, error)
• func ValidateID(fctx *FlowContext, id string) ([]string, bool)
• func ValidatePaginationParams(fctx *FlowContext, limit string, offset string) ([]string, bool)
• type APIError
• type FlowContext
• type Response
  • func ToResponse(payload interface{}, code string, error error) *Response

Constants

const (
	Empty       = ""
	EnvVariable = "ENVIRONMENT"
	Ok          = "ok"
	TrackingID  = "TrackingID"
)

const (
	Dev            = "Dev"
	Qa             = "Qa"
	Prod           = "Prod"
	DevConfigPath  = "config_dev"
	QaConfigPath   = "config_qa"
	ProdConfigPath = "config"
	ConfigDir      = "./config"
)

Config Viper

const (
	GreenStatus = "green"
	AmberStatus = "amber"
	RedStatus   = "red"
)

Heartbeat Status

const (
	CandidateColl = "candidates"
	CandidateDb   = "core_db"
)

Mongo

const InvalidRequestBody = "InvalidRequestBody"

const InvalidRequestParameter = "InvalidRequestParameter"

Functions

func IsEmpty

func IsEmpty(str string) bool

IsEmpty checks for empty string

func MakeResp

func MakeResp(payload interface{}, code string, err error) []byte

MakeResp generates response in slice of byte

func ToString

func ToString(value url.Values) string

func Validate

func Validate(entity interface{}) (bool, error)

func ValidateID

func ValidateID(fctx *FlowContext, id string) ([]string, bool)

ValidateID to validates id

func ValidatePaginationParams

func ValidatePaginationParams(fctx *FlowContext, limit string, offset string) ([]string, bool)

ValidatePaginationParams to validates pagination parameters

Types

type APIError

type APIError struct {
	Code     string
	Message  string
	Metadata interface{}
}

type FlowContext

type FlowContext struct {
	TrackingID string
}

type Response

type Response struct {
	Data  interface{}
	Error *APIError
}

func ToResponse

func ToResponse(payload interface{}, code string, error error) *Response

ToResponse generates standard response