pluginapi

Documentation

Index

• Constants
• type ExecRequest
• type ExecResponse
• type PluginConfig
• type PluginDefinition
• type Store

Constants

const (
	OpSet = "set"
	OpGet = "get"
)

Types

type ExecRequest

type ExecRequest struct {
	Action string `json:"action"`
	Key    string `json:"key"`
	Value  string `json:"value,omitempty"`
}

ExecRequest is the JSON request format for exec plugins

type ExecResponse

type ExecResponse struct {
	Success bool   `json:"success"`
	Value   string `json:"value,omitempty"`
	Error   string `json:"error,omitempty"`
}

ExecResponse is the JSON response format for exec plugins

type PluginConfig

type PluginConfig map[string]interface{}

PluginConfig holds configuration for a plugin

type PluginDefinition

type PluginDefinition struct {
	Type   string       `mapstructure:"type"`
	Config PluginConfig `mapstructure:",remain"`
}

PluginDefinition defines a plugin configuration from YAML

type Store

type Store interface {
	Get(ctx context.Context, key string) (string, error)
	Set(ctx context.Context, key string, value string) error
}