rest

Documentation

Overview

Package rest is used once at install-time when running install via browser

Index

• Variables
• type Handler
  • func (h *Handler) Filter() func(string) string
  • func (h *Handler) GetAgreement(req *restful.Request, rsp *restful.Response)
  • func (h *Handler) GetInstall(req *restful.Request, rsp *restful.Response)
  • func (h *Handler) PerformInstallCheck(req *restful.Request, rsp *restful.Response)
  • func (h *Handler) PostInstall(req *restful.Request, rsp *restful.Response)
  • func (h *Handler) SwaggerTags() []string

Variables

var AgplText = `` /* 34524-byte string literal not displayed */

Types

type Handler

type Handler struct{}

Handler to the REST requests.

func (*Handler) Filter

func (h *Handler) Filter() func(string) string

Filter returns a function to filter the swagger path.

func (*Handler) GetAgreement

func (h *Handler) GetAgreement(req *restful.Request, rsp *restful.Response)

GetAgreement returns current Licence text for user validation.

func (*Handler) GetInstall

func (h *Handler) GetInstall(req *restful.Request, rsp *restful.Response)

GetInstall retrieves default configuration parameters.

func (*Handler) PerformInstallCheck

func (h *Handler) PerformInstallCheck(req *restful.Request, rsp *restful.Response)

PerformInstallCheck performs a few server side checks before launching the real install.

func (*Handler) PostInstall

func (h *Handler) PostInstall(req *restful.Request, rsp *restful.Response)

PostInstall updates pydio.json configuration file after having gathered modifications from the admin end user.

func (*Handler) SwaggerTags

func (h *Handler) SwaggerTags() []string

SwaggerTags lists the names of the service tags declared in the swagger JSON implemented by this service.