Help us shape the future of Go! Take the 2026 Go Developer Survey

reports

package
v0.41.7 Latest Latest
Warning

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

Go to latest
Published: Oct 24, 2026 License: MIT Imports: 2 Imported by: 10

Documentation

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

Jump to

Keyboard shortcuts

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