Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

diff

package

Go to main page

Versions in this module

v0

v0.25.5

Jul 20, 2026

v0.25.4

Jul 20, 2026

v0.25.3

Jun 27, 2026

v0.25.2

Jun 2, 2026

v0.25.1

May 25, 2026

v0.25.0

Mar 17, 2026

Changes in this version

+ const ErrDiff

+ const StringType

+ var ArrayType = "array"

+ var ObjectType = "object"

+ func JSONMarshal(t any) ([]byte, error)

+ type CompareSchemaFn func(location DifferenceLocation, schema1, schema2 *spec.Schema)

+ type Compatibility int

+ const Breaking

+ const NonBreaking

+ const Warning

+ func (s *Compatibility) UnmarshalJSON(b []byte) error

+ func (s Compatibility) MarshalJSON() ([]byte, error)

+ func (s Compatibility) String() string

+ type CompatibilityPolicy struct

+ ForChange map[SpecChangeCode]Compatibility

+ ForRequest map[SpecChangeCode]Compatibility

+ ForResponse map[SpecChangeCode]Compatibility

+ type DataDirection int

+ const Request

+ const Response

+ type DifferenceLocation struct

+ Method string

+ Node *Node

+ Response int

+ URL string

+ func (dl DifferenceLocation) AddNode(node *Node) DifferenceLocation

+ type Node struct

+ ChildNode *Node

+ Field string

+ IsArray bool

+ TypeName string

+ func (n *Node) AddLeafNode(toAdd *Node) *Node

+ func (n *Node) String() string

+ func (n Node) Copy() *Node

+ type OperationMap map[string]*spec.Operation

+ type Pair struct

+ First any

+ Second any

+ type PathItemOp struct

+ Extensions spec.Extensions

+ Operation *spec.Operation

+ ParentPathItem *spec.PathItem

+ type PropertyDefn struct

+ Required bool

+ Schema *spec.Schema

+ type PropertyMap map[string]PropertyDefn

+ type SchemaFromRefFn func(spec.Ref) (*spec.Schema, string)

+ type SpecAnalyser struct

+ Definitions1 spec.Definitions

+ Definitions2 spec.Definitions

+ Diffs SpecDifferences

+ Info1 *spec.Info

+ Info2 *spec.Info

+ ReferencedDefinitions map[string]bool

+ func NewSpecAnalyser() *SpecAnalyser

+ func (sd *SpecAnalyser) Analyse(spec1, spec2 *spec.Swagger) error

+ func (sd *SpecAnalyser) AnalyseDefinitions()

+ func (sd *SpecAnalyser) CompareProps(type1, type2 *spec.SchemaProps) []TypeDiff

+ type SpecChangeCode int

+ const AddedConstraint

+ const AddedConsumesFormat

+ const AddedDefault

+ const AddedDefinition

+ const AddedDescription

+ const AddedEndpoint

+ const AddedEnumValue

+ const AddedExample

+ const AddedExtension

+ const AddedOptionalParam

+ const AddedProducesFormat

+ const AddedProperty

+ const AddedRequiredParam

+ const AddedRequiredProperty

+ const AddedResponse

+ const AddedResponseHeader

+ const AddedSchemes

+ const AddedTag

+ const ChangedBasePath

+ const ChangedCollectionFormat

+ const ChangedDefault

+ const ChangedDescription

+ const ChangedExample

+ const ChangedExtensionValue

+ const ChangedHostURL

+ const ChangedOptionalToRequired

+ const ChangedRequiredToOptional

+ const ChangedResponseHeader

+ const ChangedTag

+ const ChangedToCompatibleType

+ const ChangedType

+ const DeletedConstraint

+ const DeletedConsumesFormat

+ const DeletedDefault

+ const DeletedDefinition

+ const DeletedDeprecatedEndpoint

+ const DeletedDescription

+ const DeletedEndpoint

+ const DeletedEnumValue

+ const DeletedExample

+ const DeletedExtension

+ const DeletedOptionalParam

+ const DeletedProducesFormat

+ const DeletedProperty

+ const DeletedRequiredParam

+ const DeletedResponse

+ const DeletedResponseHeader

+ const DeletedSchemes

+ const DeletedTag

+ const NarrowedType

+ const NoChangeDetected

+ const RefTargetChanged

+ const RefTargetRenamed

+ const WidenedType

+ func (s *SpecChangeCode) UnmarshalJSON(b []byte) error

+ func (s SpecChangeCode) Description() (result string)

+ func (s SpecChangeCode) MarshalJSON() ([]byte, error)

+ type SpecDifference struct

+ Code SpecChangeCode

+ Compatibility Compatibility

+ DiffInfo string

+ DifferenceLocation DifferenceLocation

+ func CompareProperties(location DifferenceLocation, schema1, schema2 *spec.Schema, ...) []SpecDifference

+ func (sd SpecDifference) Matches(other SpecDifference) bool

+ func (sd SpecDifference) String() string

+ type SpecDifferences []SpecDifference

+ func Compare(spec1, spec2 *spec.Swagger) (diffs SpecDifferences, err error)

+ func (sd *SpecDifferences) ReportCompatibility() (io.Reader, error, error)

+ func (sd SpecDifferences) BreakingChangeCount() int

+ func (sd SpecDifferences) Contains(diff SpecDifference) bool

+ func (sd SpecDifferences) FilterIgnores(ignores SpecDifferences) SpecDifferences

+ func (sd SpecDifferences) ReportAllDiffs(fmtJSON bool) (io.Reader, error, error)

+ func (sd SpecDifferences) WarningChangeCount() int

+ type TypeDiff struct

+ Change SpecChangeCode

+ Description string

+ FromType string

+ ToType string

+ func CheckRefChange(diffs []TypeDiff, type1, type2 any) (diffReturn []TypeDiff)

+ func CheckStringTypeChanges(diffs []TypeDiff, type1, type2 *spec.SchemaProps) []TypeDiff

+ func CheckToFromPrimitiveType(diffs []TypeDiff, type1, type2 any) []TypeDiff

+ func CheckToFromRequired(required1, required2 bool) (diffs []TypeDiff)

+ func CompareEnums(left, right []any) []TypeDiff

+ func CompareFloatValues(fieldName string, val1 *float64, val2 *float64, ifGreaterCode SpecChangeCode, ...) []TypeDiff

+ func CompareIntValues(fieldName string, val1 *int64, val2 *int64, ifGreaterCode SpecChangeCode, ...) []TypeDiff

+ type URLMethod struct

+ Method string

+ Path string

+ func (p URLMethod) MarshalText() (text []byte, err error)

+ type URLMethodResponse struct

+ Method string

+ Path string

+ Response string

+ type URLMethods map[URLMethod]*PathItemOp