glossary

Documentation

Index

• type Attribute
• type Entity
  • func (e Entity) GetAttribute(name string) *Attribute
• type Glossary
  • func LoadGlossaryFromFile(path string) (*Glossary, error)
  • func (g *Glossary) GetEntity(name string) *Entity
  • func (g *Glossary) Merge(anotherGlossary *Glossary)
• type GlossaryReader
  • func (r *GlossaryReader) GetEntities(pathToPipeline string) ([]*Entity, error)
  • func (r *GlossaryReader) GetGlossary(pipelinePath string) (*Glossary, error)

Types

type Attribute

type Attribute struct {
	Name        string `json:"name" yaml:"name"`
	Description string `json:"description" yaml:"description"`
	Type        string `json:"type" yaml:"type"`
}

type Entity

type Entity struct {
	Name        string                `json:"name" yaml:"name"`
	Description string                `json:"description" yaml:"description"`
	Attributes  map[string]*Attribute `json:"attributes" yaml:"attributes"`
}

func (Entity) GetAttribute

func (e Entity) GetAttribute(name string) *Attribute

type Glossary

type Glossary struct {
	Entities []*Entity `yaml:"entities" json:"entities"`
}

func LoadGlossaryFromFile

func LoadGlossaryFromFile(path string) (*Glossary, error)

func (*Glossary) GetEntity

func (g *Glossary) GetEntity(name string) *Entity

func (*Glossary) Merge

func (g *Glossary) Merge(anotherGlossary *Glossary)

type GlossaryReader

type GlossaryReader struct {
	FileNames  []string
	RepoFinder repoFinder
	// contains filtered or unexported fields
}

func (*GlossaryReader) GetEntities

func (r *GlossaryReader) GetEntities(pathToPipeline string) ([]*Entity, error)

func (*GlossaryReader) GetGlossary

func (r *GlossaryReader) GetGlossary(pipelinePath string) (*Glossary, error)