parser

Documentation

Index

• type Entity
• type EntityMap
• type Metadata
• type ParsedSchema
  • func Parse(zedFile string) (ret *ParsedSchema, err error)
• type Relation
• type RelationTuple

Types

type Entity

type Entity struct {
	Relations map[string]*Relation `json:"relations" yaml:"relations"`
	Metadata  Metadata             `json:"metadata" yaml:"metadata"`
}

type EntityMap

type EntityMap map[string]*Entity

type Metadata

type Metadata struct {
	Comment    string                 `json:"comment" yaml:"comment"`
	Attributes map[string]interface{} `json:"attributes" yaml:"attributes"`
}

type ParsedSchema

type ParsedSchema struct {
	Entities   EntityMap `json:"entities" yaml:"entities"`
	SchemaHash string    `json:"schemaHash" yaml:"schemaHash"`
	Warnings   []string  `json:"warnings,omitempty" yaml:"warnings,omitempty"`
}

func Parse

func Parse(zedFile string) (ret *ParsedSchema, err error)

Parse parses the provided zedFile and returns a mapping of the definitions it contains.

err will be non-nil if an error occurs while opening or compiling the schema file

type Relation

type Relation struct {
	Type                   string          `json:"type" yaml:"type"`
	Metadata               Metadata        `json:"metadata" yaml:"metadata"`
	DownstreamPermissions  []RelationTuple `json:"downstreamPermissions,omitempty" yaml:"downstreamPermissions,omitempty"`
	AllowedDirectRelations []RelationTuple `json:"allowedDirectRelations,omitempty" yaml:"allowedDirectRelations,omitempty"`
}

type RelationTuple

type RelationTuple struct {
	Entity   string `json:"entity" yaml:"entity"`
	Relation string `json:"relation,omitempty" yaml:"relation,omitempty"`
}