differ

type CategoryMode ¶

type CategoryMode uint8

CategoryMode qualifies the nature of a schema change, such as version of jsonchema, metadata only, validations only etc.

Several categories may apply to a single change.

const (
	CategoryNone    CategoryMode = 1 << iota
	CategoryVersion              // JSON schema version
	CategoryMetadata
	CategoryLocation // change in $ref
	CategoryValidation
	CategoryDataType
)

type Change ¶

type Change struct {
	// contains filtered or unexported fields
}

type ChangesOption ¶

type ChangesOption func(*changesOptions)

type Differ ¶

type Differ struct {
	// contains filtered or unexported fields
}

Differ knows how to compare two versions of a json schema.

func New(opts ...Option) *Differ

func (d *Differ) Diff(old, new jsonschema.Schema) Result

func (d *Differ) Patch(old, new jsonschema.Schema) jsonschema.Overlay

type Option ¶

type Option func(*options)

func WithIgnoreCosmeticChanges(enabled bool) Option

type ReportOption ¶

type ReportOption func(*reportOptions)

func WithThreshold(minSeverity Severity) ReportOption

type ReportOutputMode ¶

type ReportOutputMode uint8

const (
	ReportOutputTable ReportOutputMode = 1 << iota
	ReportOutputMarkdown
	ReportOutputHTML
)

type Result ¶

type Result struct {
	// contains filtered or unexported fields
}

Result of the differences analysis between two schemas.

func (r Result) Changes(opts ...ChangesOption) iter.Seq[Change]

type Severity ¶

type Severity uint8

Severity qualifies the impact of a change, from cosmetic to breaking change.

const (
	SeverityNone Severity = iota
	SeverityCosmetic
	SeverityDocOnly
	SeverityPatch
	SeverityMinor // compatible
	SeverityBreaking
)

func (s Severity) Less(other Severity) bool

type Type ¶

type Type uint

Type of change, e.g. update, addition or deletion.

const (
	TypeNoChange Type = iota
	Deleted
	Added
	Updated
)

type ValidationCategory ¶

type ValidationCategory uint8

ValidationCategory indicates more precisely the type of validation to which a change with ValidationCategory is eligible.

const (
	NumberValidation ValidationCategory = iota
	StringValidation
	ObjectValidation
	ArrayValidation
	EnumValidation
)