Documentation
¶
Overview ¶
Package differ reports what changed between two sets of definitions in API terms, after Pandora's data-api-differ: operations, options, bodies, models, fields and enum values added, removed or changed, with the changes that would break a caller of the generated SDK marked. make pandorest-diff runs it on a refreshed spec against the checked-in definitions before they are regenerated.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Change ¶
type Change struct {
Kind Kind
// Subject names it: "operation GetItems (GET /Items)".
Subject string
// Details are the differences within a changed subject.
Details []Detail
// Breaking is set when the change (or any detail) breaks callers.
Breaking bool
}
Change is one operation, model or constant that differs.
type Report ¶
type Report struct {
Service string
// Service-level differences: document version, workarounds applied.
Notes []string
Changes []Change
}
Report is every change between two versions of one service.
func Diff ¶
func Diff(older, newer *definitions.Service) Report
Diff compares old definitions with new ones.
Click to show internal directories.
Click to hide internal directories.