config

Documentation

Index

• Constants
• Variables
• func CreateConfig(ctx context.Context, params *CreateParams) (*any, error)
• func DeleteConfig(ctx context.Context, params *oamprovidertypes.Params[config.NamespacedName]) (*any, error)
• func GetProviders() map[string]cuexruntime.ProviderFn
• func GetTemplate() string
• type CreateConfigProperties
• type CreateParams
• type ListReturnVars
• type ListReturns
  • func ListConfig(ctx context.Context, params *oamprovidertypes.Params[ListVars]) (*ListReturns, error)
• type ListVars
• type ReadReturnVars
• type ReadReturns
  • func ReadConfig(ctx context.Context, params *oamprovidertypes.Params[config.NamespacedName]) (*ReadReturns, error)

Constants

const (
	// ProviderName is provider name
	ProviderName = "config"
)

Variables

var ErrRequestInvalid = errors.New("the request is in valid")

ErrRequestInvalid means the request is invalid

Functions

func CreateConfig

func CreateConfig(ctx context.Context, params *CreateParams) (*any, error)

CreateConfig creates a config

func DeleteConfig

func DeleteConfig(ctx context.Context, params *oamprovidertypes.Params[config.NamespacedName]) (*any, error)

DeleteConfig deletes a config

func GetProviders

func GetProviders() map[string]cuexruntime.ProviderFn

GetProviders returns the cue providers.

func GetTemplate

func GetTemplate() string

GetTemplate returns the cue template.

Types

type CreateConfigProperties

type CreateConfigProperties struct {
	Name      string                 `json:"name"`
	Namespace string                 `json:"namespace"`
	Template  string                 `json:"template,omitempty"`
	Config    map[string]interface{} `json:"config"`
}

CreateConfigProperties the request body for creating a config

type CreateParams

type CreateParams = oamprovidertypes.Params[CreateConfigProperties]

CreateParams is the create params

type ListReturnVars

type ListReturnVars struct {
	Configs []map[string]any `json:"configs"`
}

ListReturnVars is the list return vars

type ListReturns

type ListReturns = oamprovidertypes.Returns[ListReturnVars]

ListReturns is the list returns

func ListConfig

func ListConfig(ctx context.Context, params *oamprovidertypes.Params[ListVars]) (*ListReturns, error)

ListConfig lists the config

type ListVars

type ListVars struct {
	Namespace string `json:"namespace"`
	Template  string `json:"template"`
}

ListVars is the list vars

type ReadReturnVars

type ReadReturnVars struct {
	Config map[string]any `json:"config"`
}

ReadReturnVars is the read return vars

type ReadReturns

type ReadReturns = oamprovidertypes.Returns[ReadReturnVars]

ReadReturns is the read returns

func ReadConfig

func ReadConfig(ctx context.Context, params *oamprovidertypes.Params[config.NamespacedName]) (*ReadReturns, error)

ReadConfig reads the config