Help us shape the future of Go! Take the 2026 Go Developer Survey

glossary

package
v0.11.783 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 19, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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 Contact added in v0.11.270

type Contact struct {
	Type    string `json:"type" yaml:"type,omitempty"`
	Address string `json:"address" yaml:"address,omitempty"`
}

type Domain added in v0.11.270

type Domain struct {
	Name         string     `json:"name" yaml:"name,omitempty"`
	Description  string     `json:"description" yaml:"description,omitempty"`
	ParentDomain string     `json:"parent_domain" yaml:"parent_domain,omitempty"`
	Owners       []string   `json:"owners" yaml:"owners,omitempty"`
	Tags         []string   `json:"tags" yaml:"tags,omitempty"`
	Contact      []*Contact `json:"contact" yaml:"contact,omitempty"`
}

type Entity

type Entity struct {
	Name        string                `json:"name" yaml:"name"`
	Description string                `json:"description" yaml:"description"`
	Domains     []string              `json:"domains" yaml:"domains,omitempty"`
	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"`
	Domains  []*Domain `yaml:"domains,omitempty" json:"domains"`
}

func LoadGlossaryFromFile

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

func (*Glossary) GetDomain added in v0.11.275

func (g *Glossary) GetDomain(name string) *Domain

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)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL