contracts

Documentation

Index

• type Control
• type Format
• type IDefinition
• type Kind
• type ObjectInterface
• type PlatformEvent
• type Response
• type TDefinition

Types

type Control

type Control struct {
	Kind      string
	Operation string
	Group     string
	Name      string

	User *authentication.User
	Data map[string]any
}

type Format

type Format interface {
	GetCategory() string
	GetType() string
	GetUUID() uuid.UUID
	ToString() string
	ToStringWithUUID() string
	Full() bool
	IsValid() bool
	ToBytes() []byte
}

type IDefinition

type IDefinition interface {
	FromJson([]byte) error
	SetRuntime(*commonv1.Runtime)
	GetRuntime() *commonv1.Runtime
	GetKind() string
	ResolveReferences(ObjectInterface) ([]IDefinition, error)
	ToJson() ([]byte, error)
	ToJsonWithKind() ([]byte, error)
	ToJsonString() (string, error)
	Validate() (bool, error)
}

type Kind

type Kind interface {
	Start() error
	Propose(*gin.Context, *authentication.User, []byte, string) (Response, error)
	Apply(*authentication.User, []byte, string) (Response, error)
	Compare(*authentication.User, []byte) (Response, error)
	Delete(*authentication.User, []byte, string) (Response, error)
	GetShared() interface{}
	Run(string, Control) Response
}

type ObjectInterface

type ObjectInterface interface {
	GetDefinitionString() string
	GetDefinition() map[string]any
	GetDefinitionByte() []byte
	Propose(Format, []byte) (uuid.UUID, error)
	Wait(uuid uuid.UUID) error
	AddLocal(format Format, data []byte) error
	RemoveLocal(format Format) (bool, error)
	Find(format Format) error
	FindMany(format Format) (map[string]ObjectInterface, error)
	Diff(definition []byte) bool
	GetDiff() []diff.Change
	Exists() bool
	ChangeDetected() bool
}

type PlatformEvent

type PlatformEvent struct {
	NetworkID   string
	ContainerID string
	Group       string
	Name        string
	Managed     bool
	Type        string
}

type Response

type Response struct {
	HttpStatus       int
	Explanation      string
	ErrorExplanation string
	Error            bool
	Success          bool
	Data             json.RawMessage
}

type TDefinition

type TDefinition interface {
	Apply(Format, ObjectInterface, string) (ObjectInterface, error)
	Delete(Format, ObjectInterface, string) (IDefinition, error)
	Changed(Format, ObjectInterface) (bool, error)
	FromJson([]byte) error
	SetRuntime(*commonv1.Runtime)
	GetRuntime() *commonv1.Runtime
	GetKind() string
	ResolveReferences(ObjectInterface) ([]IDefinition, error)
	ToJson() ([]byte, error)
	ToJsonWithKind() ([]byte, error)
	ToJsonString() (string, error)
	Validate() (bool, error)
}