Compare returns the result of analysing breaking and non breaking changes between to Swagger specs.

FromStringArray starts a fluent diff expression.

FromStringMap starts a comparison by declaring a source map.

JSONMarshal allows the item to be correctly rendered to json.

NewSpecAnalyser returns an empty SpecDiffs.

AddedConsumesFormat - a new consumes format (json/xml/yaml etc) has been added in the new spec.

AddedDescripton - Added a description.

AddedEndpoint - An endpoint has been added in the new spec.

AddedEnumValue - An enum type has had a new potential value added to it.

AddedOptionalParam - A new optional parameter has been added to the new spec.

AddedProducesFormat - a new produces format (json/xml/yaml etc) has been added in the new spec.

AddedProperty - A message property has been added in the new spec.

AddedRequiredParam - A required parameter has been added in the new spec.

AddedRequiredProperty - A required message property has been added in the new spec.

AddedResponse An endpoint has new response code in the new spec.

AddedResponseHeader Added a header Item.

AddedSchemes - a new scheme has been added to the new spec.

AddedTag - Added a tag.

Breaking this change could break existing clients.

ChangedBasePath - the host base path has been changed.

ChangedDescripton - Changed a description.

ChangedHostURL - the host url has been changed.

ChangedOptionalToRequiredParam - An optional parameter is now required in the new spec.

ChangedRequiredToOptional - A required parameter has been made optional in the new spec.

ChangedRequiredToOptionalParam - An required parameter is now optional in the new spec.

ChangedResponseHeader Added a header Item.

ChangedTag - Changed a tag.

ChangedToCompatibleType - An type has been changed to a compatible type eg password->string.

ChangedType - An type has been changed to a type whose relative compatibility cannot be determined.

DeletedConsumesFormat - an existing format has been removed in the new spec.

DeletedDeprecatedEndpoint - A deprecated endpoint has been deleted in the new spec.

DeletedDescripton - Deleted a description.

DeletedEndpoint - An endpoint has been deleted in the new spec.

DeletedEnumValue - An enum type has had a existing value removed from it.

DeletedOptionalParam - An endpoint parameter has been deleted in the new spec.

DeletedProducesFormat - an existing produces format has been removed in the new spec.

DeletedProperty - A message property has been deleted in the new spec.

DeletedRequiredParam - A required parameter has been deleted in the new spec.

DeletedResponse - An endpoint response has been deleted in the new spec.

DeletedResponseHeader Added a header Item.

DeletedSchemes - a scheme has been removed from the new spec.

DeletedTag - Deleted a tag.

NarrowedType - An type has been changed to a less permissive type eg string->int.

NoChangeDetected - the specs have no changes.

NonBreaking This is a backwards-compatible API change.

Request Used for messages/param diffs in a request.

Response Used for messages/param diffs in a response.

WidenedType - An type has been changed to a more permissive type eg int->string.

ArrayType const for array.

CompatibilityPolicy decides which changes are breaking and which are not.

DifferenceLocation indicates where the difference occurs.

FromArrayStruct utility struct to encompass diffing of string arrays.

FromMapStruct utility struct to encompass diffing of string arrays.

Node is the position od a diff in a spec.

Pair stores a pair of items which share a key in two maps.

PathItemOp - combines path and operation into a single keyed entity.

SpecAnalyser contains all the differences for a Spec.

SpecDifference encapsulates the details of an individual diff in part of a spec.

TypeDiff - describes a primitive type change.

URLMethod - combines url and method into a single keyed entity.

URLMethodResponse encapsulates these three elements to act as a map key.

Compatibility - whether this is a breaking or non-breaking change.

DataDirection indicates the direction of change Request vs Response.

OperationMap saves indexing operations in PathItems individually.

SpecChangeCode enumerates the various types of diffs from one spec to another.

SpecDifferences list of differences.

URLMethods allows iteration of endpoints based on url and method.