apis

Documentation

Index

• type ApplicationMeta
• type CapabilityCenterMeta
• type CapabilityMeta
• type CommonFlag
• type ComponentMeta
• type Environment
• type EnvironmentBody
• type Response
• type TraitBody
• type WorkloadMeta
• type WorkloadRunBody

Types

type ApplicationMeta

type ApplicationMeta struct {
	Name        string          `json:"name"`
	Status      string          `json:"status,omitempty"`
	Components  []ComponentMeta `json:"components,omitempty"`
	CreatedTime string          `json:"createdTime,omitempty"`
}

ApplicationMeta used for dashboard restful API server

type CapabilityCenterMeta

type CapabilityCenterMeta struct {
	Name string `json:"name"`
	URL  string `json:"url"`
}

CapabilityCenterMeta used for dashboard restful API server

type CapabilityMeta

type CapabilityMeta struct {
	CapabilityName       string `json:"capabilityName"`
	CapabilityCenterName string `json:"capabilityCenterName,omitempty"`
}

CapabilityMeta used for dashboard restful API server

type CommonFlag

type CommonFlag struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

CommonFlag used for restful API flags in dashboard server

type ComponentMeta

type ComponentMeta struct {
	Name     string               `json:"name"`
	Status   string               `json:"status,omitempty"`
	Workload runtime.RawExtension `json:"workload,omitempty"`
	// WorkloadName for `vela comp ls`
	WorkloadName string                        `json:"workloadName,omitempty"`
	Traits       []corev1alpha2.ComponentTrait `json:"traits,omitempty"`
	// TraitNames for `vela comp ls`
	TraitNames  []string                              `json:"traitsNames,omitempty"`
	App         string                                `json:"app"`
	CreatedTime string                                `json:"createdTime,omitempty"`
	AppConfig   corev1alpha2.ApplicationConfiguration `json:"-"`
	Component   corev1alpha2.Component                `json:"-"`
}

ComponentMeta store component info for dashboard restful API server

type Environment

type Environment struct {
	EnvName   string `json:"envName" binding:"required,min=1,max=32"`
	Namespace string `json:"namespace" binding:"required,min=1,max=32"`
	Email     string `json:"email"`
	Domain    string `json:"domain"`
	Current   string `json:"current,omitempty"`
}

Environment contains all info needed in `vela env` command

type EnvironmentBody

type EnvironmentBody struct {
	Namespace string `json:"namespace" binding:"required,min=1,max=32"`
}

EnvironmentBody used for restful API in dashboard server

type Response

type Response struct {
	Code int         `json:"code"`
	Data interface{} `json:"data" swaggerignore:"true"`
}

Response used for restful API response in dashboard server

type TraitBody

type TraitBody struct {
	EnvName       string       `json:"envName"`
	Name          string       `json:"name"`
	Flags         []CommonFlag `json:"flags"`
	ComponentName string       `json:"componentName"`
	AppName       string       `json:"appName,omitempty"`
	Staging       string       `json:"staging,omitempty"`
}

TraitBody used to present trait which is to be attached and, of which parameters are set

type WorkloadMeta

type WorkloadMeta struct {
	Name       string            `json:"name"`
	Parameters []types.Parameter `json:"parameters,omitempty"`
	AppliesTo  []string          `json:"appliesTo,omitempty"`
}

WorkloadMeta store workload metadata for dashboard restful API server

type WorkloadRunBody

type WorkloadRunBody struct {
	EnvName      string       `json:"envName"`
	WorkloadType string       `json:"workloadType"`
	WorkloadName string       `json:"workloadName"`
	AppName      string       `json:"appName,omitempty"`
	Flags        []CommonFlag `json:"flags"`
	Staging      bool         `json:"staging,omitempty"`
	Traits       []TraitBody  `json:"traits,omitempty"`
}

WorkloadRunBody used for restful API arguments for run workload for dashboard restful API server