recipe

Documentation

Index

• type Framework
• type Metadata
• type Recipe
  • func LoadWithReader(reader plugin.Reader, decoder plugin.Decoder) (*Recipe, error)
• type Resource

Types

type Framework

type Framework struct {
	AllowError    bool        `yaml:"allow_error"`
	Name          string      `yaml:"name" validate:"required"`
	Schemas       []*Metadata `yaml:"schemas"`
	Definitions   []*Metadata `yaml:"definitions"`
	Procedures    []*Metadata `yaml:"procedures"`
	OutputTargets []*Metadata `yaml:"output_targets"`
}

Framework is a recipe on how how and where to read the actual Framework data

type Metadata

type Metadata struct {
	Name          string `yaml:"name" validate:"required"`
	Format        string `yaml:"format" validate:"required"`
	Type          string `yaml:"type" validate:"required"`
	Path          string `yaml:"path" validate:"required"`
	OutputIsError bool   `yaml:"output_is_error"`
}

Metadata holds information to where and how a data is stored

type Recipe

type Recipe struct {
	Frameworks []*Framework `yaml:"frameworks" validate:"required"`
	Resources  []*Resource  `yaml:"resources"`
}

Recipe is the main structure for storing recipe execution flow

func LoadWithReader

func LoadWithReader(reader plugin.Reader, decoder plugin.Decoder) (*Recipe, error)

LoadWithReader loads recipe from the passed Reader with Decoder to decode

type Resource

type Resource struct {
	Name           string   `yaml:"name" validate:"required"`
	Format         string   `yaml:"format" validate:"required"`
	Type           string   `yaml:"type" validate:"required"`
	Path           string   `yaml:"path" validate:"required"`
	FrameworkNames []string `yaml:"framework_names" validate:"required"`
}

Resource is a recipe on how how and where to read the actual Resource data