documentation

Reuven · Reuven · commit 8405c37a62e4 · 2021-03-15T01:50:39.000+02:00
diff --git a/diff/callbacks_diff.go b/diff/callbacks_diff.go
@@ -13,7 +13,7 @@ type CallbacksDiff struct {
 	Modified ModifiedCallbacks `json:"modified,omitempty" yaml:"modified,omitempty"`
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (callbacksDiff *CallbacksDiff) Empty() bool {
 
 	if callbacksDiff == nil {
diff --git a/diff/content_diff.go b/diff/content_diff.go
@@ -22,7 +22,7 @@ func newContentDiff() *ContentDiff {
 	return &ContentDiff{}
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (contentDiff *ContentDiff) Empty() bool {
 	return contentDiff == nil || *contentDiff == ContentDiff{}
 }
diff --git a/diff/encoding_diff.go b/diff/encoding_diff.go
@@ -13,7 +13,7 @@ type EncodingDiff struct {
 	AllowReservedDiff *ValueDiff   `json:"allowReservedDiff,omitempty" yaml:"allowReservedDiff,omitempty"`
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (diff *EncodingDiff) Empty() bool {
 	return diff == nil || *diff == EncodingDiff{}
 }
diff --git a/diff/encodings_diff.go b/diff/encodings_diff.go
@@ -12,7 +12,7 @@ type EncodingsDiff struct {
 // ModifiedEncodings is map of enconding names to their respective diffs
 type ModifiedEncodings map[string]*EncodingDiff
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (diff *EncodingsDiff) Empty() bool {
 	if diff == nil {
 		return true
diff --git a/diff/enum_diff.go b/diff/enum_diff.go
@@ -18,7 +18,7 @@ func newEnumDiff() *EnumDiff {
 	}
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (enumDiff *EnumDiff) Empty() bool {
 	if enumDiff == nil {
 		return true
diff --git a/diff/extensions_diff.go b/diff/extensions_diff.go
@@ -14,7 +14,7 @@ type ExtensionsDiff struct {
 // ModifiedExtensions is map of extensions names to their respective diffs
 type ModifiedExtensions map[string]*ValueDiff
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (diff *ExtensionsDiff) Empty() bool {
 	if diff == nil {
 		return true
diff --git a/diff/header_diff.go b/diff/header_diff.go
@@ -14,7 +14,7 @@ type HeaderDiff struct {
 	ContentDiff *ContentDiff `json:"content,omitempty" yaml:"content,omitempty"`
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (headerDiff *HeaderDiff) Empty() bool {
 	return headerDiff == nil || *headerDiff == HeaderDiff{}
 }
diff --git a/diff/headers_diff.go b/diff/headers_diff.go
@@ -13,7 +13,7 @@ type HeadersDiff struct {
 	Modified ModifiedHeaders `json:"modified,omitempty" yaml:"modified,omitempty"`
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (headersDiff *HeadersDiff) Empty() bool {
 	if headersDiff == nil {
 		return true
diff --git a/diff/method_diff.go b/diff/method_diff.go
@@ -25,7 +25,7 @@ func newMethodDiff() *MethodDiff {
 	return &MethodDiff{}
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (methodDiff *MethodDiff) Empty() bool {
 	if methodDiff == nil {
 		return true
diff --git a/diff/oauth_flow.go b/diff/oauth_flow.go
@@ -13,7 +13,7 @@ type OAuthFlowDiff struct {
 	ScopesDiff           *StringMapDiff  `json:"scopes,omitempty" yaml:"scopes,omitempty"`
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (diff *OAuthFlowDiff) Empty() bool {
 	return diff == nil || *diff == OAuthFlowDiff{}
 }
diff --git a/diff/oauth_flows.go b/diff/oauth_flows.go
@@ -11,7 +11,7 @@ type OAuthFlowsDiff struct {
 	AuthorizationCodeDiff *OAuthFlowDiff  `json:"authorizationCode,omitempty" yaml:"authorizationCode,omitempty"`
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (diff *OAuthFlowsDiff) Empty() bool {
 	return diff == nil || *diff == OAuthFlowsDiff{}
 }
diff --git a/diff/operations_diff.go b/diff/operations_diff.go
@@ -9,7 +9,7 @@ type OperationsDiff struct {
 	Modified ModifiedOperations `json:"modified,omitempty" yaml:"modified,omitempty"`
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (operationsDiff *OperationsDiff) Empty() bool {
 	if operationsDiff == nil {
 		return true
diff --git a/diff/parameter_diff.go b/diff/parameter_diff.go
@@ -20,7 +20,7 @@ type ParameterDiff struct {
 	ContentDiff *ContentDiff `json:"content,omitempty" yaml:"content,omitempty"`
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (diff *ParameterDiff) Empty() bool {
 	return diff == nil || *diff == ParameterDiff{}
 }
diff --git a/diff/parameters_diff.go b/diff/parameters_diff.go
@@ -13,7 +13,7 @@ type ParametersDiff struct {
 	Modified ParamDiffByLocation  `json:"modified,omitempty" yaml:"modified,omitempty"`
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (parametersDiff *ParametersDiff) Empty() bool {
 	if parametersDiff == nil {
 		return true
@@ -94,7 +94,7 @@ func getParametersDiffInternal(config *Config, params1, params2 openapi3.Paramet
 		if err != nil {
 			return nil, err
 		}
-		
+
 		if paramValue2 != nil {
 			diff, err := getParameterDiff(config, value1, paramValue2)
 			if err != nil {
diff --git a/diff/path_diff.go b/diff/path_diff.go
@@ -19,7 +19,7 @@ func newPathDiff() *PathDiff {
 	return &PathDiff{}
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (pathDiff *PathDiff) Empty() bool {
 	if pathDiff == nil {
 		return true
diff --git a/diff/paths_diff.go b/diff/paths_diff.go
@@ -14,7 +14,7 @@ type PathsDiff struct {
 	Modified ModifiedPaths `json:"modified,omitempty" yaml:"modified,omitempty"`
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (pathsDiff *PathsDiff) Empty() bool {
 	if pathsDiff == nil {
 		return true
diff --git a/diff/request_bodies_diff.go b/diff/request_bodies_diff.go
@@ -11,7 +11,7 @@ type RequestBodiesDiff struct {
 	Modified ModifiedRequestBodies `json:"modified,omitempty" yaml:"modified,omitempty"`
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (requestBodiesDiff *RequestBodiesDiff) Empty() bool {
 	if requestBodiesDiff == nil {
 		return true
diff --git a/diff/request_body_diff.go b/diff/request_body_diff.go
@@ -14,7 +14,7 @@ type RequestBodyDiff struct {
 	ContentDiff     *ContentDiff `json:"content,omitempty" yaml:"content,omitempty"`
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (requestBodyDiff *RequestBodyDiff) Empty() bool {
 	if requestBodyDiff == nil {
 		return true
diff --git a/diff/response_diff.go b/diff/response_diff.go
@@ -11,7 +11,7 @@ type ResponseDiff struct {
 	// Links
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (diff *ResponseDiff) Empty() bool {
 	return diff == nil || *diff == ResponseDiff{}
 }
diff --git a/diff/responses_diff.go b/diff/responses_diff.go
@@ -13,7 +13,7 @@ type ResponsesDiff struct {
 	Modified ModifiedResponses `json:"modified,omitempty" yaml:"modified,omitempty"`
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (responsesDiff *ResponsesDiff) Empty() bool {
 	if responsesDiff == nil {
 		return true
diff --git a/diff/schema_diff.go b/diff/schema_diff.go
@@ -54,7 +54,7 @@ type SchemaDiff struct {
 	AdditionalProperties            *SchemaDiff     `json:"additionalProperties,omitempty" yaml:"additionalProperties,omitempty"`
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (diff *SchemaDiff) Empty() bool {
 	return diff == nil || *diff == SchemaDiff{}
 }
diff --git a/diff/schemas_diff.go b/diff/schemas_diff.go
@@ -11,7 +11,7 @@ type SchemasDiff struct {
 	Modified ModifiedSchemas `json:"modified,omitempty" yaml:"modified,omitempty"`
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (schemasDiff *SchemasDiff) Empty() bool {
 	if schemasDiff == nil {
 		return true
diff --git a/diff/security_requirements_diff.go b/diff/security_requirements_diff.go
@@ -13,7 +13,7 @@ type SecurityRequirementsDiff struct {
 	// TODO: handle Modified Security Requirements
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (diff *SecurityRequirementsDiff) Empty() bool {
 	if diff == nil {
 		return true
diff --git a/diff/security_scheme.go b/diff/security_scheme.go
@@ -15,7 +15,7 @@ type SecuritySchemeDiff struct {
 	OpenIDConnectURLDiff *ValueDiff      `json:"openIDConnectURL,omitempty" yaml:"openIDConnectURL,omitempty"`
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (diff *SecuritySchemeDiff) Empty() bool {
 	return diff == nil || *diff == SecuritySchemeDiff{}
 }
diff --git a/diff/security_schemes.go b/diff/security_schemes.go
@@ -13,7 +13,7 @@ type SecuritySchemesDiff struct {
 	Modified ModifiedSecuritySchemes `json:"modified,omitempty" yaml:"modified,omitempty"`
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (diff *SecuritySchemesDiff) Empty() bool {
 	if diff == nil {
 		return true
diff --git a/diff/server_diff.go b/diff/server_diff.go
@@ -12,7 +12,7 @@ type ServerDiff struct {
 	// Variables
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (diff *ServerDiff) Empty() bool {
 	return diff == nil || *diff == ServerDiff{}
 }
diff --git a/diff/servers_diff.go b/diff/servers_diff.go
@@ -12,7 +12,7 @@ type ServersDiff struct {
 // ModifiedServers is map of server names to their respective diffs
 type ModifiedServers map[string]*ServerDiff
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (diff *ServersDiff) Empty() bool {
 	if diff == nil {
 		return true
diff --git a/diff/spec_diff.go b/diff/spec_diff.go
@@ -21,7 +21,7 @@ func newSpecDiff() *SpecDiff {
 	return &SpecDiff{}
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (specDiff *SpecDiff) Empty() bool {
 	return specDiff == nil || *specDiff == SpecDiff{}
 }
diff --git a/diff/string_list_diff.go b/diff/string_list_diff.go
@@ -13,7 +13,7 @@ func newStringsDiff() *StringsDiff {
 	}
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (stringsDiff *StringsDiff) Empty() bool {
 	if stringsDiff == nil {
 		return true
diff --git a/diff/string_map_diff.go b/diff/string_map_diff.go
@@ -18,7 +18,7 @@ func newStringMapDiffDiff() *StringMapDiff {
 	}
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (diff *StringMapDiff) Empty() bool {
 	if diff == nil {
 		return true
diff --git a/diff/string_set.go b/diff/string_set.go
@@ -49,7 +49,7 @@ func (stringSet StringSet) equals(other StringSet) bool {
 		other.minus(stringSet).Empty()
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (stringSet StringSet) Empty() bool {
 	return len(stringSet) == 0
 }
diff --git a/diff/tag_diff.go b/diff/tag_diff.go
@@ -8,7 +8,7 @@ type TagDiff struct {
 	DescriptionDiff *ValueDiff `json:"description,omitempty" yaml:"description,omitempty"`
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (diff *TagDiff) Empty() bool {
 	return diff == nil || *diff == TagDiff{}
 }
diff --git a/diff/tags_diff.go b/diff/tags_diff.go
@@ -22,7 +22,7 @@ func newTagsDiff() *TagsDiff {
 // ModifiedTags is map of tag names to their respective diffs
 type ModifiedTags map[string]*TagDiff
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (tagsDiff *TagsDiff) Empty() bool {
 	if tagsDiff == nil {
 		return true
diff --git a/diff/value_diff.go b/diff/value_diff.go
@@ -8,7 +8,7 @@ type ValueDiff struct {
 	To   interface{} `json:"to" yaml:"to"`
 }
 
-// Empty return true if there is no diff
+// Empty indicates whether a change was found in this element
 func (diff *ValueDiff) Empty() bool {
 	return diff == nil
 }

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ type CallbacksDiff struct {`
`13`	`13`	Modified ModifiedCallbacks `json:"modified,omitempty" yaml:"modified,omitempty"`
`14`	`14`	`}`
`15`	`15`
`16`		`-// Empty return true if there is no diff`
	`16`	`+// Empty indicates whether a change was found in this element`
`17`	`17`	`func (callbacksDiff *CallbacksDiff) Empty() bool {`
`18`	`18`
`19`	`19`	`if callbacksDiff == nil {`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ func newContentDiff() *ContentDiff {`
`22`	`22`	`return &ContentDiff{}`
`23`	`23`	`}`
`24`	`24`
`25`		`-// Empty return true if there is no diff`
	`25`	`+// Empty indicates whether a change was found in this element`
`26`	`26`	`func (contentDiff *ContentDiff) Empty() bool {`
`27`	`27`	`return contentDiff == nil \|\| *contentDiff == ContentDiff{}`
`28`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ type EncodingDiff struct {`
`13`	`13`	AllowReservedDiff *ValueDiff `json:"allowReservedDiff,omitempty" yaml:"allowReservedDiff,omitempty"`
`14`	`14`	`}`
`15`	`15`
`16`		`-// Empty return true if there is no diff`
	`16`	`+// Empty indicates whether a change was found in this element`
`17`	`17`	`func (diff *EncodingDiff) Empty() bool {`
`18`	`18`	`return diff == nil \|\| *diff == EncodingDiff{}`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ func newEnumDiff() *EnumDiff {`
`18`	`18`	`}`
`19`	`19`	`}`
`20`	`20`
`21`		`-// Empty return true if there is no diff`
	`21`	`+// Empty indicates whether a change was found in this element`
`22`	`22`	`func (enumDiff *EnumDiff) Empty() bool {`
`23`	`23`	`if enumDiff == nil {`
`24`	`24`	`return true`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ type HeaderDiff struct {`
`14`	`14`	ContentDiff *ContentDiff `json:"content,omitempty" yaml:"content,omitempty"`
`15`	`15`	`}`
`16`	`16`
`17`		`-// Empty return true if there is no diff`
	`17`	`+// Empty indicates whether a change was found in this element`
`18`	`18`	`func (headerDiff *HeaderDiff) Empty() bool {`
`19`	`19`	`return headerDiff == nil \|\| *headerDiff == HeaderDiff{}`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ type HeadersDiff struct {`
`13`	`13`	Modified ModifiedHeaders `json:"modified,omitempty" yaml:"modified,omitempty"`
`14`	`14`	`}`
`15`	`15`
`16`		`-// Empty return true if there is no diff`
	`16`	`+// Empty indicates whether a change was found in this element`
`17`	`17`	`func (headersDiff *HeadersDiff) Empty() bool {`
`18`	`18`	`if headersDiff == nil {`
`19`	`19`	`return true`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ func newMethodDiff() *MethodDiff {`
`25`	`25`	`return &MethodDiff{}`
`26`	`26`	`}`
`27`	`27`
`28`		`-// Empty return true if there is no diff`
	`28`	`+// Empty indicates whether a change was found in this element`
`29`	`29`	`func (methodDiff *MethodDiff) Empty() bool {`
`30`	`30`	`if methodDiff == nil {`
`31`	`31`	`return true`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ type OAuthFlowDiff struct {`
`13`	`13`	ScopesDiff *StringMapDiff `json:"scopes,omitempty" yaml:"scopes,omitempty"`
`14`	`14`	`}`
`15`	`15`
`16`		`-// Empty return true if there is no diff`
	`16`	`+// Empty indicates whether a change was found in this element`
`17`	`17`	`func (diff *OAuthFlowDiff) Empty() bool {`
`18`	`18`	`return diff == nil \|\| *diff == OAuthFlowDiff{}`
`19`	`19`	`}`