plugins

Documentation

Index

• func List() map[string]map[string]CapabilitySpec
• func ValidateCapability(integration string, cap CapabilityConfig) error
• type AllowlistEntry
• type CallRule
• type CallerConfig
• type CapabilityConfig
• type CapabilitySpec
  • func Capability(integration, name string) (CapabilitySpec, bool)
• type RequestConstraint

Functions

func List

func List() map[string]map[string]CapabilitySpec

func ValidateCapability

func ValidateCapability(integration string, cap CapabilityConfig) error

Types

type AllowlistEntry

type AllowlistEntry struct {
	Integration string         `json:"integration" yaml:"integration"`
	Callers     []CallerConfig `json:"callers,omitempty" yaml:"callers,omitempty"`
}

type CallRule

type CallRule struct {
	Path    string                       `json:"path" yaml:"path"`
	Methods map[string]RequestConstraint `json:"methods,omitempty" yaml:"methods,omitempty"`
}

type CallerConfig

type CallerConfig struct {
	ID           string             `json:"id" yaml:"id"`
	Capabilities []CapabilityConfig `json:"capabilities,omitempty" yaml:"capabilities,omitempty"`
	Rules        []CallRule         `json:"rules,omitempty" yaml:"rules,omitempty"`
}

CallerConfig mirrors the server structure for CLI use.

type CapabilityConfig

type CapabilityConfig struct {
	Name   string                 `json:"name" yaml:"name"`
	Params map[string]interface{} `json:"params" yaml:"params"`
}

type CapabilitySpec

type CapabilitySpec = integrationplugins.CapabilitySpec

CapabilitySpec describes a capability's parameters and rule generator.

func Capability

func Capability(integration, name string) (CapabilitySpec, bool)

type RequestConstraint

type RequestConstraint struct {
	Headers map[string][]string    `json:"headers,omitempty" yaml:"headers,omitempty"`
	Query   map[string][]string    `json:"query,omitempty" yaml:"query,omitempty"`
	Body    map[string]interface{} `json:"body,omitempty" yaml:"body,omitempty"`
}