api

type CtxKey struct{}

type DependencyManager interface {
	// AddProvider adds a new dependecy provider
	AddProvider(name, value interface{})

	// DeleteProvider deletes a dependecy provider
	DeleteProvider(name interface{})
}

type Module struct {
	// Name is the name of the module
	Name string

	// Setup is the setup function called when the module should
	// mount on the Router
	Setup SetupModuleFunc
}

type PropertyError struct {
	// Field is the name of the property that caused the error
	Field string `json:"field"`

	// Description is the description of the error
	Description string `json:"message"`
}

type Router interface {
	http.Handler

	gin.IRouter

	// GetKey returns a service from the router
	GetKey(name interface{}) interface{}

	// Engine returns the underlying gin.Engine
	Engine() *gin.Engine

	// PrivateOnly returns a gin.HandlerFunc that makes
	// an endpoint private (i.e. only accessible by other micro
	// services)
	PrivateOnly() gin.HandlerFunc

	// Log returns a logging instance
	Log() log.Interface

	// AbortRequest aborts the given HTTP request with status and logs the error
	// message. If status is 0 AbortRequest will try to determine the status
	// code on it's own
	AbortRequest(ctx *gin.Context, status int, err error)
}

type RouterOption func(Router) error

type SetupModuleFunc func(router Router) error

type ValidationError struct {
	// Fields holds all field/property errors
	Fields []*PropertyError `json:"errors"`
}