CheckRefChange has the property ref changed.

CheckStringTypeChanges checks for changes to or from a string type.

CheckToFromPrimitiveType check for diff to or from a primitive.

CheckToFromRequired checks for changes to or from a required property.

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

CompareEnums returns added, deleted enum values.

CompareFloatValues compares a float data item.

CompareIntValues compares to int data items.

CompareProperties recursive property comparison.

JSONMarshal allows the item to be correctly rendered to json.

NewSpecAnalyser returns an empty SpecDiffs.

AddedConstraint Added a schema constraint.

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

AddedDefinition removed one of the definitions.

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.

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

ChangedRequiredToOptional - 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.

DeletedConstraint Deleted a schema constraint.

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

DeletedDefinition removed one of the definitions.

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.

RefTargetChanged Changed a ref to point to a different object.

RefTargetRenamed Renamed a ref to point to the same object.

Request Used for messages/param diffs in a request.

Response Used for messages/param diffs in a response.

StringType For identifying string types.

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

ArrayType const for array.

ObjectType const for object.

CompatibilityPolicy decides which changes are breaking and which are not.

DifferenceLocation indicates where the difference occurs.

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.

PropertyDefn combines a property with its required-ness.

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.

CompareSchemaFn Fn spec for comparing schemas.

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.

PropertyMap a unified map including all AllOf fields.

SchemaFromRefFn define this to get a schema for a ref.

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.