Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Change ¶
type Change struct {
Path string `json:"path"`
Type ChangeType `json:"type"`
OldValue interface{} `json:"oldValue,omitempty"`
NewValue interface{} `json:"newValue,omitempty"`
Classification Classification `json:"classification"`
Reason string `json:"reason"`
}
Change represents a single detected change between two contracts.
type ChangeType ¶
type ChangeType int
ChangeType describes how a field changed.
const ( Added ChangeType = iota Removed Modified )
func (ChangeType) MarshalJSON ¶
func (t ChangeType) MarshalJSON() ([]byte, error)
func (ChangeType) String ¶
func (t ChangeType) String() string
type Classification ¶
type Classification int
Classification represents the severity of a change.
const ( NonBreaking Classification = iota // Consumers are not affected. PotentialBreaking // Consumers may be affected. Breaking // Consumers are definitely affected. )
func (Classification) MarshalJSON ¶
func (c Classification) MarshalJSON() ([]byte, error)
func (Classification) String ¶
func (c Classification) String() string
type Result ¶
type Result struct {
Classification Classification `json:"classification"`
Changes []Change `json:"changes"`
SBOMDiff *sbom.Result `json:"sbomDiff,omitempty"`
}
Result holds the output of comparing two contracts.
Source Files
Click to show internal directories.
Click to hide internal directories.