api

Documentation

Index

• Constants
• func CategoriedPlugins(plugins map[string]pluginmanager.Plugin) map[string]map[string][]PluginStatus
• func Run(ctx context.Context, options *Options, cachedir string) error
• func SortPluginStatusByName(list []PluginStatus)
• type BaseClient
  • func (c *BaseClient) Request(ctx context.Context, method string, path string, queries map[string]string, ...) error
• type ClientOptions
  • func NewDefaultClientOptions() *ClientOptions
• type Options
  • func DefaultOptions() *Options
• type PluginStatus
  • func ToViewPlugin(plugin pluginmanager.Plugin) PluginStatus
• type PluginsAPI
  • func NewPluginsAPI(pm *pluginmanager.PluginManager) *PluginsAPI
  • func (o *PluginsAPI) EnablePlugin(resp http.ResponseWriter, req *http.Request)
  • func (o *PluginsAPI) GetPlugin(resp http.ResponseWriter, req *http.Request)
  • func (o *PluginsAPI) ListPlugins(resp http.ResponseWriter, req *http.Request)
  • func (o *PluginsAPI) RegisterRoute(rg *route.Group)
  • func (o *PluginsAPI) RemovePlugin(resp http.ResponseWriter, req *http.Request)
  • func (o *PluginsAPI) RepoAdd(resp http.ResponseWriter, req *http.Request)
  • func (o *PluginsAPI) RepoGet(resp http.ResponseWriter, req *http.Request)
  • func (o *PluginsAPI) RepoList(resp http.ResponseWriter, req *http.Request)
  • func (o *PluginsAPI) RepoRemove(resp http.ResponseWriter, req *http.Request)
  • func (o *PluginsAPI) RepoUpdate(resp http.ResponseWriter, req *http.Request)
• type PluginsClient
  • func NewPluginsClient(server string) (*PluginsClient, error)
  • func (c *PluginsClient) CheckUpdate(ctx context.Context) (map[string]pluginmanager.Plugin, error)
  • func (c *PluginsClient) GetPluginVersion(ctx context.Context, name, version string, withSchema bool, ...) (*pluginmanager.PluginVersion, error)
  • func (c *PluginsClient) Install(ctx context.Context, name string, version string, values map[string]any) error
  • func (c *PluginsClient) ListPlugins(ctx context.Context) (map[string]pluginmanager.Plugin, error)
  • func (c *PluginsClient) UnInstall(ctx context.Context, name string) error

Constants

const PluginRepositoriesName = "plugin-repositories"

Functions

func CategoriedPlugins

func CategoriedPlugins(plugins map[string]pluginmanager.Plugin) map[string]map[string][]PluginStatus

func Run

func Run(ctx context.Context, options *Options, cachedir string) error

func SortPluginStatusByName

func SortPluginStatusByName(list []PluginStatus)

Types

type BaseClient

type BaseClient struct {
	Server              string
	CompleteRequestFunc func(req *http.Request)
	ErrorDecodeFunc     func(resp *http.Response) error
	DataDecoderWrapper  func(data any) any
}

func (*BaseClient) Request

func (c *BaseClient) Request(ctx context.Context, method string, path string, queries map[string]string, data interface{}, into interface{}) error

type ClientOptions

type ClientOptions struct {
	Addr string `json:"addr,omitempty"`
}

func NewDefaultClientOptions

func NewDefaultClientOptions() *ClientOptions

type Options

type Options struct {
	Listen    string `json:"listen,omitempty"`
	Namespace string `json:"namespace,omitempty"`
}

func DefaultOptions

func DefaultOptions() *Options

type PluginStatus

type PluginStatus struct {
	Name               string         `json:"name"`
	Namespace          string         `json:"namespace"`
	Description        string         `json:"description"`
	InstalledVersion   string         `json:"installedVersion"`
	UpgradeableVersion string         `json:"upgradeableVersion"`
	AvailableVersions  []string       `json:"availableVersions"`
	Required           bool           `json:"required"`
	Enabled            bool           `json:"enabled"`
	Healthy            bool           `json:"healthy"`
	Message            string         `json:"message"`
	Values             map[string]any `json:"values"` // current installed version values
	// contains filtered or unexported fields
}

func ToViewPlugin

func ToViewPlugin(plugin pluginmanager.Plugin) PluginStatus

type PluginsAPI

type PluginsAPI struct {
	PM *pluginmanager.PluginManager
}

func NewPluginsAPI

func NewPluginsAPI(pm *pluginmanager.PluginManager) *PluginsAPI

func (*PluginsAPI) EnablePlugin

func (o *PluginsAPI) EnablePlugin(resp http.ResponseWriter, req *http.Request)

func (*PluginsAPI) GetPlugin

func (o *PluginsAPI) GetPlugin(resp http.ResponseWriter, req *http.Request)

func (*PluginsAPI) ListPlugins

func (o *PluginsAPI) ListPlugins(resp http.ResponseWriter, req *http.Request)

func (*PluginsAPI) RegisterRoute

func (o *PluginsAPI) RegisterRoute(rg *route.Group)

func (*PluginsAPI) RemovePlugin

func (o *PluginsAPI) RemovePlugin(resp http.ResponseWriter, req *http.Request)

func (*PluginsAPI) RepoAdd

func (o *PluginsAPI) RepoAdd(resp http.ResponseWriter, req *http.Request)

func (*PluginsAPI) RepoGet

func (o *PluginsAPI) RepoGet(resp http.ResponseWriter, req *http.Request)

func (*PluginsAPI) RepoList

func (o *PluginsAPI) RepoList(resp http.ResponseWriter, req *http.Request)

func (*PluginsAPI) RepoRemove

func (o *PluginsAPI) RepoRemove(resp http.ResponseWriter, req *http.Request)

func (*PluginsAPI) RepoUpdate

func (o *PluginsAPI) RepoUpdate(resp http.ResponseWriter, req *http.Request)

type PluginsClient

type PluginsClient struct {
	BaseClient
}

func NewPluginsClient

func NewPluginsClient(server string) (*PluginsClient, error)

func (*PluginsClient) CheckUpdate

func (c *PluginsClient) CheckUpdate(ctx context.Context) (map[string]pluginmanager.Plugin, error)

func (*PluginsClient) GetPluginVersion

func (c *PluginsClient) GetPluginVersion(ctx context.Context,
	name, version string,
	withSchema bool, withDpendeciesCheck bool,
) (*pluginmanager.PluginVersion, error)

func (*PluginsClient) Install

func (c *PluginsClient) Install(ctx context.Context, name string, version string, values map[string]any) error

func (*PluginsClient) ListPlugins

func (c *PluginsClient) ListPlugins(ctx context.Context) (map[string]pluginmanager.Plugin, error)

func (*PluginsClient) UnInstall

func (c *PluginsClient) UnInstall(ctx context.Context, name string) error