Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Component ¶
type Component struct { ID string Kind string Name string Description string Technology string Tags []string }
Component is an open structure that represents details of scraped component.
ID is a unique identifier of the component. Kind is a type that reflects component level in terms of C4 diagrams. Name is a component name. Description explains the responsibility of the component. Technology describes technology that the component is based on. Tags is a set of generic string tags that may be used as reference to a group of components.
type HasInfo ¶
type HasInfo interface {
Info() Info
}
HasInfo wraps simple getter method returning component information.
HasInfo interface informs that the type is able to provide component information on its own. All the types that implement the interface are automatically detected by default implementation of the scraper.
type Info ¶
Info struct contains all component information details.
Name is a component name. Kind is a type that reflects component level in terms of C4 diagrams. Description explains the responsibility of the component. Technology describes technology that the component is based on. Tags is a set of generic string tags that may be used as reference to a group of components.
func ComponentInfo ¶
ComponentInfo instantiates a new component of predefined kind "component". Variadic arguments are assigned to the rest of Info properties one-by-one.
type Structure ¶
Structure is an open stricture that represents whole scraped structure.
Components contains all the scraped components by its IDs. Relations contains all the connections between components by its IDs.
func (Structure) AddComponent ¶
AddComponent adds component and corresponding relation to its parent.
In case a parent of given ID does not exist relation will not be created.