package
0.18.2
Repository: https://github.com/pb33f/libopenapi.git
Documentation: pkg.go.dev

# Functions

CheckExtensions is a helper method to un-pack a left and right model that contains extensions.
CheckForAddition will check left and right yaml.Node instances for changes.
CheckForModification will check left and right yaml.Node instances for changes.
CheckForObjectAdditionOrRemoval will check for the addition or removal of an object from left and right maps.
CheckForRemoval will check left and right yaml.Node instances for changes.
CheckMapForAdditionRemoval checks a left and right low level map for any additions or subtractions, but not modifications.
CheckMapForChanges checks a left and right low level map for any additions, subtractions or modifications to values.
CheckMapForChangesWithComp checks a left and right low level map for any additions, subtractions or modifications to values.
CheckProperties will iterate through a slice of PropertyCheck pointers of type T.
CheckPropertyAdditionOrRemoval will run both CheckForRemoval (first) and CheckForAddition (second).
CheckSpecificObjectAdded returns true if a specific value is not in both maps.
CheckSpecificObjectRemoved returns true if a specific value is not in both maps.
CompareCallback will compare two Callback objects and return a pointer to CallbackChanges with all the things that have changed between them.
CompareComponents will compare OpenAPI components for any changes.
CompareContact will check a left (original) and right (new) Contact object for any changes.
CompareDiscriminator will check a left (original) and right (new) Discriminator object for changes and will return a pointer to DiscriminatorChanges.
CompareDocuments will compare any two OpenAPI documents (either Swagger or OpenAPI) and return a pointer to DocumentChanges that outlines everything that was found to have changed.
CompareEncoding returns a pointer to *EncodingChanges that contain all changes made between a left and right set of Encoding objects.
CompareExamples returns a pointer to ExampleChanges that contains all changes made between left and right Example instances.
CompareExamplesV2 compares two Swagger Examples objects, returning a pointer to ExamplesChanges if anything was found.
CompareExtensions will compare a left and right map of Tag/ValueReference models for any changes to anything.
CompareExternalDocs will compare a left (original) and a right (new) slice of ValueReference nodes for any changes between them.
CompareHeaders will compare left and right Header objects (any version of Swagger or OpenAPI) and return a pointer to HeaderChanges with anything that has changed, or nil if nothing changed.
CompareHeadersV2 is a Swagger compatible, typed signature used for other generic functions.
CompareHeadersV3 is an OpenAPI 3+ compatible, typed signature used for other generic functions.
CompareInfo will compare a left (original) and a right (new) Info object.
CompareItems compares two sets of Swagger Item objects.
CompareLicense will check a left (original) and right (new) License object for any changes.
CompareLinks checks a left and right OpenAPI Link for any changes.
CompareMediaTypes compares a left and a right MediaType object for any changes.
CompareOAuthFlow checks a left and a right OAuthFlow object for changes.
CompareOAuthFlows compares a left and right OAuthFlows object.
CompareOperations compares a left and right Swagger or OpenAPI Operation object.
CompareParameters compares a left and right Swagger or OpenAPI Parameter object for any changes.
CompareParametersV3 is an OpenAPI type safe proxy for CompareParameters.
ComparePathItems compare a left and right Swagger or OpenAPI PathItem object for changes.
ComparePathItemsV3 is an OpenAPI typesafe proxy method for ComparePathItems.
ComparePaths compares a left and right Swagger or OpenAPI Paths Object for changes.
CompareRequestBodies compares a left and right OpenAPI RequestBody object for changes.
CompareResponse compares a left and right Swagger or OpenAPI Response object.
CompareResponses compares a left and right Swagger or OpenAPI Responses object for any changes.
CompareResponseV2 is a Swagger type safe proxy for CompareResponse.
CompareResponseV3 is an OpenAPI type safe proxy for CompareResponse.
CompareSchemas accepts a left and right SchemaProxy and checks for changes.
CompareScopes compares a left and right Swagger Scopes objects for changes.
CompareSecurityRequirement compares left and right SecurityRequirement objects for changes.
CompareSecuritySchemes compares left and right Swagger or OpenAPI Security Scheme objects for changes.
CompareSecuritySchemesV2 is a Swagger type safe proxy for CompareSecuritySchemes.
CompareSecuritySchemesV3 is an OpenAPI type safe proxt for CompareSecuritySchemes.
CompareServers compares two OpenAPI Server objects for any changes.
CompareServerVariables compares a left and right OpenAPI ServerVariable object for changes.
CompareTags will compare a left (original) and a right (new) slice of ValueReference nodes for any changes between them.
CompareXML will compare a left (original) and a right (new) XML instance, and check for any changes between them.
CountBreakingChanges counts the number of changes in a slice that are breaking.
CreateChange is a generic function that will create a Change of type T, populate all properties if set, and then add a pointer to Change[T] in the slice of Change pointers provided.
CreateContext will return a pointer to a ChangeContext containing the original and new line and column numbers of the left and right value nodes.
ExtractRawValueSliceChanges will compare two low level interface{} slices for changes.
ExtractStringValueSliceChanges will compare two low level string slices for changes.
No description provided by the author
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
Modified means that was a modification of a value was made.
ObjectAdded means that a new object was added to a parent object.
ObjectRemoved means that an object was removed from a parent object.
PropertyAdded means that a new property to an object was added.
PropertyRemoved means that a property of an object was removed.

# Structs

CallbackChanges represents all changes made between two Callback OpenAPI objects.
Change represents a change between two different elements inside an OpenAPI specification.
ChangeContext holds a reference to the line and column positions of original and new change.
ComponentsChanges represents changes made to both OpenAPI and Swagger documents.
ContactChanges Represent changes to a Contact object that is a child of Info, part of an OpenAPI document.
DiscriminatorChanges represents changes made to a Discriminator OpenAPI object.
DocumentChanges represents all the changes made to an OpenAPI document.
No description provided by the author
EncodingChanges represent all the changes made to an Encoding object.
ExampleChanges represent changes to an Example object, part of an OpenAPI specification.
ExamplesChanges represents changes made between Swagger Examples objects (Not OpenAPI 3).
ExtensionChanges represents any changes to custom extensions defined for an OpenAPI object.
ExternalDocChanges represents changes made to any ExternalDoc object from an OpenAPI document.
HeaderChanges represents changes made between two Header objects.
InfoChanges represents the number of changes to an Info object.
ItemsChanges represent changes found between a left (original) and right (modified) object.
LicenseChanges represent changes to a License object that is a child of Info object.
LinkChanges represent changes made between two OpenAPI Link Objects.
MediaTypeChanges represent changes made between two OpenAPI MediaType instances.
OAuthFlowChanges represents an OpenAPI OAuthFlow object.
OAuthFlowsChanges represents changes found between two OpenAPI OAuthFlows objects.
OperationChanges represent changes made between two Swagger or OpenAPI Operation objects.
ParameterChanges represents changes found between Swagger or OpenAPI Parameter objects.
PathItemChanges represents changes found between to Swagger or OpenAPI PathItem object.
PathsChanges represents changes found between two Swagger or OpenAPI Paths Objects.
PropertyChanges holds a slice of Change pointers.
PropertyCheck is used by functions to check the state of left and right values.
RequestBodyChanges represents changes made between two OpenAPI RequestBody Objects.
ResponseChanges represents changes found between two Swagger or OpenAPI Response objects.
ResponsesChanges represents changes made between two Swagger or OpenAPI Responses objects.
SchemaChanges represent all changes to a base.Schema OpenAPI object.
ScopesChanges represents changes between two Swagger Scopes Objects.
SecurityRequirementChanges represents changes found between two SecurityRequirement Objects.
SecuritySchemeChanges represents changes made between Swagger or OpenAPI SecurityScheme Objects.
ServerChanges represents changes found between two OpenAPI Server Objects.
ServerVariableChanges represents changes found between two OpenAPI ServerVariable Objects.
TagChanges represents changes made to the Tags object of an OpenAPI document.
WhatChanged is a summary object that contains a high level summary of everything changed.
XMLChanges represents changes made to the XML object of an OpenAPI document.