common

package
v0.3.1 Latest Latest
Warning

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

Go to latest
Published: Feb 19, 2021 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RestCheckNs

func RestCheckNs(c echo.Context) error

func RestDelAllConfig

func RestDelAllConfig(c echo.Context) error

RestDelAllConfig godoc @Summary Delete all configs @Description Delete all configs @Tags Config @Accept json @Produce json @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /config [delete]

func RestDelAllNs

func RestDelAllNs(c echo.Context) error

RestDelAllNs godoc @Summary Delete all namespaces @Description Delete all namespaces @Tags Namespace @Accept json @Produce json @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns [delete]

func RestDelNs

func RestDelNs(c echo.Context) error

RestDelNs godoc @Summary Delete namespace @Description Delete namespace @Tags Namespace @Accept json @Produce json @Param nsId path string true "Namespace ID" @Success 200 {object} common.SimpleMsg @Failure 404 {object} common.SimpleMsg @Router /ns/{nsId} [delete]

func RestGetAllConfig

func RestGetAllConfig(c echo.Context) error

RestGetAllConfig godoc @Summary List all configs @Description List all configs @Tags Config @Accept json @Produce json @Success 200 {object} RestGetAllConfigResponse @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /config [get]

func RestGetAllNs

func RestGetAllNs(c echo.Context) error

RestGetAllNs godoc @Summary List all namespaces @Description List all namespaces @Tags Namespace @Accept json @Produce json @Success 200 {object} RestGetAllNsResponse @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns [get]

func RestGetConfig

func RestGetConfig(c echo.Context) error

RestGetConfig godoc @Summary Get config @Description Get config @Tags Config @Accept json @Produce json @Param configId path string true "Config ID" @Success 200 {object} common.ConfigInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /config/{configId} [get]

func RestGetConnConfig

func RestGetConnConfig(c echo.Context) error

func RestGetConnConfigList

func RestGetConnConfigList(c echo.Context) error

func RestGetHealth

func RestGetHealth(c echo.Context) error

func RestGetNs

func RestGetNs(c echo.Context) error

RestGetNs godoc @Summary Get namespace @Description Get namespace @Tags Namespace @Accept json @Produce json @Param nsId path string true "Namespace ID" @Success 200 {object} common.NsInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns/{nsId} [get]

func RestGetRegion

func RestGetRegion(c echo.Context) error

func RestGetRegionList

func RestGetRegionList(c echo.Context) error

func RestPostConfig

func RestPostConfig(c echo.Context) error

RestPostConfig godoc @Summary Create or Update config @Description Create or Update config (SPIDER_REST_URL, DRAGONFLY_REST_URL, ...) @Tags Config @Accept json @Produce json @Param config body common.ConfigInfo true "Key and Value for configuration" @Success 200 {object} common.ConfigInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /config [post]

func RestPostNs

func RestPostNs(c echo.Context) error

RestPostNs godoc @Summary Create namespace @Description Create namespace @Tags Namespace @Accept json @Produce json @Param nsReq body common.NsReq true "Details for a new namespace" @Success 200 {object} common.NsInfo @Failure 404 {object} common.SimpleMsg @Failure 500 {object} common.SimpleMsg @Router /ns [post]

func RestPutNs

func RestPutNs(c echo.Context) error
function RestPutNs not yet implemented

// RestPutNs godoc // @Summary Update namespace // @Description Update namespace // @Tags Namespace // @Accept json // @Produce json // @Param namespace body common.NsInfo true "Details to update existing namespace" // @Success 200 {object} common.NsInfo // @Failure 404 {object} common.SimpleMsg // @Failure 500 {object} common.SimpleMsg // @Router /ns/{nsId} [put]

func Send

func Send(c echo.Context, httpCode int, json interface{}) error

func SendExistence

func SendExistence(c echo.Context, httpCode int, existence bool) error

func SendMessage

func SendMessage(c echo.Context, httpCode int, msg string) error

func Validate

func Validate(c echo.Context, params []string) error

Types

type Existence

type Existence struct {
	Exists bool `json:"exists"`
}

type RestGetAllConfigResponse

type RestGetAllConfigResponse struct {
	//Name string     `json:"name"`
	Config []common.ConfigInfo `json:"config"`
}

Response structure for RestGetAllConfig

type RestGetAllNsResponse

type RestGetAllNsResponse struct {
	//Name string     `json:"name"`
	Ns []common.NsInfo `json:"ns"`
}

Response structure for RestGetAllNs

type Status

type Status struct {
	Message string `json:"message"`
}

Jump to

Keyboard shortcuts

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