api

type ClientTLS struct {
	CertBundle certutil.CertBundle
	AuthType   tls.ClientAuthType
}

type Context interface {
	echo.Context
	context.Context
	Is(method, path string)
}

type Endpoint struct {
	Protocol string
	Host     string
	Port     uint
	Path     string
}

type ErrorBody struct {
	Origin  error      `json:"-"`                // keep the original error to trace the stack
	Source  string     `json:"source,omitempty"` // source
	Status  int        `json:"status,omitempty"` // http status code
	Code    string     `json:"code,omitempty"`   // customized error code
	Kind    string     `json:"kind,omitempty"`   // error category
	Message string     `json:"message,omitempty"`
	Details labels.Set `json:"details,omitempty"`
}

type Handler struct {
	Method      string          `json:"method"`
	Path        string          `json:"path"`
	Middlewares []string        `json:"middlewares"`
	Permission  rbac.Permission `json:"permission"`
	Poll        bool            `json:"poll"`
	Throttle    *ThrottleConfig `json:"throttle,omitempty"`
	Func        string          `json:"func"`
}

type HandlerFunc func(Context) error

type HandlerGroup struct {
	Prefix      string     `json:"prefix"` // default: /
	Handlers    []*Handler `json:"handlers"`
	Middlewares []string   `json:"middlewares"`
}

type Middleware interface {
	common.Service
	Func(echo.HandlerFunc) echo.HandlerFunc
}

type RequestInfo struct {
	URI          string
	Method       string
	Path         string
	RawPath      string
	TraceID      string
	IP           string
	StartedAt    time.Time
	Handler      *Handler
	HandlerGroup *HandlerGroup
}

type ResponseInfo struct {
	Status  int
	Took    time.Duration
	Size    uint64
	TraceID string
	Error   *ErrorBody
}

type Router interface {
	common.Service
	Handlers() map[string]echo.HandlerFunc
}

type ServerTLS struct {
	CertBundle  certutil.CertBundle
	AuthEnabled bool
}

type Stats struct {
	RequestInfo
	ResponseInfo
}

type ThrottleConfig struct {
	RPS       rate.Limit `json:"rps"`
	BurstSize int        `json:"burst_size"`
}