schema

Documentation

Index

• Constants
• Variables
• func LinkByName(links []*ipld.Link, name string) *ipld.Link
• func ValidateMill(mill string) bool
• type Link
• type Node
• type Step
  • func Steps(links map[string]*Link) ([]Step, error)

Constants

const FileTag = ":file"

FileTag indicates the link should "use" the input file as source

const SingleFileTag = ":single"

SingleFileTag is a magic key indicating that a directory is actually a single file

Variables

var ErrBadJsonSchema = errors.New("json schema is not valid")

ErrBadJsonSchema indicates json schema is invalid

var ErrEmptySchema = errors.New("schema does not create any files")

ErrEmptySchema indicates a schema is empty

var ErrFileValidationFailed = errors.New("file failed schema validation")

ErrFileValidationFailed indicates dag schema validation failed

var ErrLinkOrderNotSolvable = errors.New("link order is not solvable")

ErrLinkOrderNotSolvable

var ErrMissingJsonSchema = errors.New("json mill requires a json schema")

ErrMissingJsonSchema indicates json schema is missing

var ErrSchemaInvalidMill = errors.New("schema contains an invalid mill")

ErrSchemaInvalidMill indicates a schema has an invalid mill entry

Functions

func LinkByName

func LinkByName(links []*ipld.Link, name string) *ipld.Link

LinkByName find a link w/ the given name in the provided list

func ValidateMill

func ValidateMill(mill string) bool

ValidateMill is false if mill is not one of the built in tags

Types

type Link

type Link struct {
	Use        string                 `json:"use,omitempty"`
	Pin        bool                   `json:"pin"`
	Plaintext  bool                   `json:"plaintext"`
	Mill       string                 `json:"mill,omitempty"`
	Opts       map[string]string      `json:"opts,omitempty"`
	JsonSchema map[string]interface{} `json:"json_schema,omitempty"`
}

Link is a sub-node which can "use" input from other sub-nodes

type Node

type Node struct {
	Name       string                 `json:"name,omitempty"`
	Pin        bool                   `json:"pin"`
	Plaintext  bool                   `json:"plaintext"`
	Mill       string                 `json:"mill,omitempty"`
	Opts       map[string]string      `json:"opts,omitempty"`
	JsonSchema map[string]interface{} `json:"json_schema,omitempty"`
	Links      map[string]*Link       `json:"links,omitempty"`
}

Node describes a DAG node

type Step

type Step struct {
	Name string
	Link *Link
}

Step is an ordered name-link pair

func Steps

func Steps(links map[string]*Link) ([]Step, error)

Steps returns link steps in the order they should be processed