config

type Config struct {
	// Server defines the instance wide serving configuration.
	Server Server `yaml:"server" json:"server"`

	// Routes defines the routes to expose as redirects.
	Routes []Route `yaml:"routes" json:"routes"`
}

type Route struct {
	// Path defines the absolute path to match against.
	Path string `yaml:"path" json:"path"`

	// Aliases are additional absolute paths to match against.
	Aliases []string `yaml:"aliases" json:"aliases"`

	// Documentation defines the human-readable documentation attributes for the route.
	Documentation RouteDocumentation `yaml:"documentation" json:"documentation"`

	// Environment defines the environment variables the route may consume.
	Environment RouteEnvironment `yaml:"environment" json:"environment"`

	// Params are the template parameters to extract and build the redirect URL from.
	Params map[string]string `yaml:"params" json:"params"`

	// Checks are the conditions to evaluate before redirecting.
	Checks []RouteCheck `yaml:"checks" json:"checks"`

	// Redirect is the redirect configuration.
	Redirect RouteRedirect `yaml:"redirect" json:"redirect"`

	// Tests defines the valid route resulting redirect tests
	Tests []RouteTest `yaml:"tests" json:"tests"`
}

type RouteCheck struct {
	// Expr is a CEL expression evaluated against the request.
	// If the expression evaluates to true, the check passes.
	// If the expression evaluates to anything else, the check fails.
	Expr string `yaml:"expr" json:"expr"`

	// Error is the error message to return if the check fails.
	Error string `yaml:"error" json:"error"`
}

type RouteDocumentation struct {
	// Title is a human-readable title for the route.
	Title string `yaml:"title" json:"title"`

	// Description is a human-readable description of the route.
	Description string `yaml:"description" json:"description"`
}

type RouteEnvironment struct {
	// Allowlist is the list of environment variables a route may consume.
	Allowlist []string `yaml:"allowlist" json:"allowlist"`
}

type RouteRedirect struct {
	// URL is the template to build the redirect URL from.
	URL string `yaml:"url" json:"url"`
}

type RouteTest struct {
	// Request defines the expectation input request data
	Request RouteTestRequest `yaml:"request" json:"request"`

	// Response defines the expected response data
	Response RouteTestResponse `yaml:"response" json:"response"`
}

type RouteTestRequest struct {
	// Environment defines the environment variables and their values
	Environment map[string]string `yaml:"environment" json:"environment"`

	// Headers defines the headers that should be sent with the request
	Headers map[string]string `yaml:"headers" json:"headers"`

	// URL defines the request url to send
	URL string `yaml:"url" json:"url"`
}

type RouteTestResponse struct {
	// URL defines the expected response url
	URL string `yaml:"url" json:"url"`
}

type Server struct {
	// Address is the server address to serve on.
	Address string `yaml:"address" json:"address"`

	// TLS is the server TLS configuration. If omitted, the server will serve over plain HTTP.
	TLS ServerTLSConfig `yaml:"tls" json:"tls"`

	// Documentation is the server documentation rendering configuration.
	Documentation ServerDocumentationConfig `yaml:"documentation" json:"documentation"`
}

type ServerDocumentationConfig struct {
	// Path defines the route to serve the documentation from.
	Path string `yaml:"path" json:"path"`

	// Templates defines the server documentation templates.
	Templates ServerTemplatesConfig `yaml:"templates" json:"templates"`
}

type ServerTLSConfig struct {
	// Cert is the path to the server TLS certificate file.
	Cert string `yaml:"cert" json:"cert"`

	// Key is the path to the server TLS key file.
	Key string `yaml:"key" json:"key"`
}

type ServerTemplatesConfig struct {
	// Page is the path to the server documentation page template file.
	Page string `yaml:"page" json:"page"`

	// Content is the path to the server documentation page content template file.
	Content string `yaml:"content" json:"content"`
}