Documentation
¶
Overview ¶
Package server holds the admin HTTP handlers of the server and node management.
Index ¶
- func CreateNodeHandler(service network.Service) app.HandlerFunc
- func CreateServerHandler(service network.Service) app.HandlerFunc
- func DeleteNodeHandler(service network.Service) app.HandlerFunc
- func DeleteServerHandler(service network.Service) app.HandlerFunc
- func FilterNodeListHandler(service network.Service) app.HandlerFunc
- func FilterServerListHandler(service network.Service) app.HandlerFunc
- func GetServerNodeConfigHandler(service network.Service) app.HandlerFunc
- func GetServerProtocolsHandler(service network.Service) app.HandlerFunc
- func QueryNodeTagHandler(service network.Service) app.HandlerFunc
- func ResetSortWithNodeHandler(service network.Service) app.HandlerFunc
- func ResetSortWithServerHandler(service network.Service) app.HandlerFunc
- func ToggleNodeStatusHandler(service network.Service) app.HandlerFunc
- func UpdateNodeHandler(service network.Service) app.HandlerFunc
- func UpdateServerHandler(service ServerUpdater) app.HandlerFunc
- func UpdateServerNodeConfigHandler(service ServerNodeConfigUpdater) app.HandlerFunc
- type ServerNodeConfigUpdater
- type ServerUpdater
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateNodeHandler ¶
func CreateNodeHandler(service network.Service) app.HandlerFunc
CreateNodeHandler documents Create Node.
@Summary Create Node @Tags admin @Accept json @Produce json @Security BearerAuth @Param request body dto.CreateNodeRequest true "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean @Router /v1/admin/server/node/create [post]
func CreateServerHandler ¶
func CreateServerHandler(service network.Service) app.HandlerFunc
CreateServerHandler documents Create Server.
@Summary Create Server @Tags admin @Accept json @Produce json @Security BearerAuth @Param request body dto.CreateServerRequest true "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean @Router /v1/admin/server/create [post]
func DeleteNodeHandler ¶
func DeleteNodeHandler(service network.Service) app.HandlerFunc
DeleteNodeHandler documents Delete Node.
@Summary Delete Node @Tags admin @Accept json @Produce json @Security BearerAuth @Param request body dto.DeleteNodeRequest true "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean @Router /v1/admin/server/node/delete [post]
func DeleteServerHandler ¶
func DeleteServerHandler(service network.Service) app.HandlerFunc
DeleteServerHandler documents Delete Server.
@Summary Delete Server @Tags admin @Accept json @Produce json @Security BearerAuth @Param request body dto.DeleteServerRequest true "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean @Router /v1/admin/server/delete [post]
func FilterNodeListHandler ¶
func FilterNodeListHandler(service network.Service) app.HandlerFunc
FilterNodeListHandler documents Filter Node List.
@Summary Filter Node List @Tags admin @Accept json @Produce json @Security BearerAuth @Param request query dto.FilterNodeListRequest false "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean{data=dto.FilterNodeListResponse} @Router /v1/admin/server/node/list [get]
func FilterServerListHandler ¶
func FilterServerListHandler(service network.Service) app.HandlerFunc
FilterServerListHandler documents Filter Server List.
@Summary Filter Server List @Tags admin @Accept json @Produce json @Security BearerAuth @Param request query dto.FilterServerListRequest false "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean{data=dto.FilterServerListResponse} @Router /v1/admin/server/list [get]
func GetServerNodeConfigHandler ¶
func GetServerNodeConfigHandler(service network.Service) app.HandlerFunc
GetServerNodeConfigHandler documents Get Server Node Config.
@Summary Get Server Node Config @Tags admin @Accept json @Produce json @Security BearerAuth @Param request query dto.GetServerNodeConfigRequest false "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean{data=dto.GetServerNodeConfigResponse} @Router /v1/admin/server/node_config [get]
func GetServerProtocolsHandler ¶
func GetServerProtocolsHandler(service network.Service) app.HandlerFunc
GetServerProtocolsHandler documents Get Server Protocols.
@Summary Get Server Protocols @Tags admin @Accept json @Produce json @Security BearerAuth @Param request query dto.GetServerProtocolsRequest false "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean{data=dto.GetServerProtocolsResponse} @Router /v1/admin/server/protocols [get]
func QueryNodeTagHandler ¶
func QueryNodeTagHandler(service network.Service) app.HandlerFunc
QueryNodeTagHandler documents Query all node tags.
@Summary Query all node tags @Tags admin @Produce json @Security BearerAuth @Success 200 {object} httpx.ResponseSuccessBean{data=dto.QueryNodeTagResponse} @Router /v1/admin/server/node/tags [get]
func ResetSortWithNodeHandler ¶
func ResetSortWithNodeHandler(service network.Service) app.HandlerFunc
ResetSortWithNodeHandler documents Reset node sort.
@Summary Reset node sort @Tags admin @Accept json @Produce json @Security BearerAuth @Param request body dto.ResetSortRequest true "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean @Router /v1/admin/server/node/sort [post]
func ResetSortWithServerHandler ¶
func ResetSortWithServerHandler(service network.Service) app.HandlerFunc
ResetSortWithServerHandler documents Reset server sort.
@Summary Reset server sort @Tags admin @Accept json @Produce json @Security BearerAuth @Param request body dto.ResetSortRequest true "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean @Router /v1/admin/server/server/sort [post]
func ToggleNodeStatusHandler ¶
func ToggleNodeStatusHandler(service network.Service) app.HandlerFunc
ToggleNodeStatusHandler documents Toggle Node Status.
@Summary Toggle Node Status @Tags admin @Accept json @Produce json @Security BearerAuth @Param request body dto.ToggleNodeStatusRequest true "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean @Router /v1/admin/server/node/status/toggle [post]
func UpdateNodeHandler ¶
func UpdateNodeHandler(service network.Service) app.HandlerFunc
UpdateNodeHandler documents Update Node.
@Summary Update Node @Tags admin @Accept json @Produce json @Security BearerAuth @Param request body dto.UpdateNodeRequest true "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean @Router /v1/admin/server/node/update [post]
func UpdateServerHandler ¶
func UpdateServerHandler(service ServerUpdater) app.HandlerFunc
UpdateServerHandler documents Update Server.
@Summary Update Server @Tags admin @Accept json @Produce json @Security BearerAuth @Param request body dto.UpdateServerRequest true "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean @Router /v1/admin/server/update [post]
func UpdateServerNodeConfigHandler ¶
func UpdateServerNodeConfigHandler(service ServerNodeConfigUpdater) app.HandlerFunc
UpdateServerNodeConfigHandler documents Update Server Node Config.
@Summary Update Server Node Config @Tags admin @Accept json @Produce json @Security BearerAuth @Param request body dto.UpdateServerNodeConfigRequest true "Request parameters" @Success 200 {object} httpx.ResponseSuccessBean @Router /v1/admin/server/node_config/update [post]
Types ¶
type ServerNodeConfigUpdater ¶ added in v1.21.0
type ServerNodeConfigUpdater interface {
UpdateServerNodeConfig(ctx context.Context, req *dto.UpdateServerNodeConfigRequest) error
}
ServerNodeConfigUpdater is the part of the network facade UpdateServerNodeConfigHandler calls.
type ServerUpdater ¶ added in v1.21.0
type ServerUpdater interface {
UpdateServer(ctx context.Context, req *dto.UpdateServerRequest) error
}
ServerUpdater is the part of the network facade UpdateServerHandler calls.
Source Files
¶
- create_node_handler.go
- create_server_handler.go
- delete_node_handler.go
- delete_server_handler.go
- filter_node_list_handler.go
- filter_server_list_handler.go
- get_server_node_config_handler.go
- get_server_protocols_handler.go
- query_node_tag_handler.go
- reset_sort_with_node_handler.go
- reset_sort_with_server_handler.go
- toggle_node_status_handler.go
- update_node_handler.go
- update_server_handler.go
- update_server_node_config_handler.go