v3

Documentation

Index

• Constants
• Variables
• func Load(r io.Reader) (*model.Model, error)
• func LoadFile(path string) (*model.Model, error)
• func ValidIdentifier[T interface{ ... }](in T) bool
• type Manifest
  • func (m *Manifest) ValidateNames() error
• type ModelInfo
• type ObjectType
• type ObjectTypeName
• type PermissionName
• type RelationName
• type SchemaVersion
  • func (v *SchemaVersion) UnmarshalYAML(value *yaml.Node) error

Constants

const SupportedSchemaVersion int = 3

Variables

var ErrInvalidIdentifier = errors.New("invalid identifier (" + msgInvalidIdentifier + ")")

Functions

func Load

func Load(r io.Reader) (*model.Model, error)

func LoadFile

func LoadFile(path string) (*model.Model, error)

func ValidIdentifier

func ValidIdentifier[T interface{ ~string }](in T) bool

Types

type Manifest

type Manifest struct {
	ModelInfo   *ModelInfo                     `yaml:"model"`
	ObjectTypes map[ObjectTypeName]*ObjectType `yaml:"types"`
}

func (*Manifest) ValidateNames

func (m *Manifest) ValidateNames() error

type ModelInfo

type ModelInfo struct {
	Version SchemaVersion `yaml:"version"`
}

type ObjectType

type ObjectType struct {
	Relations   map[RelationName]string   `yaml:"relations,omitempty"`
	Permissions map[PermissionName]string `yaml:"permissions,omitempty"`
}

type ObjectTypeName

type ObjectTypeName string

type PermissionName

type PermissionName string

type RelationName

type RelationName string

type SchemaVersion

type SchemaVersion int

func (*SchemaVersion) UnmarshalYAML

func (v *SchemaVersion) UnmarshalYAML(value *yaml.Node) error