cluster

Documentation

Index

• func Create(ctx *fiber.Ctx) error
• func Delete(ctx *fiber.Ctx) error
• func Get(ctx *fiber.Ctx) error
• func GetConfig(ctx *fiber.Ctx) error
• func List(ctx *fiber.Ctx) error
• func PutConfig(ctx *fiber.Ctx) error
• func RegisterRoutes(r fiber.Router)
• func Update(ctx *fiber.Ctx) error
• type Cluster
• type Config
• type CreateClusterRequest
• type ListResponse
• type UpdateClusterRequest

Functions

func Create

func Create(ctx *fiber.Ctx) error

Create @Summary Create cluster @Tags clusters @ID postCluster @Param namespace path string true "Namespace name" @Param cluster body CreateClusterRequest true "request" @Success 200 {object} Cluster @Failure 404 {object} string @Failure 500 {object} string @Response default {object} Cluster @Router /namespaces/{namespace}/clusters [post]

func Delete

func Delete(ctx *fiber.Ctx) error

Delete godoc @Summary Delete a cluster @Tags clusters @ID deleteCluster @Param namespace path string true "Namespace name" @Param name path string true "Cluster name" @Success 204 {object} string @Failure 400 {object} string @Failure 404 {object} string @Failure 500 {object} string @Router /namespaces/{namespace}/clusters/{name} [delete]

func Get

func Get(ctx *fiber.Ctx) error

Get @Summary Get cluster @Tags clusters @ID getCluster @Param namespace path string true "Namespace name" @Param name path string true "Cluster name" @Success 200 {object} Cluster @Failure 404 {object} string @Failure 500 {object} string @Response default {object} Cluster @Router /namespaces/{namespace}/clusters/{name} [get]

func GetConfig

func GetConfig(ctx *fiber.Ctx) error

GetConfig @Summary Get cluster config @Tags clusters @ID getClusterConfig @Param namespace path string true "Namespace name" @Param name path string true "Cluster name" @Success 200 {object} Config @Failure 404 {object} string @Failure 500 {object} string @Response default {object} Config @Router /namespaces/{namespace}/clusters/{name}/config [get]

func List

func List(ctx *fiber.Ctx) error

List @Tags clusters @ID listClusters @Param namespace path string true "Namespace name" @Param query query types.ListQuery false "query" @Success 200 {object} ListResponse @Failure 404 {object} string @Failure 500 {object} string @Response default {object} ListResponse @Router /namespaces/{namespace}/clusters [get]

func PutConfig

func PutConfig(ctx *fiber.Ctx) error

PutConfig @Summary Put cluster config @Tags clusters @ID putClusterConfig @Param namespace path string true "Namespace name" @Param name path string true "Cluster name" @Param cluster body Config true "config" @Success 200 {object} string @Failure 404 {object} string @Failure 500 {object} string @Response default {object} string @Router /namespaces/{namespace}/clusters/{name}/config [put]

func RegisterRoutes

func RegisterRoutes(r fiber.Router)

func Update

func Update(ctx *fiber.Ctx) error

Update @Summary Update cluster @Tags clusters @ID patchCluster @Param namespace path string true "Namespace name" @Param name path string true "Cluster name" @Param cluster body UpdateClusterRequest true "request" @Success 200 {object} Cluster @Failure 404 {object} string @Failure 500 {object} string @Response default {object} Cluster @Router /namespaces/{namespace}/clusters/{name} [patch]

Types

type Cluster

type Cluster struct {
	Name         string    `json:"name,omitempty"`
	Description  string    `json:"description,omitempty"`
	CreationTime time.Time `json:"creationTime,omitempty"`
}

type Config

type Config struct {
	Config string `json:"config"`
}

type CreateClusterRequest

type CreateClusterRequest struct {
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
}

type ListResponse

type ListResponse struct {
	Items []*Cluster `json:"items,omitempty"`
	Total int        `json:"total"`
}

type UpdateClusterRequest

type UpdateClusterRequest struct {
	Description string `json:"description,omitempty"`
}