graph2md

Documentation

Index

• func Run(inputFiles, outputDir, repoName, repoURL string, maxEntities int) error
• type APIResponse
• type Artifact
• type DomainSummary
• type Graph
• type GraphResult
• type GraphStats
• type Node
• type Relationship
• type SubdomainSummary

Functions

func Run

func Run(inputFiles, outputDir, repoName, repoURL string, maxEntities int) error

Run executes graph2md conversion. inputFiles is a comma-separated list of paths to graph JSON files. outputDir is the directory for markdown output.

Types

type APIResponse

type APIResponse struct {
	Status string          `json:"status"`
	JobID  string          `json:"jobId"`
	Error  json.RawMessage `json:"error"`
	Result *GraphResult    `json:"result"`
}

type Artifact

type Artifact struct {
	Type  string          `json:"type"`
	Name  string          `json:"name"`
	Graph *Graph          `json:"graph"`
	Stats json.RawMessage `json:"stats"`
}

type DomainSummary

type DomainSummary struct {
	Name       string             `json:"name"`
	Subdomains []SubdomainSummary `json:"subdomains"`
	Files      []string           `json:"files"`
}

type Graph

type Graph struct {
	Nodes         []Node         `json:"nodes"`
	Relationships []Relationship `json:"relationships"`
}

type GraphResult

type GraphResult struct {
	GeneratedAt string          `json:"generatedAt"`
	Message     string          `json:"message"`
	Stats       GraphStats      `json:"stats"`
	Graph       Graph           `json:"graph"`
	Metadata    json.RawMessage `json:"metadata"`
	Domains     []DomainSummary `json:"domains"`
	Artifacts   []Artifact      `json:"artifacts"`
}

type GraphStats

type GraphStats struct {
	NodeCount         int            `json:"nodeCount"`
	RelationshipCount int            `json:"relationshipCount"`
	NodeTypes         map[string]int `json:"nodeTypes"`
	RelationshipTypes map[string]int `json:"relationshipTypes"`
}

type Node

type Node struct {
	ID         string                 `json:"id"`
	Labels     []string               `json:"labels"`
	Properties map[string]interface{} `json:"properties"`
}

type Relationship

type Relationship struct {
	ID         string                 `json:"id"`
	Type       string                 `json:"type"`
	StartNode  string                 `json:"startNode"`
	EndNode    string                 `json:"endNode"`
	Properties map[string]interface{} `json:"properties"`
}

type SubdomainSummary

type SubdomainSummary struct {
	Name               string   `json:"name"`
	DescriptionSummary string   `json:"descriptionSummary"`
	Files              []string `json:"files"`
	Functions          []string `json:"functions"`
	Classes            []string `json:"classes"`
}