api

package

v1.2.1 Latest Latest Go to latest Published: Apr 7, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Details

This section is empty.

This section is empty.

func IsSystemRoute(p string) bool

IsSystemRoute returns true for a path registered as SystemAPIRoute

func MetricsURLSkipper(c echo.Context) bool

MetricsURLSkipper ignores metrics for certain routes

type RequestHandler interface {
	Handle(c echo.Context) error
}

RequestHandler defines the Echo compatible interface all API route handlers should implement

type Route struct {
	Path    string
	Method  string
	Handler RequestHandler
}

Route defines the data structure to organize route information that can be used to initialize Echo routes

func NewAPIRoutes(dbSession *cdb.Session, tc tClient.Client, tnc tClient.NamespaceClient, scp *sc.ClientPool, cfg *config.Config) []Route

NewAPIRoutes returns all API routes

func NewSystemAPIRoutes() []Route

NewSystemAPIRoutes returns API routes that provide system level functions