reports

Documentation

Index

• type Changed
• type HasChanges
• type OverallReport
  • func CreateOverallReport(changes *model.DocumentChanges) *OverallReport

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 OpenAPI doc.

func CreateOverallReport

func CreateOverallReport(changes *model.DocumentChanges) *OverallReport

CreateOverallReport will create a high level report for all top level changes (but with deep counts)