checker

package
v1.6.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 26, 2023 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Overview

Package checker finds breaking-changes accoss openapi specifications.

Index

Constants

View Source 
const (
	APISecurityRemovedCheckId       = "api-security-removed"
	APISecurityAddedCheckId         = "api-security-added"
	APISecurityScopeAddedId         = "api-security-scope-added"
	APISecurityScopeRemovedId       = "api-security-scope-removed"
	APIGlobalSecurityRemovedCheckId = "api-global-security-removed"
	APIGlobalSecurityAddedCheckId   = "api-global-security-added"
	APIGlobalSecurityScopeAddedId   = "api-global-security-scope-added"
	APIGlobalSecurityScopeRemovedId = "api-global-security-scope-removed"
)
View Source 
const (
	APITagRemovedCheckId = "api-tag-removed"
	APITagAddedCheckId   = "api-tag-added"
)
View Source 
const (
	APIComponentsSecurityRemovedCheckId           = "api-security-component-removed"
	APIComponentsSecurityAddedCheckId             = "api-security-component-added"
	APIComponentsSecurityComponentOauthUrlUpdated = "api-security-component-oauth-url-changed"
	APIComponentsSecurityTyepUpdated              = "api-security-component-type-changed"
	APIComponentsSecurityOauthTokenUrlUpdated     = "api-security-component-oauth-token-url-changed"
	APIComponentSecurityOauthScopeAdded           = "api-security-component-oauth-scope-added"
	APIComponentSecurityOauthScopeRemoved         = "api-security-component-oauth-scope-removed"
	APIComponentSecurityOauthScopeUpdated         = "api-security-component-oauth-scope-changed"
)
View Source 
const (
	RequestBodyMediaTypeAdded   = "request-body-media-type-added"
	RequestBodyMediaTypeRemoved = "request-body-media-type-removed"
)
View Source 
const (
	ResponseMediaTypeUpdatedId = "response-media-type-removed"
	ResponseMediaTypeAddedId   = "response-media-type-added"
)
View Source 
const (
	ResponseOptionalPropertyBecameNonWriteOnlyCheckId = "response-optional-property-became-not-write-only"
	ResponseOptionalPropertyBecameWriteOnlyCheckId    = "response-optional-property-became-write-only"
	ResponseOptionalPropertyBecameReadOnlyCheckId     = "response-optional-property-became-read-only"
	ResponseOptionalPropertyBecameNonReadOnlyCheckId  = "response-optional-property-became-not-read-only"
)
View Source 
const (
	ResponsePropertyPatternAddedId   = "response-property-pattern-added"
	ResponsePropertyPatternChangedId = "response-property-pattern-changed"
	ResponsePropertyPatternRemovedId = "response-property-pattern-removed"
)
View Source 
const (
	ResponsePropertyBecameOptionalCheckId        = "response-property-became-optional"
	ResponseWriteOnlyPropertyBecameOptionalCheck = "response-write-only-property-became-optional"
)
View Source 
const (
	ResponsePropertyBecameRequiredCheckId        = "response-property-became-required"
	ResponseWriteOnlyPropertyBecameRequiredCheck = "response-write-only-property-became-required"
)
View Source 
const (
	ResponsePropertyEnumValueAddedCheckId          = "response-property-enum-value-added"
	ResponseWriteOnlyPropertyEnumValueAddedCheckId = "response-write-only-property-enum-value-added"
)
View Source 
const (
	ResponseRequiredPropertyRemovedCheckId          = "response-required-property-removed"
	ResponseRequiredWriteOnlyPropertyRemovedCheckId = "response-required-write-only-property-removed"
	ResponseRequiredPropertyAddedCheckId            = "response-required-property-added"
	ResponseRequiredWriteOnlyPropertyAddedCheckId   = "response-required-write-only-property-added"
)
View Source 
const (
	ResponseRequiredPropertyBecameNonWriteOnlyCheckId = "response-required-property-became-not-write-only"
	ResponseRequiredPropertyBecameWriteOnlyCheckId    = "response-required-property-became-write-only"
	ResponseRequiredPropertyBecameReadOnlyCheckId     = "response-required-property-became-read-only"
	ResponseRequiredPropertyBecameNonReadOnlyCheckId  = "response-required-property-became-not-read-only"
)
View Source 
const (
	BetaDeprecationDays   = 31
	StableDeprecationDays = 180
)

Variables

This section is empty.

Functions

func CheckAddedPropertiesDiff 

func CheckAddedPropertiesDiff(schemaDiff *diff.SchemaDiff, processor func(propertyPath string, propertyName string, propertyItem *openapi3.Schema, propertyParentDiff *diff.SchemaDiff))

func CheckDeletedPropertiesDiff 

func CheckDeletedPropertiesDiff(schemaDiff *diff.SchemaDiff, processor func(propertyPath string, propertyName string, propertyItem *openapi3.Schema, propertyParentDiff *diff.SchemaDiff))

func CheckModifiedPropertiesDiff 

func CheckModifiedPropertiesDiff(schemaDiff *diff.SchemaDiff, processor func(propertyPath string, propertyName string, propertyItem *diff.SchemaDiff, propertyParentItem *diff.SchemaDiff))

func ColorizedValue 

func ColorizedValue(arg interface{}) string

func GetOptionalChecks added in v1.6.0 

func GetOptionalChecks() []string

func IsDecreased 

func IsDecreased(from interface{}, to interface{}) bool

func IsDecreasedValue 

func IsDecreasedValue(diff *diff.ValueDiff) bool

func IsIncreased 

func IsIncreased(from interface{}, to interface{}) bool

func IsIncreasedValue 

func IsIncreasedValue(diff *diff.ValueDiff) bool

func IsPipedOutput 

func IsPipedOutput() bool

func LevelOverrides added in v1.5.18 

func LevelOverrides(includeChecks utils.StringList) map[string]Level

Types

type ApiChange added in v1.6.0 

type ApiChange struct {
	Id          string `json:"id,omitempty" yaml:"id,omitempty"`
	Text        string `json:"text,omitempty" yaml:"text,omitempty"`
	Comment     string `json:"comment,omitempty" yaml:"comment,omitempty"`
	Level       Level  `json:"level" yaml:"level"`
	Operation   string `json:"operation,omitempty" yaml:"operation,omitempty"`
	OperationId string `json:"operationId,omitempty" yaml:"operationId,omitempty"`
	Path        string `json:"path,omitempty" yaml:"path,omitempty"`
	Source      string `json:"source,omitempty" yaml:"source,omitempty"`
}

ApiChange represnts a change in the Paths Section of an OpenAPI spec

func (ApiChange) Error added in v1.6.0 

func (c ApiChange) Error() string

func (ApiChange) GetComment added in v1.6.0 

func (c ApiChange) GetComment() string

func (ApiChange) GetId added in v1.6.0 

func (c ApiChange) GetId() string

func (ApiChange) GetLevel added in v1.6.0 

func (c ApiChange) GetLevel() Level

func (ApiChange) GetOperation added in v1.6.0 

func (c ApiChange) GetOperation() string

func (ApiChange) GetOperationId added in v1.6.0 

func (c ApiChange) GetOperationId() string

func (ApiChange) GetPath added in v1.6.0 

func (c ApiChange) GetPath() string

func (ApiChange) GetText added in v1.6.0 

func (c ApiChange) GetText() string

func (ApiChange) LocalizedError added in v1.6.0 

func (c ApiChange) LocalizedError(l localizations.Localizer) string

func (ApiChange) MatchIgnore added in v1.6.0 

func (c ApiChange) MatchIgnore(ignorePath, ignoreLine string) bool

func (ApiChange) PrettyErrorText added in v1.6.0 

func (c ApiChange) PrettyErrorText(l localizations.Localizer) string

type BCDiff 

type BCDiff struct {
	diff.Diff
}

func (*BCDiff) AddModifiedOperation 

func (d *BCDiff) AddModifiedOperation(path string, operation string) *diff.MethodDiff

func (*BCDiff) AddModifiedParameter 

func (diffBC *BCDiff) AddModifiedParameter(path string, operation string, paramLocation string, paramName string) *diff.ParameterDiff

func (*BCDiff) AddModifiedPath 

func (d *BCDiff) AddModifiedPath(path string) *diff.PathDiff

func (*BCDiff) AddRequestPropertiesDiff 

func (diffBC *BCDiff) AddRequestPropertiesDiff(path string, operation string, mediaType string) *diff.SchemasDiff

type BackwardCompatibilityCheck 

type BackwardCompatibilityCheck func(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

type Change added in v1.6.0 

type Change interface {
	GetId() string
	GetText() string
	GetComment() string
	GetLevel() Level
	GetOperation() string
	GetOperationId() string
	GetPath() string

	MatchIgnore(ignorePath, ignoreLine string) bool
	LocalizedError(l localizations.Localizer) string
	PrettyErrorText(l localizations.Localizer) string
	Error() string
}

type Changes added in v1.6.0 

type Changes []Change

func APIAddedCheck added in v1.5.15 

func APIAddedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func APIComponentsSchemaRemovedCheck added in v1.5.14 

func APIComponentsSchemaRemovedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func APIComponentsSecurityUpdatedCheck added in v1.5.20 

func APIComponentsSecurityUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func APIDeprecationCheck 

func APIDeprecationCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func APIOperationIdUpdatedCheck added in v1.5.19 

func APIOperationIdUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func APIRemovedCheck 

func APIRemovedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func APISecurityUpdatedCheck added in v1.5.20 

func APISecurityUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func APISunsetChangedCheck 

func APISunsetChangedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func APITagUpdatedCheck added in v1.5.19 

func APITagUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func AddedRequiredRequestBodyCheck 

func AddedRequiredRequestBodyCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func CheckBackwardCompatibility 

func CheckBackwardCompatibility(config Config, diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap) Changes

func CheckBackwardCompatibilityUntilLevel added in v1.5.17 

func CheckBackwardCompatibilityUntilLevel(config Config, diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, level Level) Changes

func NewRequestNonPathParameterCheck added in v1.5.18 

func NewRequestNonPathParameterCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func NewRequestPathParameterCheck 

func NewRequestPathParameterCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func NewRequiredRequestHeaderPropertyCheck 

func NewRequiredRequestHeaderPropertyCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func NewRequiredRequestPropertyCheck 

func NewRequiredRequestPropertyCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ProcessIgnoredBackwardCompatibilityErrors 

func ProcessIgnoredBackwardCompatibilityErrors(level Level, errs Changes, ignoreFile string) (Changes, error)

func RequestBodyBecameEnumCheck added in v1.4.2 

func RequestBodyBecameEnumCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestBodyEnumValueRemovedCheck added in v1.3.18 

func RequestBodyEnumValueRemovedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestBodyMediaTypeChangedCheck added in v1.6.2 

func RequestBodyMediaTypeChangedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestBodyRequiredUpdatedCheck added in v1.5.19 

func RequestBodyRequiredUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestHeaderPropertyBecameEnumCheck added in v1.4.2 

func RequestHeaderPropertyBecameEnumCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestHeaderPropertyBecameRequiredCheck 

func RequestHeaderPropertyBecameRequiredCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestParameterBecameEnumCheck added in v1.4.2 

func RequestParameterBecameEnumCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestParameterDefaultValueChanged added in v1.3.15 

func RequestParameterDefaultValueChanged(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestParameterEnumValueRemovedCheck 

func RequestParameterEnumValueRemovedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestParameterMaxDecreasedCheck 

func RequestParameterMaxDecreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestParameterMaxLengthDecreasedCheck 

func RequestParameterMaxLengthDecreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestParameterMaxLengthSetCheck 

func RequestParameterMaxLengthSetCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestParameterMaxSetCheck 

func RequestParameterMaxSetCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestParameterMinIncreasedCheck 

func RequestParameterMinIncreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestParameterMinItemsIncreasedCheck 

func RequestParameterMinItemsIncreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestParameterMinItemsSetCheck 

func RequestParameterMinItemsSetCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestParameterMinSetCheck 

func RequestParameterMinSetCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestParameterPatternAddedOrChangedCheck 

func RequestParameterPatternAddedOrChangedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestParameterRemovedCheck 

func RequestParameterRemovedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestParameterRequiredValueUpdatedCheck added in v1.5.17 

func RequestParameterRequiredValueUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestParameterTypeChangedCheck 

func RequestParameterTypeChangedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestParameterXExtensibleEnumValueRemovedCheck 

func RequestParameterXExtensibleEnumValueRemovedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestPropertyBecameEnumCheck added in v1.4.2 

func RequestPropertyBecameEnumCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestPropertyBecameNotNullableCheck added in v1.5.12 

func RequestPropertyBecameNotNullableCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestPropertyBecameRequiredCheck 

func RequestPropertyBecameRequiredCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestPropertyEnumValueRemovedCheck 

func RequestPropertyEnumValueRemovedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestPropertyMaxDecreasedCheck 

func RequestPropertyMaxDecreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestPropertyMaxLengthDecreasedCheck 

func RequestPropertyMaxLengthDecreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestPropertyMaxLengthSetCheck 

func RequestPropertyMaxLengthSetCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestPropertyMaxSetCheck 

func RequestPropertyMaxSetCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestPropertyMinIncreasedCheck 

func RequestPropertyMinIncreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestPropertyMinItemsIncreasedCheck 

func RequestPropertyMinItemsIncreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestPropertyMinItemsSetCheck 

func RequestPropertyMinItemsSetCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestPropertyMinSetCheck 

func RequestPropertyMinSetCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestPropertyOneOfUpdated added in v1.6.5 

func RequestPropertyOneOfUpdated(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestPropertyPatternAddedOrChangedCheck 

func RequestPropertyPatternAddedOrChangedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestPropertyRemovedCheck 

func RequestPropertyRemovedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestPropertyTypeChangedCheck 

func RequestPropertyTypeChangedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func RequestPropertyXExtensibleEnumValueRemovedCheck 

func RequestPropertyXExtensibleEnumValueRemovedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponseHeaderBecameOptional 

func ResponseHeaderBecameOptional(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponseHeaderRemoved 

func ResponseHeaderRemoved(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponseMediaTypeEnumValueRemovedCheck added in v1.3.18 

func ResponseMediaTypeEnumValueRemovedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponseMediaTypeUpdated added in v1.5.20 

func ResponseMediaTypeUpdated(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponseNonSuccessStatusUpdated added in v1.5.19 

func ResponseNonSuccessStatusUpdated(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponseOptionalPropertyUpdatedCheck added in v1.5.20 

func ResponseOptionalPropertyUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponseOptionalPropertyWriteOnlyReadOnlyCheck added in v1.6.2 

func ResponseOptionalPropertyWriteOnlyReadOnlyCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponseParameterEnumValueRemovedCheck added in v1.3.18 

func ResponseParameterEnumValueRemovedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponsePatternAddedOrChangedCheck added in v1.6.3 

func ResponsePatternAddedOrChangedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponsePropertyBecameNullableCheck added in v1.4.1 

func ResponsePropertyBecameNullableCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponsePropertyBecameOptionalCheck 

func ResponsePropertyBecameOptionalCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponsePropertyBecameRequiredCheck added in v1.6.0 

func ResponsePropertyBecameRequiredCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponsePropertyDefaultValueChangedCheck added in v1.6.3 

func ResponsePropertyDefaultValueChangedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponsePropertyEnumValueAddedCheck 

func ResponsePropertyEnumValueAddedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponsePropertyMaxIncreasedCheck 

func ResponsePropertyMaxIncreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponsePropertyMaxLengthIncreasedCheck 

func ResponsePropertyMaxLengthIncreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponsePropertyMaxLengthUnsetCheck 

func ResponsePropertyMaxLengthUnsetCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponsePropertyMinDecreasedCheck 

func ResponsePropertyMinDecreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponsePropertyMinItemsDecreasedCheck 

func ResponsePropertyMinItemsDecreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponsePropertyMinItemsUnsetCheck 

func ResponsePropertyMinItemsUnsetCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponsePropertyMinLengthDecreasedCheck 

func ResponsePropertyMinLengthDecreasedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponsePropertyOneOfUpdated added in v1.6.5 

func ResponsePropertyOneOfUpdated(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponsePropertyTypeChangedCheck 

func ResponsePropertyTypeChangedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponseRequiredPropertyUpdatedCheck added in v1.5.20 

func ResponseRequiredPropertyUpdatedCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponseRequiredPropertyWriteOnlyReadOnlyCheck added in v1.6.2 

func ResponseRequiredPropertyWriteOnlyReadOnlyCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func ResponseStatusUpdated added in v1.5.19 

func ResponseStatusUpdated(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config, filter func(int) bool, id string, defaultLevel Level) Changes

func ResponseSuccessStatusUpdated added in v1.5.19 

func ResponseSuccessStatusUpdated(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func UncheckedRequestAllOfWarnCheck 

func UncheckedRequestAllOfWarnCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func UncheckedResponseAllOfWarnCheck 

func UncheckedResponseAllOfWarnCheck(diffReport *diff.Diff, operationsSources *diff.OperationsSourcesMap, config Config) Changes

func (Changes) GetLevelCount added in v1.6.0 

func (changes Changes) GetLevelCount() map[Level]int

func (Changes) HasLevelOrHigher added in v1.6.0 

func (changes Changes) HasLevelOrHigher(level Level) bool

func (Changes) Len added in v1.6.0 

func (changes Changes) Len() int

func (Changes) Less added in v1.6.0 

func (changes Changes) Less(i, j int) bool

func (Changes) Swap added in v1.6.0 

func (changes Changes) Swap(i, j int)

type ComponentChange added in v1.6.0 

type ComponentChange struct {
	Id      string `json:"id,omitempty" yaml:"id,omitempty"`
	Text    string `json:"text,omitempty" yaml:"text,omitempty"`
	Comment string `json:"comment,omitempty" yaml:"comment,omitempty"`
	Level   Level  `json:"level" yaml:"level"`
	Source  string `json:"source,omitempty" yaml:"source,omitempty"`
}

ComponentChange represnts a change in the Components Section: https://swagger.io/docs/specification/components/

func (ComponentChange) Error added in v1.6.0 

func (c ComponentChange) Error() string

func (ComponentChange) GetComment added in v1.6.0 

func (c ComponentChange) GetComment() string

func (ComponentChange) GetId added in v1.6.0 

func (c ComponentChange) GetId() string

func (ComponentChange) GetLevel added in v1.6.0 

func (c ComponentChange) GetLevel() Level

func (ComponentChange) GetOperation added in v1.6.0 

func (ComponentChange) GetOperation() string

func (ComponentChange) GetOperationId added in v1.6.0 

func (ComponentChange) GetOperationId() string

func (ComponentChange) GetPath added in v1.6.0 

func (ComponentChange) GetPath() string

func (ComponentChange) GetText added in v1.6.0 

func (c ComponentChange) GetText() string

func (ComponentChange) LocalizedError added in v1.6.0 

func (c ComponentChange) LocalizedError(l localizations.Localizer) string

func (ComponentChange) MatchIgnore added in v1.6.0 

func (ComponentChange) MatchIgnore(ignorePath, ignoreLine string) bool

func (ComponentChange) PrettyErrorText added in v1.6.0 

func (c ComponentChange) PrettyErrorText(l localizations.Localizer) string

type Config added in v1.6.0 

type Config struct {
	Checks              []BackwardCompatibilityCheck
	MinSunsetBetaDays   int
	MinSunsetStableDays int
	Localizer           localizations.Localizer
	LogLevelOverrides   map[string]Level
}

func GetAllChecks added in v1.5.15 

func GetAllChecks(includeChecks utils.StringList, deprecationDaysBeta int, deprecationDaysStable int) Config

func GetChecks added in v1.3.10 

func GetChecks(includeChecks utils.StringList) Config

func GetDefaultChecks added in v1.3.10 

func GetDefaultChecks() Config

type Level added in v1.5.15 

type Level int
const (
	ERR  Level = 3
	WARN Level = 2
	INFO Level = 1
)

func NewLevel added in v1.6.0 

func NewLevel(level string) (Level, error)

func (Level) PrettyString added in v1.6.0 

func (level Level) PrettyString() string

func (Level) String added in v1.6.0 

func (level Level) String() string

type SecurityChange added in v1.6.0 

type SecurityChange struct {
	Id      string `json:"id,omitempty" yaml:"id,omitempty"`
	Text    string `json:"text,omitempty" yaml:"text,omitempty"`
	Comment string `json:"comment,omitempty" yaml:"comment,omitempty"`
	Level   Level  `json:"level" yaml:"level"`
	Source  string `json:"source,omitempty" yaml:"source,omitempty"`
}

SecurityChange represnts a change in the Security Section (not to be confised with components/securitySchemes)

func (SecurityChange) Error added in v1.6.0 

func (c SecurityChange) Error() string

func (SecurityChange) GetComment added in v1.6.0 

func (c SecurityChange) GetComment() string

func (SecurityChange) GetId added in v1.6.0 

func (c SecurityChange) GetId() string

func (SecurityChange) GetLevel added in v1.6.0 

func (c SecurityChange) GetLevel() Level

func (SecurityChange) GetOperation added in v1.6.0 

func (r SecurityChange) GetOperation() string

func (SecurityChange) GetOperationId added in v1.6.0 

func (SecurityChange) GetOperationId() string

func (SecurityChange) GetPath added in v1.6.0 

func (SecurityChange) GetPath() string

func (SecurityChange) GetText added in v1.6.0 

func (c SecurityChange) GetText() string

func (SecurityChange) LocalizedError added in v1.6.0 

func (c SecurityChange) LocalizedError(l localizations.Localizer) string

func (SecurityChange) MatchIgnore added in v1.6.0 

func (SecurityChange) MatchIgnore(ignorePath, ignoreLine string) bool

func (SecurityChange) PrettyErrorText added in v1.6.0 

func (c SecurityChange) PrettyErrorText(l localizations.Localizer) string

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.