core

Documentation

Index

• Constants
• type CompageJSON
• type ModificationDetails
• type Project

Constants

const Grpc = "GRPC"

Grpc Protocol

const Rest = "REST"

Rest Protocol

const Ws = "WS"

Ws Protocol

Types

type CompageJSON

type CompageJSON struct {
	// Linkages (connection details) between Nodes
	Edges []*coreedge.Edge `json:"edges"`
	// Nodes represent components and has details of the component.
	Nodes []*corenode.Node `json:"nodes"`
}

CompageJSON has all edges and nodes

type ModificationDetails

type ModificationDetails struct {
	CreatedBy string    `json:"createdBy"`
	UpdatedBy string    `json:"updatedBy"`
	CreatedAt time.Time `json:"createdAt"`
	UpdatedAt time.Time `json:"updatedAt"`
}

ModificationDetails has creation and modification details.

type Project

type Project struct {
	Name                string                 `json:"name"`
	CompageJSON         *CompageJSON           `json:"compageJSON"`
	GitRepositoryName   string                 `json:"gitRepositoryName"`
	GitRepositoryURL    string                 `json:"gitRepositoryURL"`
	GitPlatformName     string                 `json:"gitPlatformName"`
	GitPlatformURL      string                 `json:"gitPlatformURL"`
	GitPlatformUserName string                 `json:"gitPlatformUserName"`
	Metadata            map[string]interface{} `json:"metadata"`
	ModificationDetails
}

Project is top level struct depicting the monorepo and resembling to github repository. It has a single compage.json and can have multiple nodes and edges (projects and connections) internally.