validation

Documentation

Index

• func ValidFileTypes() []string
• type FileType
  • func DetectFileType(filePath string) (FileType, error)
• type Issue
  • func (i Issue) String() string
• type Result
  • func ValidateBytes(data []byte, ft FileType, strict bool) (*Result, error)
  • func ValidateFile(filePath string, ft FileType, strict bool) (*Result, error)

Functions

func ValidFileTypes

func ValidFileTypes() []string

ValidFileTypes returns the list of accepted --type values.

Types

type FileType

type FileType string

FileType identifies which schema to validate against.

const (
	FileTypeFlowFile  FileType = "flowfile"
	FileTypeWorkspace FileType = "workspace"
	FileTypeConfig    FileType = "config"
	FileTypeTemplate  FileType = "template"
)

func DetectFileType

func DetectFileType(filePath string) (FileType, error)

DetectFileType infers the schema type from the file's name.

type Issue

type Issue struct {
	Path    string `json:"path"`
	Message string `json:"message"`
}

Issue represents a single validation error.

func (Issue) String

func (i Issue) String() string

type Result

type Result struct {
	Valid  bool    `json:"valid"`
	Errors []Issue `json:"errors,omitempty"`
}

Result holds the outcome of a validation.

func ValidateBytes

func ValidateBytes(data []byte, ft FileType, strict bool) (*Result, error)

ValidateBytes validates raw YAML content against the schema for the given file type.

func ValidateFile

func ValidateFile(filePath string, ft FileType, strict bool) (*Result, error)

ValidateFile reads a file from disk and validates it against the appropriate schema.