Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Router ¶
type Router struct {
// contains filtered or unexported fields
}
Router is what registers the UI and API routes for managing namespaces. It implements the server.Router interface.
func (*Router) RegisterAPI ¶
RegisterAPI registers the API routes for working with namespaces. The given prefix string is used to specify where the API is being served under. This applies all of the given gates to all routes registered. These routes response with a "application/json" Content-Type.
func (*Router) RegisterUI ¶
func (r *Router) RegisterUI(mux *mux.Router, csrf func(http.Handler) http.Handler, gates ...web.Gate)
RegisterUI registers the UI routes for Namespace creation, and management. There are two types of routes, simple auth routes, and individual namespace routes. These routes respond with a text/html Content-Type.
simple auth routes - These routes (/namespaces, /namespaces/create, /invites, /invites/{invite:[0-9]+}) havbe the auth middleware applied to them to check if a user is authenticated to access the route. The given http.Handler is applied to these routes for CSRF protection.
individual namespace routes - These routes (prefixed with /n/{username}/{namespace:[a-zA-Z0-9\\/?]+}), use the given http.Handler for CSRF protection, and the given gates for auth checks, and permission checks.
Source Files