Version: v2.2.7+incompatible Latest Latest

This package is not in the latest version of its module.

Go to latest
Published: May 6, 2021 License: AGPL-3.0 Imports: 35 Imported by: 0



Package rest is a service for serving specific requests directly to frontend



This section is empty.


View Source
var BasePluginsBox = frontend.PluginBox{
	Box: packr.NewBox("../../../frontend/front-srv/assets"),
	Exposes: []string{


This section is empty.


type FrontendHandler

type FrontendHandler struct {

func NewFrontendHandler added in v1.2.0

func NewFrontendHandler() *FrontendHandler

func (*FrontendHandler) Filter

func (a *FrontendHandler) Filter() func(string) string

Filter returns a function to filter the swagger path

func (*FrontendHandler) FrontBootConf

func (a *FrontendHandler) FrontBootConf(req *restful.Request, rsp *restful.Response)

FrontBootConf loads an open JSON struct for start configuration. As it can be called directly as a simple GET /a/frontend/bootconf, this endpoint can rely on Cookie for authentication

func (*FrontendHandler) FrontEnrollAuth added in v1.2.0

func (a *FrontendHandler) FrontEnrollAuth(req *restful.Request, rsp *restful.Response)

Generic endpoint that can be handled by specific 2FA plugins

func (*FrontendHandler) FrontMessages added in v1.2.0

func (a *FrontendHandler) FrontMessages(req *restful.Request, rsp *restful.Response)

FrontMessages loads all i18n messages for a given language

func (*FrontendHandler) FrontPlugins added in v1.2.0

func (a *FrontendHandler) FrontPlugins(req *restful.Request, rsp *restful.Response)

FrontPlugins dumps a full list of available frontend plugins

func (*FrontendHandler) FrontPutBinary added in v1.2.0

func (a *FrontendHandler) FrontPutBinary(req *restful.Request, rsp *restful.Response)

FrontPutBinary receives an upload to store a binary.

func (*FrontendHandler) FrontServeBinary added in v1.2.0

func (a *FrontendHandler) FrontServeBinary(req *restful.Request, rsp *restful.Response)

FrontServeBinary triggers the download of a stored binary. As it can be used directly in <img url="/a/frontend/binary">, this endpoint can rely on the cookie to authenticate user

func (*FrontendHandler) FrontSession added in v1.2.0

func (a *FrontendHandler) FrontSession(req *restful.Request, rsp *restful.Response)

FrontSession initiate a cookie-based session based on a LoginRequest

func (*FrontendHandler) FrontSessionDel

func (a *FrontendHandler) FrontSessionDel(req *restful.Request, rsp *restful.Response)

FrontendSessionDel logs out user by clearing the associated cookie session.

func (*FrontendHandler) FrontSessionGet

func (a *FrontendHandler) FrontSessionGet(req *restful.Request, rsp *restful.Response)

FrontSessionGet loads a cookie-based session to get info about an access token

func (*FrontendHandler) FrontState added in v1.2.0

func (a *FrontendHandler) FrontState(req *restful.Request, rsp *restful.Response)

func (*FrontendHandler) SettingsMenu

func (a *FrontendHandler) SettingsMenu(req *restful.Request, rsp *restful.Response)

SettingsMenu builds the list of available page for the Cells Console left menu

func (*FrontendHandler) SwaggerTags

func (a *FrontendHandler) SwaggerTags() []string

SwaggerTags list the names of the service tags declared in the swagger json implemented by this service


Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL