api

package

v0.0.1-dev-7e239fa Latest Latest Go to latest Published: Jan 23, 2025 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/bigstack-oss/cube-cos-api

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func GenControlConvergedHandlers() map[string][]Handler
func GetGroupHandlersByRole(role string) map[string][]Handler
func GetReqId(c *gin.Context) string
func RegisterHandlersToRoles(module string, handlers []Handler, rolesToRegister ...string)
func SetErrBadRequestResp(c *gin.Context, err error)
func SetErrInternalServerErrorResp(c *gin.Context, err error)
func SetRedirectResp(c *gin.Context, redirectUrl string)
func SetStatusOkResp(c *gin.Context, msg string, data interface{})
type Handler
- func (h Handler) IsUnderDataCenter() bool

Constants ¶

View Source

const (
	API = "api"

	Code   = "code"
	Status = "status"
	Msg    = "msg"
	Data   = "data"
)

Variables ¶

View Source

var (
	Role string
	V1   = fmt.Sprintf("/%s/%s", API, "v1")

	ControlHandlers   = map[string][]Handler{}
	ComputeHandlers   = map[string][]Handler{}
	StorageHandlers   = map[string][]Handler{}
	NetworkHandlers   = map[string][]Handler{}
	ModeratorHandlers = map[string][]Handler{}
	EdgeCoreHandlers  = map[string][]Handler{}
)

Functions ¶

func GenControlConvergedHandlers ¶

func GenControlConvergedHandlers() map[string][]Handler

func GetGroupHandlersByRole ¶

func GetGroupHandlersByRole(role string) map[string][]Handler

func GetReqId ¶

func GetReqId(c *gin.Context) string

func RegisterHandlersToRoles ¶

func RegisterHandlersToRoles(module string, handlers []Handler, rolesToRegister ...string)

func SetErrBadRequestResp ¶

func SetErrBadRequestResp(c *gin.Context, err error)

func SetErrInternalServerErrorResp ¶

func SetErrInternalServerErrorResp(c *gin.Context, err error)

func SetRedirectResp ¶

func SetRedirectResp(c *gin.Context, redirectUrl string)

func SetStatusOkResp ¶

func SetStatusOkResp(c *gin.Context, msg string, data interface{})

Types ¶

type Handler ¶

type Handler struct {
	Version              string
	Method               string
	Path                 string
	Func                 gin.HandlerFunc
	IsNotUnderDataCenter bool
}

func (Handler) IsUnderDataCenter ¶

func (h Handler) IsUnderDataCenter() bool

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
v1
datacenters
events
health
integrations
logout
nodes
summary
tunings

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