Versions in this module Expand all Collapse all v0 v0.16.2 Jun 10, 2024 Changes in this version + const EMPTY_STR + const HashPh + const Modified + const ObjectAdded + const ObjectRemoved + const PropertyAdded + const PropertyRemoved + func CheckForAddition[T any](l, r *yaml.Node, label string, changes *[]*Change, breaking bool, orig, new T) + func CheckForModification[T any](l, r *yaml.Node, label string, changes *[]*Change, breaking bool, orig, new T) + func CheckForObjectAdditionOrRemoval[T any](l, r map[string]*low.ValueReference[T], label string, changes *[]*Change, ...) + func CheckForRemoval[T any](l, r *yaml.Node, label string, changes *[]*Change, breaking bool, orig, new T) + func CheckMapForAdditionRemoval[T any](...) any + func CheckMapForChangesWithComp[T any, R any](...) map[string]R + func CheckMapForChanges[T any, R any](...) map[string]R + func CheckProperties(properties []*PropertyCheck) + func CheckPropertyAdditionOrRemoval[T any](l, r *yaml.Node, label string, changes *[]*Change, breaking bool, orig, new T) + func CheckSpecificObjectAdded[T any](l, r map[string]*T, label string) bool + func CheckSpecificObjectRemoved[T any](l, r map[string]*T, label string) bool + func CountBreakingChanges(changes []*Change) int + func CreateChange(changes *[]*Change, changeType int, property string, ...) *[]*Change + func ExtractRawValueSliceChanges[T any](lParam, rParam []low.ValueReference[T], changes *[]*Change, label string, ...) + func ExtractStringValueSliceChanges(lParam, rParam []low.ValueReference[string], changes *[]*Change, label string, ...) + func FlattenLowLevelOrderedMap[T any](lowMap *orderedmap.Map[low.KeyReference[string], low.ValueReference[T]]) map[string]*low.ValueReference[T] + type CallbackChanges struct + ExpressionChanges map[string]*PathItemChanges + ExtensionChanges *ExtensionChanges + func CompareCallback(l, r *v3.Callback) *CallbackChanges + func (c *CallbackChanges) GetAllChanges() []*Change + func (c *CallbackChanges) TotalBreakingChanges() int + func (c *CallbackChanges) TotalChanges() int + type Change struct + Breaking bool + ChangeType int + Context *ChangeContext + New string + NewObject any + Original string + OriginalObject any + Property string + func (c *Change) MarshalJSON() ([]byte, error) + type ChangeContext struct + NewColumn *int + NewLine *int + OriginalColumn *int + OriginalLine *int + func CreateContext(l, r *yaml.Node) *ChangeContext + func (c *ChangeContext) HasChanged() bool + type ComponentsChanges struct + ExtensionChanges *ExtensionChanges + SchemaChanges map[string]*SchemaChanges + SecuritySchemeChanges map[string]*SecuritySchemeChanges + func CompareComponents(l, r any) *ComponentsChanges + func (c *ComponentsChanges) GetAllChanges() []*Change + func (c *ComponentsChanges) TotalBreakingChanges() int + func (c *ComponentsChanges) TotalChanges() int + type ContactChanges struct + func CompareContact(l, r *base.Contact) *ContactChanges + func (c *ContactChanges) GetAllChanges() []*Change + func (c *ContactChanges) TotalBreakingChanges() int + func (c *ContactChanges) TotalChanges() int + type DiscriminatorChanges struct + MappingChanges []*Change + func CompareDiscriminator(l, r *base.Discriminator) *DiscriminatorChanges + func (c *DiscriminatorChanges) GetAllChanges() []*Change + func (d *DiscriminatorChanges) TotalBreakingChanges() int + func (d *DiscriminatorChanges) TotalChanges() int + type DocumentChanges struct + ComponentsChanges *ComponentsChanges + ExtensionChanges *ExtensionChanges + ExternalDocChanges *ExternalDocChanges + InfoChanges *InfoChanges + PathsChanges *PathsChanges + SecurityRequirementChanges []*SecurityRequirementChanges + ServerChanges []*ServerChanges + TagChanges []*TagChanges + WebhookChanges map[string]*PathItemChanges + func CompareDocuments(l, r any) *DocumentChanges + func (d *DocumentChanges) GetAllChanges() []*Change + func (d *DocumentChanges) TotalBreakingChanges() int + func (d *DocumentChanges) TotalChanges() int + type DocumentChangesFlat struct + ComponentsChanges []*Change + ExtensionChanges []*Change + ExternalDocChanges []*Change + InfoChanges []*Change + PathsChanges []*Change + SecurityRequirementChanges []*Change + ServerChanges []*Change + TagChanges []*Change + WebhookChanges []*Change + type EncodingChanges struct + HeaderChanges map[string]*HeaderChanges + func CompareEncoding(l, r *v3.Encoding) *EncodingChanges + func (e *EncodingChanges) GetAllChanges() []*Change + func (e *EncodingChanges) TotalBreakingChanges() int + func (e *EncodingChanges) TotalChanges() int + type ExampleChanges struct + ExtensionChanges *ExtensionChanges + func CompareExamples(l, r *base.Example) *ExampleChanges + func (e *ExampleChanges) GetAllChanges() []*Change + func (e *ExampleChanges) TotalBreakingChanges() int + func (e *ExampleChanges) TotalChanges() int + type ExamplesChanges struct + func CompareExamplesV2(l, r *v2.Examples) *ExamplesChanges + func (a *ExamplesChanges) GetAllChanges() []*Change + func (a *ExamplesChanges) TotalBreakingChanges() int + func (a *ExamplesChanges) TotalChanges() int + type ExtensionChanges struct + func CheckExtensions[T low.HasExtensions[T]](l, r T) *ExtensionChanges + func CompareExtensions(l, r *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]]) *ExtensionChanges + func (e *ExtensionChanges) GetAllChanges() []*Change + func (e *ExtensionChanges) TotalBreakingChanges() int + func (e *ExtensionChanges) TotalChanges() int + type ExternalDocChanges struct + ExtensionChanges *ExtensionChanges + func CompareExternalDocs(l, r *base.ExternalDoc) *ExternalDocChanges + func (e *ExternalDocChanges) GetAllChanges() []*Change + func (e *ExternalDocChanges) TotalBreakingChanges() int + func (e *ExternalDocChanges) TotalChanges() int + type HeaderChanges struct + ContentChanges map[string]*MediaTypeChanges + ExamplesChanges map[string]*ExampleChanges + ExtensionChanges *ExtensionChanges + ItemsChanges *ItemsChanges + SchemaChanges *SchemaChanges + func CompareHeaders(l, r any) *HeaderChanges + func CompareHeadersV2(l, r *v2.Header) *HeaderChanges + func CompareHeadersV3(l, r *v3.Header) *HeaderChanges + func (h *HeaderChanges) GetAllChanges() []*Change + func (h *HeaderChanges) TotalBreakingChanges() int + func (h *HeaderChanges) TotalChanges() int + type InfoChanges struct + ContactChanges *ContactChanges + ExtensionChanges *ExtensionChanges + LicenseChanges *LicenseChanges + func CompareInfo(l, r *base.Info) *InfoChanges + func (i *InfoChanges) GetAllChanges() []*Change + func (i *InfoChanges) TotalBreakingChanges() int + func (i *InfoChanges) TotalChanges() int + type ItemsChanges struct + ItemsChanges *ItemsChanges + func CompareItems(l, r *v2.Items) *ItemsChanges + func (i *ItemsChanges) GetAllChanges() []*Change + func (i *ItemsChanges) TotalBreakingChanges() int + func (i *ItemsChanges) TotalChanges() int + type LicenseChanges struct + func CompareLicense(l, r *base.License) *LicenseChanges + func (l *LicenseChanges) GetAllChanges() []*Change + func (l *LicenseChanges) TotalBreakingChanges() int + func (l *LicenseChanges) TotalChanges() int + type LinkChanges struct + ExtensionChanges *ExtensionChanges + ServerChanges *ServerChanges + func CompareLinks(l, r *v3.Link) *LinkChanges + func (l *LinkChanges) GetAllChanges() []*Change + func (l *LinkChanges) TotalBreakingChanges() int + func (l *LinkChanges) TotalChanges() int + type MediaTypeChanges struct + EncodingChanges map[string]*EncodingChanges + ExampleChanges map[string]*ExampleChanges + ExtensionChanges *ExtensionChanges + SchemaChanges *SchemaChanges + func CompareMediaTypes(l, r *v3.MediaType) *MediaTypeChanges + func (m *MediaTypeChanges) GetAllChanges() []*Change + func (m *MediaTypeChanges) TotalBreakingChanges() int + func (m *MediaTypeChanges) TotalChanges() int + type OAuthFlowChanges struct + ExtensionChanges *ExtensionChanges + func CompareOAuthFlow(l, r *v3.OAuthFlow) *OAuthFlowChanges + func (o *OAuthFlowChanges) GetAllChanges() []*Change + func (o *OAuthFlowChanges) TotalBreakingChanges() int + func (o *OAuthFlowChanges) TotalChanges() int + type OAuthFlowsChanges struct + AuthorizationCodeChanges *OAuthFlowChanges + ClientCredentialsChanges *OAuthFlowChanges + ExtensionChanges *ExtensionChanges + ImplicitChanges *OAuthFlowChanges + PasswordChanges *OAuthFlowChanges + func CompareOAuthFlows(l, r *v3.OAuthFlows) *OAuthFlowsChanges + func (o *OAuthFlowsChanges) GetAllChanges() []*Change + func (o *OAuthFlowsChanges) TotalBreakingChanges() int + func (o *OAuthFlowsChanges) TotalChanges() int + type OperationChanges struct + CallbackChanges map[string]*CallbackChanges + ExtensionChanges *ExtensionChanges + ExternalDocChanges *ExternalDocChanges + ParameterChanges []*ParameterChanges + RequestBodyChanges *RequestBodyChanges + ResponsesChanges *ResponsesChanges + SecurityRequirementChanges []*SecurityRequirementChanges + ServerChanges []*ServerChanges + func CompareOperations(l, r any) *OperationChanges + func (o *OperationChanges) GetAllChanges() []*Change + func (o *OperationChanges) TotalBreakingChanges() int + func (o *OperationChanges) TotalChanges() int + type ParameterChanges struct + ContentChanges map[string]*MediaTypeChanges + ExamplesChanges map[string]*ExampleChanges + ExtensionChanges *ExtensionChanges + ItemsChanges *ItemsChanges + SchemaChanges *SchemaChanges + func CompareParameters(l, r any) *ParameterChanges + func CompareParametersV3(l, r *v3.Parameter) *ParameterChanges + func (p *ParameterChanges) GetAllChanges() []*Change + func (p *ParameterChanges) TotalBreakingChanges() int + func (p *ParameterChanges) TotalChanges() int + type PathItemChanges struct + DeleteChanges *OperationChanges + ExtensionChanges *ExtensionChanges + GetChanges *OperationChanges + HeadChanges *OperationChanges + OptionsChanges *OperationChanges + ParameterChanges []*ParameterChanges + PatchChanges *OperationChanges + PostChanges *OperationChanges + PutChanges *OperationChanges + ServerChanges []*ServerChanges + TraceChanges *OperationChanges + func ComparePathItems(l, r any) *PathItemChanges + func ComparePathItemsV3(l, r *v3.PathItem) *PathItemChanges + func (p *PathItemChanges) GetAllChanges() []*Change + func (p *PathItemChanges) TotalBreakingChanges() int + func (p *PathItemChanges) TotalChanges() int + type PathsChanges struct + ExtensionChanges *ExtensionChanges + PathItemsChanges map[string]*PathItemChanges + func ComparePaths(l, r any) *PathsChanges + func (p *PathsChanges) GetAllChanges() []*Change + func (p *PathsChanges) TotalBreakingChanges() int + func (p *PathsChanges) TotalChanges() int + type PropertyChanges struct + Changes []*Change + func NewPropertyChanges(changes []*Change) *PropertyChanges + func (p PropertyChanges) TotalBreakingChanges() int + func (p PropertyChanges) TotalChanges() int + type PropertyCheck struct + Breaking bool + Changes *[]*Change + Label string + LeftNode *yaml.Node + New any + Original any + RightNode *yaml.Node + type RequestBodyChanges struct + ContentChanges map[string]*MediaTypeChanges + ExtensionChanges *ExtensionChanges + func CompareRequestBodies(l, r *v3.RequestBody) *RequestBodyChanges + func (rb *RequestBodyChanges) GetAllChanges() []*Change + func (rb *RequestBodyChanges) TotalBreakingChanges() int + func (rb *RequestBodyChanges) TotalChanges() int + type ResponseChanges struct + ContentChanges map[string]*MediaTypeChanges + ExamplesChanges *ExamplesChanges + ExtensionChanges *ExtensionChanges + HeadersChanges map[string]*HeaderChanges + LinkChanges map[string]*LinkChanges + SchemaChanges *SchemaChanges + func CompareResponse(l, r any) *ResponseChanges + func CompareResponseV2(l, r *v2.Response) *ResponseChanges + func CompareResponseV3(l, r *v3.Response) *ResponseChanges + func (r *ResponseChanges) GetAllChanges() []*Change + func (r *ResponseChanges) TotalBreakingChanges() int + func (r *ResponseChanges) TotalChanges() int + type ResponsesChanges struct + DefaultChanges *ResponseChanges + ExtensionChanges *ExtensionChanges + ResponseChanges map[string]*ResponseChanges + func CompareResponses(l, r any) *ResponsesChanges + func (r *ResponsesChanges) GetAllChanges() []*Change + func (r *ResponsesChanges) TotalBreakingChanges() int + func (r *ResponsesChanges) TotalChanges() int + type SchemaChanges struct + AdditionalPropertiesChanges *SchemaChanges + AllOfChanges []*SchemaChanges + AnyOfChanges []*SchemaChanges + ContainsChanges *SchemaChanges + DependentSchemasChanges map[string]*SchemaChanges + DiscriminatorChanges *DiscriminatorChanges + ElseChanges *SchemaChanges + ExtensionChanges *ExtensionChanges + ExternalDocChanges *ExternalDocChanges + IfChanges *SchemaChanges + ItemsChanges *SchemaChanges + NotChanges *SchemaChanges + OneOfChanges []*SchemaChanges + PatternPropertiesChanges map[string]*SchemaChanges + PropertyNamesChanges *SchemaChanges + SchemaPropertyChanges map[string]*SchemaChanges + ThenChanges *SchemaChanges + UnevaluatedItemsChanges *SchemaChanges + UnevaluatedPropertiesChanges *SchemaChanges + XMLChanges *XMLChanges + func CompareSchemas(l, r *base.SchemaProxy) *SchemaChanges + func (s *SchemaChanges) GetAllChanges() []*Change + func (s *SchemaChanges) TotalBreakingChanges() int + func (s *SchemaChanges) TotalChanges() int + type ScopesChanges struct + ExtensionChanges *ExtensionChanges + func CompareScopes(l, r *v2.Scopes) *ScopesChanges + func (s *ScopesChanges) GetAllChanges() []*Change + func (s *ScopesChanges) TotalBreakingChanges() int + func (s *ScopesChanges) TotalChanges() int + type SecurityRequirementChanges struct + func CompareSecurityRequirement(l, r *base.SecurityRequirement) *SecurityRequirementChanges + func (s *SecurityRequirementChanges) GetAllChanges() []*Change + func (s *SecurityRequirementChanges) TotalBreakingChanges() int + func (s *SecurityRequirementChanges) TotalChanges() int + type SecuritySchemeChanges struct + ExtensionChanges *ExtensionChanges + OAuthFlowChanges *OAuthFlowsChanges + ScopesChanges *ScopesChanges + func CompareSecuritySchemes(l, r any) *SecuritySchemeChanges + func CompareSecuritySchemesV2(l, r *v2.SecurityScheme) *SecuritySchemeChanges + func CompareSecuritySchemesV3(l, r *v3.SecurityScheme) *SecuritySchemeChanges + func (ss *SecuritySchemeChanges) GetAllChanges() []*Change + func (ss *SecuritySchemeChanges) TotalBreakingChanges() int + func (ss *SecuritySchemeChanges) TotalChanges() int + type ServerChanges struct + ServerVariableChanges map[string]*ServerVariableChanges + func CompareServers(l, r *v3.Server) *ServerChanges + func (s *ServerChanges) GetAllChanges() []*Change + func (s *ServerChanges) TotalBreakingChanges() int + func (s *ServerChanges) TotalChanges() int + type ServerVariableChanges struct + func CompareServerVariables(l, r *v3.ServerVariable) *ServerVariableChanges + func (s *ServerVariableChanges) GetAllChanges() []*Change + type TagChanges struct + ExtensionChanges *ExtensionChanges + ExternalDocs *ExternalDocChanges + func CompareTags(l, r []low.ValueReference[*base.Tag]) []*TagChanges + func (t *TagChanges) GetAllChanges() []*Change + func (t *TagChanges) TotalBreakingChanges() int + func (t *TagChanges) TotalChanges() int + type WhatChanged struct + Added int + Modified int + Removed int + TotalChanges int + type XMLChanges struct + ExtensionChanges *ExtensionChanges + func CompareXML(l, r *base.XML) *XMLChanges + func (x *XMLChanges) GetAllChanges() []*Change + func (x *XMLChanges) TotalBreakingChanges() int + func (x *XMLChanges) TotalChanges() int