schema

Documentation

Overview

Package schema loads Mache topology schemas from bundled presets or files.

Index

• func AvailablePresets() []string
• func ParseTopology(data []byte) (*api.Topology, error)
• type Resolution
  • func LoadPreset(name string) (*Resolution, error)
  • func Resolve(ref, baseDir string) (*Resolution, error)

Functions

func AvailablePresets

func AvailablePresets() []string

AvailablePresets returns the sorted names of all bundled schemas.

func ParseTopology

func ParseTopology(data []byte) (*api.Topology, error)

ParseTopology decodes a topology schema.

Types

type Resolution

type Resolution struct {
	Topology  *api.Topology
	Languages []string
}

Resolution is a loaded topology plus language identity known from its reference. Languages is populated for language presets because the preset JSON intentionally carries no Node.Language filters.

func LoadPreset

func LoadPreset(name string) (*Resolution, error)

LoadPreset loads a bundled schema by name.

func Resolve

func Resolve(ref, baseDir string) (*Resolution, error)

Resolve loads a preset name, absolute schema path, or schema path relative to baseDir. Relative paths must remain inside baseDir after symlink resolution. An empty ref resolves to an empty Resolution.