Documentation
¶
Overview ¶
Package reports provides summarized, flattened views over the hierarchical change trees produced by the what-changed model.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type HasChanges ¶
type HasChanges interface {
// TotalChanges represents number of all changes found.
TotalChanges() int
// TotalBreakingChanges represents the number of contract breaking changes only.
TotalBreakingChanges() int
}
HasChanges represents a change model that provides a total change count and a breaking change count.
type OverallReport ¶
OverallReport provides a document level overview of all changes to an AsyncAPI doc.
func CreateOverallReport ¶
func CreateOverallReport(changes *model.DocumentChanges) *OverallReport
CreateOverallReport creates a high level report for all top level changes (with deep counts).
Click to show internal directories.
Click to hide internal directories.