reports

package
v0.0.2 Latest Latest
Warning

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

Go to latest
Published: Jul 12, 2026 License: MIT Imports: 2 Imported by: 0

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 Changed

type Changed struct {
	Total    int `json:"totalChanges"`
	Breaking int `json:"breakingChanges"`
}

Changed provides a simple wrapper for changed counts.

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

type OverallReport struct {
	ChangeReport map[string]*Changed `json:"overallSummaryReport"`
}

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).

Jump to

Keyboard shortcuts

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