v1alpha1

Documentation

Index

• func CreateComponent(db *database.Handler, c ComponentDefinition) (uuid.UUID, error)
• func CreateRelationship(db *database.Handler, r RelationshipDefinition) (uuid.UUID, error)
• type ComponentDefinition
  • func GetMeshModelComponents(db *database.Handler, f ComponentFilter) (c []ComponentDefinition)
  • func (c *ComponentDefinition) GetComponentDefinitionDB() (cmd ComponentDefinitionDB)
  • func (c ComponentDefinition) GetID() uuid.UUID
  • func (c ComponentDefinition) Type() types.CapabilityType
• type ComponentDefinitionDB
  • func (cmd *ComponentDefinitionDB) GetComponentDefinition(model Model) (c ComponentDefinition)
• type ComponentFilter
  • func (cf *ComponentFilter) Create(m map[string]interface{})
• type ComponentFormat
• type Model
• type ModelFilter
  • func (cf *ModelFilter) Create(m map[string]interface{})
• type RelationshipDefinition
  • func GetMeshModelRelationship(db *database.Handler, f RelationshipFilter) (r []RelationshipDefinition)
  • func (r RelationshipDefinition) GetID() uuid.UUID
  • func (r *RelationshipDefinition) GetRelationshipDefinitionDB() (rdb RelationshipDefinitionDB)
  • func (r RelationshipDefinition) Type() types.CapabilityType
• type RelationshipDefinitionDB
  • func (rdb *RelationshipDefinitionDB) GetRelationshipDefinition(m Model) (r RelationshipDefinition)
• type RelationshipFilter
  • func (rf *RelationshipFilter) Create(m map[string]interface{})
• type TypeMeta

Functions

func CreateComponent

func CreateComponent(db *database.Handler, c ComponentDefinition) (uuid.UUID, error)

func CreateRelationship

func CreateRelationship(db *database.Handler, r RelationshipDefinition) (uuid.UUID, error)

Types

type ComponentDefinition

type ComponentDefinition struct {
	ID uuid.UUID `json:"-"`
	TypeMeta
	DisplayName string                 `json:"display-name" gorm:"display-name"`
	Format      ComponentFormat        `json:"format" yaml:"format"`
	Metadata    map[string]interface{} `json:"metadata" yaml:"metadata"`
	Model       Model                  `json:"model"`
	Schema      string                 `json:"schema" yaml:"schema"`
	CreatedAt   time.Time              `json:"-"`
	UpdatedAt   time.Time              `json:"-"`
}

swagger:response ComponentDefinition use NewComponent function for instantiating

func GetMeshModelComponents

func GetMeshModelComponents(db *database.Handler, f ComponentFilter) (c []ComponentDefinition)

func (*ComponentDefinition) GetComponentDefinitionDB

func (c *ComponentDefinition) GetComponentDefinitionDB() (cmd ComponentDefinitionDB)

func (ComponentDefinition) GetID

func (c ComponentDefinition) GetID() uuid.UUID

func (ComponentDefinition) Type

func (c ComponentDefinition) Type() types.CapabilityType

type ComponentDefinitionDB

type ComponentDefinitionDB struct {
	ID      uuid.UUID `json:"-"`
	ModelID uuid.UUID `json:"-" gorm:"modelID"`
	TypeMeta
	DisplayName string          `json:"display-name" gorm:"display-name"`
	Format      ComponentFormat `json:"format" yaml:"format"`
	Metadata    []byte          `json:"metadata" yaml:"metadata"`
	Schema      string          `json:"schema" yaml:"schema"`
	CreatedAt   time.Time       `json:"-"`
	UpdatedAt   time.Time       `json:"-"`
}

func (*ComponentDefinitionDB) GetComponentDefinition

func (cmd *ComponentDefinitionDB) GetComponentDefinition(model Model) (c ComponentDefinition)

type ComponentFilter

type ComponentFilter struct {
	Name       string
	APIVersion string
	Greedy     bool //when set to true - instead of an exact match, name will be prefix matched
	ModelName  string
	Version    string
	Sort       string //asc or desc. Default behavior is asc
	OrderOn    string
	Limit      int //If 0 or  unspecified then all records are returned and limit is not used
	Offset     int
}

func (*ComponentFilter) Create

func (cf *ComponentFilter) Create(m map[string]interface{})

Create the filter from map[string]interface{}

type ComponentFormat

type ComponentFormat string

const (
	JSON ComponentFormat = "JSON"
	YAML ComponentFormat = "YAML"
	CUE  ComponentFormat = "CUE"
)

type Model

type Model struct {
	ID          uuid.UUID `json:"-"`
	Name        string    `json:"name"`
	Version     string    `json:"version"`
	DisplayName string    `json:"model-display-name" gorm:"display-name"`
	Category    string    `json:"category"`
	SubCategory string    `json:"sub-category"`
}

swagger:response Model

type ModelFilter

type ModelFilter struct {
	Name     string
	Greedy   bool //when set to true - instead of an exact match, name will be prefix matched
	Version  string
	Category string
	OrderOn  string
	Sort     string //asc or desc. Default behavior is asc
	Limit    int    //If 0 or  unspecified then all records are returned and limit is not used
	Offset   int
}

func (*ModelFilter) Create

func (cf *ModelFilter) Create(m map[string]interface{})

Create the filter from map[string]interface{}

type RelationshipDefinition

type RelationshipDefinition struct {
	ID uuid.UUID `json:"-"`
	TypeMeta
	Model     Model                  `json:"model"`
	Metadata  map[string]interface{} `json:"metadata" yaml:"metadata"`
	SubType   string                 `json:"subType" yaml:"subType" gorm:"subType"`
	Selectors map[string]interface{} `json:"selectors" yaml:"selectors"`
	CreatedAt time.Time              `json:"-"`
	UpdatedAt time.Time              `json:"-"`
}

https://docs.google.com/drawings/d/1_qzQ_YxvCWPYrOBcdqGMlMwfbsZx96SBuIkbn8TfKhU/edit?pli=1 see RELATIONSHIPDEFINITIONS table in the diagram swagger:response RelationshipDefinition TODO: Add support for Model

func GetMeshModelRelationship

func GetMeshModelRelationship(db *database.Handler, f RelationshipFilter) (r []RelationshipDefinition)

func (RelationshipDefinition) GetID

func (r RelationshipDefinition) GetID() uuid.UUID

func (*RelationshipDefinition) GetRelationshipDefinitionDB

func (r *RelationshipDefinition) GetRelationshipDefinitionDB() (rdb RelationshipDefinitionDB)

func (RelationshipDefinition) Type

func (r RelationshipDefinition) Type() types.CapabilityType

type RelationshipDefinitionDB

type RelationshipDefinitionDB struct {
	ID      uuid.UUID `json:"-"`
	ModelID uuid.UUID `json:"-" gorm:"modelID"`
	TypeMeta
	Metadata  []byte    `json:"metadata" yaml:"metadata"`
	SubType   string    `json:"subType" yaml:"subType"`
	Selectors []byte    `json:"selectors" yaml:"selectors"`
	CreatedAt time.Time `json:"-"`
	UpdatedAt time.Time `json:"-"`
}

func (*RelationshipDefinitionDB) GetRelationshipDefinition

func (rdb *RelationshipDefinitionDB) GetRelationshipDefinition(m Model) (r RelationshipDefinition)

type RelationshipFilter

type RelationshipFilter struct {
	Kind      string
	Greedy    bool //when set to true - instead of an exact match, kind will be prefix matched
	SubType   string
	Version   string
	ModelName string
	OrderOn   string
	Sort      string //asc or desc. Default behavior is asc
	Limit     int    //If 0 or  unspecified then all records are returned and limit is not used
	Offset    int
}

For now, only filtering by Kind and SubType are allowed. In the future, we will add support to query using `selectors` (using CUE) TODO: Add support for Model

func (*RelationshipFilter) Create

func (rf *RelationshipFilter) Create(m map[string]interface{})

Create the filter from map[string]interface{}

type TypeMeta

type TypeMeta struct {
	Kind       string `json:"kind,omitempty" yaml:"kind"`
	APIVersion string `json:"apiVersion,omitempty" yaml:"apiVersion"`
}