package
2.1.2+incompatible
Repository: https://github.com/tufin/oasdiff.git
Documentation: pkg.go.dev

# Functions

Get calculates the diff between a pair of OpenAPI objects.
GetPathsDiff calculates the diff between a pair of slice of OpenAPI objects.
GetWithOperationsSourcesMap calculates the diff between a pair of OpenAPI objects.
NewConfig returns a default configuration.
No description provided by the author

# Constants

Detail constants are the keys in the summary map.
Special.
Detail constants are the keys in the summary map.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Detail constants are the keys in the summary map.
Detail constants are the keys in the summary map.
Detail constants are the keys in the summary map.
Detail constants are the keys in the summary map.
Swagger.
Detail constants are the keys in the summary map.
Detail constants are the keys in the summary map.
Components.
Detail constants are the keys in the summary map.
Detail constants are the keys in the summary map.
Detail constants are the keys in the summary map.
No description provided by the author
No description provided by the author
Detail constants are the keys in the summary map.
No description provided by the author
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
ParamLocations are the four possible locations of parameters: path, query, header or cookie.

# Structs

CallbacksDiff describes the changes between a pair of callback objects: https://swagger.io/specification/#callback-object.
ComponentsDiff describes the changes between a pair of component objects: https://swagger.io/specification/#components-object.
Config includes various settings to control the diff.
ContactDiff describes the changes between a pair of contact objects: https://swagger.io/specification/#contact-object.
ContentDiff describes the changes between content properties each containing media type objects: https://swagger.io/specification/#media-type-object.
Diff describes the changes between a pair of OpenAPI objects: https://swagger.io/specification/#schema.
DiscriminatorDiff describes the changes between a pair of discriminator objects: https://swagger.io/specification/#discriminator-object.
EncodingDiff describes the changes between a pair of encoding objects: https://swagger.io/specification/#encoding-object.
EncodingsDiff describes the changes between a pair of sets of encoding objects: https://swagger.io/specification/#encoding-object.
Endpoint is a combination of an HTTP method and a Path.
EndpointsDiff is an alternate, simplified view of PathsDiff.
EnumDiff describes the changes between a pair of enums.
ExampleDiff describes the changes between a pair of example objects: https://swagger.io/specification/#example-object.
ExamplesDiff describes the changes between a pair of sets of example objects: https://swagger.io/specification/#example-object.
ExternalDocsDiff describes the changes between a pair of external documentation objects: https://swagger.io/specification/#external-documentation-object.
HeaderDiff describes the changes between a pair of header objects: https://swagger.io/specification/#header-object.
HeadersDiff describes the changes between a pair of sets of header objects: https://swagger.io/specification/#header-object.
InfoDiff describes the changes between a pair of info objects: https://swagger.io/specification/#info-object.
InterfaceMapDiff describes the changes between a pair of InterfaceMap.
LicenseDiff describes the changes between a pair of license objects: https://swagger.io/specification/#license-object.
LinkDiff describes the changes between a pair of link objects: https://swagger.io/specification/#link-object.
LinksDiff describes the changes between a pair of sets of link objects: https://swagger.io/specification/#link-object.
MediaTypeDiff describes the changes between a pair of media type objects.
MethodDiff describes the changes between a pair of operation objects: https://swagger.io/specification/#operation-object.
OAuthFlowDiff describes the changes between a pair of oauth flow objects: https://swagger.io/specification/#oauth-flow-object.
OAuthFlowsDiff describes the changes between a pair of oauth flows objects: https://swagger.io/specification/#oauth-flows-object.
OperationsDiff describes the changes between a pair of operation objects (https://swagger.io/specification/#operation-object) of two path item objects.
ParameterDiff describes the changes between a pair of parameter objects: https://swagger.io/specification/#parameter-object.
ParametersDiff describes the changes between a pair of lists of parameter objects: https://swagger.io/specification/#parameter-object.
PathDiff describes the changes between a pair of path item objects: https://swagger.io/specification/#path-item-object.
PathsDiff describes the changes between a pair of Paths objects: https://swagger.io/specification/#paths-object.
RequestBodiesDiff describes the changes between a pair of sets of request body objects: https://swagger.io/specification/#request-body-object.
RequestBodyDiff describes the changes between a pair of request body objects: https://swagger.io/specification/#request-body-object.
RequiredPropertiesDiff describes the changes between a pair of lists of required properties.
ResponseDiff describes the changes between a pair of response objects: https://swagger.io/specification/#response-object.
ResponsesDiff describes the changes between a pair of sets of response objects: https://swagger.io/specification/#responses-object.
SchemaDiff describes the changes between a pair of schema objects: https://swagger.io/specification/#schema-object.
SchemaListDiff describes the changes between a pair of lists of schema objects: https://swagger.io/specification/#schema-object The result is a combination of two diffs: 1.
SchemasDiff describes the changes between a pair of sets of schema objects: https://swagger.io/specification/#schema-object.
SecurityRequirementsDiff describes the changes between a pair of sets of security requirement objects: https://swagger.io/specification/#security-requirement-object.
SecuritySchemeDiff describes the changes between a pair of security scheme objects: https://swagger.io/specification/#security-scheme-object.
SecuritySchemesDiff describes the changes between a pair of sets of security scheme objects: https://swagger.io/specification/#security-scheme-object.
ServerDiff describes the changes between a pair of server objects: https://swagger.io/specification/#server-object.
ServersDiff describes the changes between a pair of sets of encoding objects: https://swagger.io/specification/#server-object.
StringMapDiff describes the changes between a pair of string maps.
StringsDiff describes the changes between a pair of lists of strings.
Summary summarizes the changes between a pair of OpenAPI specifications.
SummaryDetails summarizes the changes between equivalent parts of the two OpenAPI specifications: paths, schemas, parameters, headers, responses etc.
TagDiff describes the changes between a pair of tag objects: https://swagger.io/specification/#tag-object.
TagsDiff describes the changes between a pair of lists of tag objects: https://swagger.io/specification/#tag-object.
ValueDiff describes the changes between a pair of values.
VariableDiff describes the changes between a pair of server variable objects: https://swagger.io/specification/#server-variable-object.
VariablesDiff describes the changes between a pair of sets of server variable objects: https://swagger.io/specification/#server-variable-object.

# Interfaces

IDiff defines common operations for diff results.

# Type aliases

DetailName is the key type of the summary map.
Endpoints is a list of endpoints.
EnumValues is a list of enum values.
ExtensionsDiff describes the changes between a pair of sets of specification extensions: https://swagger.io/specification/#specification-extensions.
InterfaceMap is a map of string to interface.
ModifiedCallbacks is map of callback names to their respective diffs.
ModifiedEncodings is map of enconding names to their respective diffs.
ModifiedEndpoints is a map of endpoints to their respective diffs.
ModifiedExamples is map of enconding names to their respective diffs.
ModifiedHeaders is map of header names to their respective diffs.
ModifiedInterfaces is map of interface names to their respective diffs.
ModifiedKeys maps keys to their respective diffs.
ModifiedLinks is map of link values to their respective diffs.
ModifiedMediaTypes is map of media type names to their respective diffs.
ModifiedOperations is a map of HTTP methods to their respective diffs.
ModifiedPaths is a map of paths to their respective diffs.
ModifiedRequestBodies is map of requestBody names to their respective diffs.
ModifiedResponses is map of response values to their respective diffs.
ModifiedSchemas is map of schema names to their respective diffs.
ModifiedSecurityRequirements is map of security requirements to their respective diffs.
ModifiedSecuritySchemes is map of security schemes to their respective diffs.
ModifiedServers is map of server names to their respective diffs.
ModifiedTags is map of tag names to their respective diffs.
ModifiedVariables is map of variable names to their respective diffs.
No description provided by the author
ParamDiffByLocation maps param location (path, query, header or cookie) to param diffs in this location.
ParamDiffs is map of parameter names to their respective diffs.
ParamNamesByLocation maps param location (path, query, header or cookie) to the params in this location.
PathParamsMap handles path param renaming for example: person/{personName} -> /person/{name} in such cases, PathParamsMap stores the param mapping: personName -> name.
SecurityScopesDiff is a map of security schemes to their respective scope diffs.