Versions in this module Expand all Collapse all v1 v1.8.2 Sep 12, 2023 Changes in this version type Changes + func NewRequestNonPathDefaultParameterCheck(diffReport *diff.Diff, _ *diff.OperationsSourcesMap, config Config) Changes v1.8.1 Sep 11, 2023 Changes in this version + const APIComponentSecurityOauthScopeAdded + const APIComponentSecurityOauthScopeRemoved + const APIComponentSecurityOauthScopeUpdated + const APIComponentsSecurityAddedCheckId + const APIComponentsSecurityComponentOauthUrlUpdated + const APIComponentsSecurityOauthTokenUrlUpdated + const APIComponentsSecurityRemovedCheckId + const APIComponentsSecurityTyepUpdated + const APIGlobalSecurityAddedCheckId + const APIGlobalSecurityRemovedCheckId + const APIGlobalSecurityScopeAddedId + const APIGlobalSecurityScopeRemovedId + const APISecurityAddedCheckId + const APISecurityRemovedCheckId + const APISecurityScopeAddedId + const APISecurityScopeRemovedId + const APITagAddedCheckId + const APITagRemovedCheckId + const BetaDeprecationDays + const RequestBodyMediaTypeAdded + const RequestBodyMediaTypeRemoved + const RequestOptionalPropertyBecameNonReadOnlyCheckId + const RequestOptionalPropertyBecameNonWriteOnlyCheckId + const RequestOptionalPropertyBecameReadOnlyCheckId + const RequestOptionalPropertyBecameWriteOnlyCheckId + const RequestRequiredPropertyBecameNonReadOnlyCheckId + const RequestRequiredPropertyBecameNonWriteOnlyCheckId + const RequestRequiredPropertyBecameReadOnlyCheckId + const RequestRequiredPropertyBecameWriteOnlyCheckId + const ResponseMediaTypeAddedId + const ResponseMediaTypeUpdatedId + const ResponseOptionalPropertyBecameNonReadOnlyCheckId + const ResponseOptionalPropertyBecameNonWriteOnlyCheckId + const ResponseOptionalPropertyBecameReadOnlyCheckId + const ResponseOptionalPropertyBecameWriteOnlyCheckId + const ResponsePropertyBecameOptionalCheckId + const ResponsePropertyBecameRequiredCheckId + const ResponsePropertyEnumValueAddedCheckId + const ResponsePropertyPatternAddedId + const ResponsePropertyPatternChangedId + const ResponsePropertyPatternRemovedId + const ResponseRequiredPropertyAddedCheckId + const ResponseRequiredPropertyBecameNonReadOnlyCheckId + const ResponseRequiredPropertyBecameNonWriteOnlyCheckId + const ResponseRequiredPropertyBecameReadOnlyCheckId + const ResponseRequiredPropertyBecameWriteOnlyCheckId + const ResponseRequiredPropertyRemovedCheckId + const ResponseRequiredWriteOnlyPropertyAddedCheckId + const ResponseRequiredWriteOnlyPropertyRemovedCheckId + const ResponseWriteOnlyPropertyBecameOptionalCheck + const ResponseWriteOnlyPropertyBecameRequiredCheck + const ResponseWriteOnlyPropertyEnumValueAddedCheckId + const STABILITY_ALPHA + const STABILITY_BETA + const STABILITY_DRAFT + const STABILITY_STABLE + const StableDeprecationDays + func CheckAddedPropertiesDiff(schemaDiff *diff.SchemaDiff, ...) + func CheckDeletedPropertiesDiff(schemaDiff *diff.SchemaDiff, ...) + func CheckModifiedPropertiesDiff(schemaDiff *diff.SchemaDiff, ...) + func ColorizedValue(arg interface{}) string + func GetOptionalChecks() []string + func IsDecreased(from interface{}, to interface{}) bool + func IsDecreasedValue(diff *diff.ValueDiff) bool + func IsIncreased(from interface{}, to interface{}) bool + func IsIncreasedValue(diff *diff.ValueDiff) bool + func IsPipedOutput() bool + func LevelOverrides(includeChecks utils.StringList) map[string]Level + type ApiChange struct + Comment string + Id string + Level Level + Operation string + OperationId string + Path string + Source string + Text string + func (c ApiChange) Error() string + func (c ApiChange) GetComment() string + func (c ApiChange) GetId() string + func (c ApiChange) GetLevel() Level + func (c ApiChange) GetOperation() string + func (c ApiChange) GetOperationId() string + func (c ApiChange) GetPath() string + func (c ApiChange) GetText() string + func (c ApiChange) LocalizedError(l Localizer) string + func (c ApiChange) MatchIgnore(ignorePath, ignoreLine string) bool + func (c ApiChange) PrettyErrorText(l Localizer) string + type BCDiff struct + func (d *BCDiff) AddModifiedOperation(path string, operation string) *diff.MethodDiff + func (d *BCDiff) AddModifiedPath(path string) *diff.PathDiff + func (diffBC *BCDiff) AddModifiedParameter(path string, operation string, paramLocation string, paramName string) *diff.ParameterDiff + func (diffBC *BCDiff) AddRequestPropertiesDiff(path string, operation string, mediaType string) *diff.SchemasDiff + type BackwardCompatibilityCheck func(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + type Change interface + Error func() string + GetComment func() string + GetId func() string + GetLevel func() Level + GetOperation func() string + GetOperationId func() string + GetPath func() string + GetText func() string + LocalizedError func(l Localizer) string + MatchIgnore func(ignorePath, ignoreLine string) bool + PrettyErrorText func(l Localizer) string + type Changes []Change + func APIAddedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func APIComponentsSchemaRemovedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func APIComponentsSecurityUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func APIDeprecationCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func APIOperationIdUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func APIRemovedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func APISecurityUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func APISunsetChangedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func APITagUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func AddedRequiredRequestBodyCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func CheckBackwardCompatibility(config Config, diffReport *diff.Diff, ...) Changes + func CheckBackwardCompatibilityUntilLevel(config Config, diffReport *diff.Diff, ...) Changes + func NewNonPathRequestDefaultParameterCheck(diffReport *diff.Diff, _ *diff.OperationsSourcesMap, config Config) Changes + func NewRequestNonPathParameterCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func NewRequestPathParameterCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func NewRequiredRequestHeaderPropertyCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ProcessIgnoredBackwardCompatibilityErrors(level Level, errs Changes, ignoreFile string) (Changes, error) + func RequestBodyBecameEnumCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestBodyEnumValueRemovedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestBodyMediaTypeChangedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestBodyRequiredUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestDiscriminatorUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestHeaderPropertyBecameEnumCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestHeaderPropertyBecameRequiredCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestParameterBecameEnumCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestParameterDefaultValueChanged(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestParameterEnumValueUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestParameterMaxItemsUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestParameterMaxLengthSetCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestParameterMaxLengthUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestParameterMaxSetCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestParameterMaxUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestParameterMinItemsSetCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestParameterMinItemsUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestParameterMinLengthUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestParameterMinSetCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestParameterMinUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestParameterPatternAddedOrChangedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestParameterRemovedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestParameterRequiredValueUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestParameterTypeChangedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestParameterXExtensibleEnumValueRemovedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyAllOfUpdated(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyAnyOfUpdated(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyBecameEnumCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyBecameNotNullableCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyDefaultValueChangedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyEnumValueUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyMaxDecreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyMaxLengthSetCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyMaxLengthUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyMaxSetCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyMinIncreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyMinItemsIncreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyMinItemsSetCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyMinLengthUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyMinSetCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyOneOfUpdated(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyPatternUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyRequiredUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyTypeChangedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyWriteOnlyReadOnlyCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func RequestPropertyXExtensibleEnumValueRemovedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponseDiscriminatorUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponseHeaderBecameOptional(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponseHeaderRemoved(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponseMediaTypeEnumValueRemovedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponseMediaTypeUpdated(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponseNonSuccessStatusUpdated(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponseOptionalPropertyUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponseOptionalPropertyWriteOnlyReadOnlyCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponseParameterEnumValueRemovedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponsePatternAddedOrChangedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponsePropertyAllOfUpdated(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponsePropertyAnyOfUpdated(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponsePropertyBecameNullableCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponsePropertyBecameOptionalCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponsePropertyBecameRequiredCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponsePropertyDefaultValueChangedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponsePropertyEnumValueAddedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponsePropertyMaxIncreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponsePropertyMaxLengthIncreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponsePropertyMaxLengthUnsetCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponsePropertyMinDecreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponsePropertyMinItemsDecreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponsePropertyMinItemsUnsetCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponsePropertyMinLengthDecreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponsePropertyOneOfUpdated(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponsePropertyTypeChangedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponseRequiredPropertyUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponseRequiredPropertyWriteOnlyReadOnlyCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponseStatusUpdated(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func ResponseSuccessStatusUpdated(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func UncheckedRequestAllOfWarnCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func UncheckedResponseAllOfWarnCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, ...) Changes + func (changes Changes) GetLevelCount() map[Level]int + func (changes Changes) HasLevelOrHigher(level Level) bool + func (changes Changes) Len() int + func (changes Changes) Less(i, j int) bool + func (changes Changes) Swap(i, j int) + type ComponentChange struct + Comment string + Id string + Level Level + Source string + Text string + func (ComponentChange) GetOperation() string + func (ComponentChange) GetOperationId() string + func (ComponentChange) GetPath() string + func (ComponentChange) MatchIgnore(ignorePath, ignoreLine string) bool + func (c ComponentChange) Error() string + func (c ComponentChange) GetComment() string + func (c ComponentChange) GetId() string + func (c ComponentChange) GetLevel() Level + func (c ComponentChange) GetText() string + func (c ComponentChange) LocalizedError(l Localizer) string + func (c ComponentChange) PrettyErrorText(l Localizer) string + type Config struct + Checks []BackwardCompatibilityCheck + Localize Localizer + LogLevelOverrides map[string]Level + MinSunsetBetaDays int + MinSunsetStableDays int + func GetAllChecks(includeChecks utils.StringList, deprecationDaysBeta int, ...) Config + func GetChecks(includeChecks utils.StringList) Config + func GetDefaultChecks() Config + type Level int + const ERR + const INFO + const WARN + func ConditionalError(isConditionSatisfied bool) Level + func NewLevel(level string) (Level, error) + func (level Level) PrettyString() string + func (level Level) String() string + type Localizer func(key string, args ...interface{}) string + func NewLocalizer(locale string, fallbackLocale string) Localizer + type SecurityChange struct + Comment string + Id string + Level Level + Source string + Text string + func (SecurityChange) GetOperationId() string + func (SecurityChange) GetPath() string + func (SecurityChange) MatchIgnore(ignorePath, ignoreLine string) bool + func (c SecurityChange) Error() string + func (c SecurityChange) GetComment() string + func (c SecurityChange) GetId() string + func (c SecurityChange) GetLevel() Level + func (c SecurityChange) GetText() string + func (c SecurityChange) LocalizedError(l Localizer) string + func (c SecurityChange) PrettyErrorText(l Localizer) string + func (r SecurityChange) GetOperation() string
Go to main page