router

type AuthOptions struct {
	Enabled   bool
	WhiteList []string
}

type DefaultMiddlewareOptions struct {
	AuthOptions
	Compress  bool
	CORS      bool
	ETag      bool
	GitCommit string
	Name      string
	Region    string
	Version   string
}

type DefaultOptions struct {
	// Auth can be set to true to enable query-param-based authentication.
	Auth bool

	// Compress can be set to true to enable compression for all responses.
	Compress bool

	// CORS can be set to true to enable CORS middleware.
	CORS bool

	// ETag, if set to true, will handle etag-related headers accordingly.
	ETag bool

	// GitCommit is the git SHA of the app's current git commit.
	GitCommit string

	// Name is the application name.
	Name string

	// Region is the cluster region where the app is running.
	Region string

	// Version is the current version of the application.
	Version string

	// Whitelist is a string of regular expression strings,
	// matching URL paths which should not require authentication.
	WhiteList []string
}

type DefaultRoutesOptions struct {
	HealthOptions
	PrometheusOptions
}

type HealthOptions struct {
	// GitCommit is the application's current git commit ID.
	GitCommit string

	// Name is the name of the application.
	Name string

	// Path is the URL path for the health check route.
	Path string

	// Region is the server region where the app is currently running.
	Region string

	// Version is the version of the application. There is currently no
	// standard for this; convention has been semver.
	Version string
}

type PrometheusOptions struct {
	// Path is the URL path for the prometheus metrics route.
	Path string
}

type Route func(*mux.Router)