checker

package
v1.21.0 Latest Latest
Warning

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

 Go to latest Published: Jun 28, 2026 License: Apache-2.0 Imports: 19 Imported by: 4

Documentation

Overview

Package checker detects breaking changes and generates changelog messages between OpenAPI specifications.

Overview

The checker analyzes a diff report (from the diff package) and applies a set of rules to detect breaking changes and other notable differences. It supports both path operations and webhooks.

Usage

The main entry point is CheckBackwardCompatibility: 

diffReport, _ := diff.Get(config, spec1, spec2)
changes := checker.CheckBackwardCompatibility(checker.NewConfig(checker.GetAllRules()), diffReport, operationsSources)

Configuration

Config controls which checks run and their severity levels:

  • Checks: the list of BackwardCompatibilityCheck functions to run
  • LogLevels: override default severity (ERR, WARN, INFO) for specific rule IDs
  • MinSunsetBetaDays/MinSunsetStableDays: minimum deprecation periods

Use NewConfig with GetAllRules() for all checks, or GetDefaultRules() for breaking changes only.

Severity Levels

Each rule has a default severity level:

  • ERR: breaking change that will break existing clients
  • WARN: potentially breaking change that may affect some clients
  • INFO: non-breaking change for changelog purposes

Rules

Rules are defined in rules.go with metadata including:

  • Direction: whether the rule applies to requests, responses, or neither
  • Area: the OpenAPI object the rule concerns (schema, parameters, requestBody, responses, paths, headers, security, tags, or components)
  • Kind: the aspect of the contract that changed (existence, requiredness, mutability, type, constraints, values, structure, or lifecycle)
  • Action: add, remove, change, generalize, specialize, increase, decrease, set

This metadata enables filtering and categorization of changes.

Webhooks

Webhooks are handled by merging modified webhooks into PathsDiff with a "webhook:" prefix, allowing all path/operation rules to apply without duplication. Added/deleted webhooks are handled separately by WebhookUpdatedCheck since PathsDiff.Added/Deleted require lookup in openapi3.Paths objects that don't contain webhooks.

Localization

Change messages support localization via the localizations package (generated from localizations_src). Messages use format strings with placeholders for dynamic values.

Index

Examples

Constants

View Source 
const (
	AddedRequiredRequestBodyId = "request-body-added-required"
	AddedOptionalRequestBodyId = "request-body-added-optional"
)
View Source 
const (
	EndpointReactivatedId          = "endpoint-reactivated"
	APIDeprecatedSunsetParseId     = "api-deprecated-sunset-parse"
	APIDeprecatedSunsetMissingId   = "api-deprecated-sunset-missing"
	APIInvalidStabilityLevelId     = "api-invalid-stability-level"
	APISunsetDateTooSmallId        = "api-sunset-date-too-small"
	EndpointDeprecatedId           = "endpoint-deprecated"
	EndpointDeprecatedWithSunsetId = "endpoint-deprecated-with-sunset"
)
View Source 
const (
	APIOperationIdRemovedId = "api-operation-id-removed"
	APIOperationIdAddId     = "api-operation-id-added"
)
View Source 
const (
	APIPathRemovedWithoutDeprecationId = "api-path-removed-without-deprecation"
	APIPathRemovedWithDeprecationId    = "api-path-removed-with-deprecation"
	APIPathSunsetParseId               = "api-path-sunset-parse"
	APIPathRemovedBeforeSunsetId       = "api-path-removed-before-sunset"
	APIRemovedWithoutDeprecationId     = "api-removed-without-deprecation"
	APIRemovedWithDeprecationId        = "api-removed-with-deprecation"
	APIRemovedBeforeSunsetId           = "api-removed-before-sunset"
)
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 (
	APIStabilityDecreasedId = "api-stability-decreased"
	APIStabilityIncreasedId = "api-stability-increased"
)
View Source 
const (
	APISunsetDeletedId             = "sunset-deleted"
	APISunsetDateChangedTooSmallId = "api-sunset-date-changed-too-small"
)
View Source 
const (
	StabilityDraft  = "draft"
	StabilityAlpha  = "alpha"
	StabilityBeta   = "beta"
	StabilityStable = "stable"
)
View Source 
const (
	// Deprecated: use StabilityDraft.
	STABILITY_DRAFT = StabilityDraft
	// Deprecated: use StabilityAlpha.
	STABILITY_ALPHA = StabilityAlpha
	// Deprecated: use StabilityBeta.
	STABILITY_BETA = StabilityBeta
	// Deprecated: use StabilityStable.
	STABILITY_STABLE = StabilityStable
)
View Source 
const (
	APITagRemovedId = "api-tag-removed"
	APITagAddedId   = "api-tag-added"
)
View Source 
const (
	APISchemasRemovedId = "api-schema-removed"
	ComponentSchemas    = "schemas"
)
View Source 
const (
	APIComponentsSecurityRemovedId                  = "api-security-component-removed"
	APIComponentsSecurityAddedId                    = "api-security-component-added"
	APIComponentsSecurityComponentOauthUrlUpdatedId = "api-security-component-oauth-url-changed"
	APIComponentsSecurityTypeUpdatedId              = "api-security-component-type-changed"
	APIComponentsSecurityOauthTokenUrlUpdatedId     = "api-security-component-oauth-token-url-changed"
	APIComponentSecurityOauthScopeAddedId           = "api-security-component-oauth-scope-added"
	APIComponentSecurityOauthScopeRemovedId         = "api-security-component-oauth-scope-removed"
	APIComponentSecurityOauthScopeUpdatedId         = "api-security-component-oauth-scope-changed"
)
View Source 
const (
	RequestBodyMediaTypeSchemaAddedId    = "request-body-media-type-schema-added"
	RequestBodyMediaTypeSchemaRemovedId  = "request-body-media-type-schema-removed"
	ResponseBodyMediaTypeSchemaAddedId   = "response-body-media-type-schema-added"
	ResponseBodyMediaTypeSchemaRemovedId = "response-body-media-type-schema-removed"
)
View Source 
const (
	NewRequiredRequestDefaultParameterToExistingPathId = "new-required-request-default-parameter-to-existing-path"
	NewOptionalRequestDefaultParameterToExistingPathId = "new-optional-request-default-parameter-to-existing-path"
)
View Source 
const (
	NewRequiredRequestParameterId = "new-required-request-parameter"
	NewOptionalRequestParameterId = "new-optional-request-parameter"
)
View Source 
const (
	RequestPropertyStabilityDecreasedId  = "request-property-stability-decreased"
	RequestPropertyStabilityIncreasedId  = "request-property-stability-increased"
	ResponsePropertyStabilityDecreasedId = "response-property-stability-decreased"
	ResponsePropertyStabilityIncreasedId = "response-property-stability-increased"
)
View Source 
const (
	RequestBodyMediaTypeAddedId   = "request-body-media-type-added"
	RequestBodyMediaTypeRemovedId = "request-body-media-type-removed"
)
View Source 
const (
	RequestBodyBecameOptionalId = "request-body-became-optional"
	RequestBodyBecameRequiredId = "request-body-became-required"
)
View Source 
const (
	RequestBodyDiscriminatorAddedId                   = "request-body-discriminator-added"
	RequestBodyDiscriminatorRemovedId                 = "request-body-discriminator-removed"
	RequestBodyDiscriminatorPropertyNameChangedId     = "request-body-discriminator-property-name-changed"
	RequestBodyDiscriminatorMappingAddedId            = "request-body-discriminator-mapping-added"
	RequestBodyDiscriminatorMappingDeletedId          = "request-body-discriminator-mapping-deleted"
	RequestBodyDiscriminatorMappingChangedId          = "request-body-discriminator-mapping-changed"
	RequestPropertyDiscriminatorAddedId               = "request-property-discriminator-added"
	RequestPropertyDiscriminatorRemovedId             = "request-property-discriminator-removed"
	RequestPropertyDiscriminatorPropertyNameChangedId = "request-property-discriminator-property-name-changed"
	RequestPropertyDiscriminatorMappingAddedId        = "request-property-discriminator-mapping-added"
	RequestPropertyDiscriminatorMappingDeletedId      = "request-property-discriminator-mapping-deleted"
	RequestPropertyDiscriminatorMappingChangedId      = "request-property-discriminator-mapping-changed"
)
View Source 
const (
	RequestParameterReactivatedId             = "request-parameter-reactivated"
	RequestParameterDeprecatedSunsetMissingId = "request-parameter-deprecated-sunset-missing"
	RequestParameterSunsetDateTooSmallId      = "request-parameter-sunset-date-too-small"
	RequestParameterDeprecatedId              = "request-parameter-deprecated"
)
View Source 
const (
	RequestParameterEnumValueAddedId           = "request-parameter-enum-value-added"
	RequestParameterEnumValueRemovedId         = "request-parameter-enum-value-removed"
	RequestParameterPropertyEnumValueAddedId   = "request-parameter-property-enum-value-added"
	RequestParameterPropertyEnumValueRemovedId = "request-parameter-property-enum-value-removed"
)
View Source 
const (
	RequestParameterListOfTypesWidenedId          = "request-parameter-list-of-types-widened"
	RequestParameterListOfTypesNarrowedId         = "request-parameter-list-of-types-narrowed"
	RequestParameterPropertyListOfTypesWidenedId  = "request-parameter-property-list-of-types-widened"
	RequestParameterPropertyListOfTypesNarrowedId = "request-parameter-property-list-of-types-narrowed"
)
View Source 
const (
	RequestParameterPatternAddedId       = "request-parameter-pattern-added"
	RequestParameterPatternRemovedId     = "request-parameter-pattern-removed"
	RequestParameterPatternChangedId     = "request-parameter-pattern-changed"
	RequestParameterPatternGeneralizedId = "request-parameter-pattern-generalized"
	PatternChangedCommentId              = "pattern-changed-warn-comment"
	PatternAddedCommentId                = "pattern-added-error-comment"
)
View Source 
const (
	RequestParameterRemovedId                = "request-parameter-removed" // this is actually the "without deprecation" case but we leave it as is for backward compatibility
	RequestParameterRemovedWithDeprecationId = "request-parameter-removed-with-deprecation"
	RequestParameterSunsetParseId            = "request-parameter-sunset-parse"
	ParameterRemovedBeforeSunsetId           = "request-parameter-removed-before-sunset"
)
View Source 
const (
	RequestParameterBecomeRequiredId = "request-parameter-became-required"
	RequestParameterBecomeOptionalId = "request-parameter-became-optional"
)
View Source 
const (
	RequestParameterSunsetDeletedId             = "request-parameter-sunset-deleted"
	RequestParameterSunsetDateChangedTooSmallId = "request-parameter-sunset-date-changed-too-small"
)
View Source 
const (
	RequestParameterDefaultValueChangedId = "request-parameter-default-value-changed"
	RequestParameterDefaultValueAddedId   = "request-parameter-default-value-added"
	RequestParameterDefaultValueRemovedId = "request-parameter-default-value-removed"
)
View Source 
const (
	RequestParameterMaxItemsIncreasedId = "request-parameter-max-items-increased"
	RequestParameterMaxItemsDecreasedId = "request-parameter-max-items-decreased"
)
View Source 
const (
	RequestParameterMaxLengthDecreasedId = "request-parameter-max-length-decreased"
	RequestParameterMaxLengthIncreasedId = "request-parameter-max-length-increased"
)
View Source 
const (
	RequestParameterMaxSetId          = "request-parameter-max-set"
	RequestParameterExclusiveMaxSetId = "request-parameter-exclusive-max-set"
)
View Source 
const (
	RequestParameterMaxDecreasedId          = "request-parameter-max-decreased"
	RequestParameterMaxIncreasedId          = "request-parameter-max-increased"
	RequestParameterExclusiveMaxDecreasedId = "request-parameter-exclusive-max-decreased"
	RequestParameterExclusiveMaxIncreasedId = "request-parameter-exclusive-max-increased"
)
View Source 
const (
	RequestParameterMinItemsIncreasedId = "request-parameter-min-items-increased"
	RequestParameterMinItemsDecreasedId = "request-parameter-min-items-decreased"
)
View Source 
const (
	RequestParameterMinLengthIncreasedId = "request-parameter-min-length-increased"
	RequestParameterMinLengthDecreasedId = "request-parameter-min-length-decreased"
)
View Source 
const (
	RequestParameterMinSetId          = "request-parameter-min-set"
	RequestParameterExclusiveMinSetId = "request-parameter-exclusive-min-set"
)
View Source 
const (
	RequestParameterMinIncreasedId          = "request-parameter-min-increased"
	RequestParameterMinDecreasedId          = "request-parameter-min-decreased"
	RequestParameterExclusiveMinIncreasedId = "request-parameter-exclusive-min-increased"
	RequestParameterExclusiveMinDecreasedId = "request-parameter-exclusive-min-decreased"
)
View Source 
const (
	RequestParameterTypeChangedId                 = "request-parameter-type-changed"
	RequestParameterTypeGeneralizedId             = "request-parameter-type-generalized"
	RequestParameterPropertyTypeChangedId         = "request-parameter-property-type-changed"
	RequestParameterPropertyTypeGeneralizedId     = "request-parameter-property-type-generalized"
	RequestParameterPropertyTypeSpecializedId     = "request-parameter-property-type-specialized"
	RequestParameterPropertyTypeChangedCommentId  = "request-parameter-property-type-changed-warn-comment"
	RequestParameterTypeFormExplodeArrayCommentId = "request-parameter-type-form-explode-array-comment"
)
View Source 
const (
	RequestBodyAllOfAddedId                     = "request-body-all-of-added"
	RequestBodyAllOfRemovedId                   = "request-body-all-of-removed"
	RequestPropertyAllOfAddedId                 = "request-property-all-of-added"
	RequestPropertyAllOfRemovedId               = "request-property-all-of-removed"
	RequestBodyAllOfAddedAnnotationOnlyId       = "request-body-all-of-added-annotation-only"
	RequestBodyAllOfRemovedAnnotationOnlyId     = "request-body-all-of-removed-annotation-only"
	RequestPropertyAllOfAddedAnnotationOnlyId   = "request-property-all-of-added-annotation-only"
	RequestPropertyAllOfRemovedAnnotationOnlyId = "request-property-all-of-removed-annotation-only"
)
View Source 
const (
	RequestBodyAnyOfAddedId       = "request-body-any-of-added"
	RequestBodyAnyOfRemovedId     = "request-body-any-of-removed"
	RequestPropertyAnyOfAddedId   = "request-property-any-of-added"
	RequestPropertyAnyOfRemovedId = "request-property-any-of-removed"
)
View Source 
const (
	RequestBodyBecomeNotNullableId     = "request-body-became-not-nullable"
	RequestBodyBecomeNullableId        = "request-body-became-nullable"
	RequestPropertyBecomeNotNullableId = "request-property-became-not-nullable"
	RequestPropertyBecomeNullableId    = "request-property-became-nullable"
)
View Source 
const (
	RequestBodyConstAddedId       = "request-body-const-added"
	RequestBodyConstRemovedId     = "request-body-const-removed"
	RequestBodyConstChangedId     = "request-body-const-changed"
	RequestPropertyConstAddedId   = "request-property-const-added"
	RequestPropertyConstRemovedId = "request-property-const-removed"
	RequestPropertyConstChangedId = "request-property-const-changed"
)
View Source 
const (
	RequestBodyContainsAddedId            = "request-body-contains-added"
	RequestBodyContainsRemovedId          = "request-body-contains-removed"
	RequestBodyMinContainsIncreasedId     = "request-body-min-contains-increased"
	RequestBodyMinContainsDecreasedId     = "request-body-min-contains-decreased"
	RequestBodyMaxContainsIncreasedId     = "request-body-max-contains-increased"
	RequestBodyMaxContainsDecreasedId     = "request-body-max-contains-decreased"
	RequestPropertyContainsAddedId        = "request-property-contains-added"
	RequestPropertyContainsRemovedId      = "request-property-contains-removed"
	RequestPropertyMinContainsIncreasedId = "request-property-min-contains-increased"
	RequestPropertyMinContainsDecreasedId = "request-property-min-contains-decreased"
	RequestPropertyMaxContainsIncreasedId = "request-property-max-contains-increased"
	RequestPropertyMaxContainsDecreasedId = "request-property-max-contains-decreased"
)
View Source 
const (
	RequestBodyContentSchemaAddedId      = "request-body-content-schema-added"
	RequestBodyContentSchemaRemovedId    = "request-body-content-schema-removed"
	RequestBodyContentMediaTypeChangedId = "request-body-content-media-type-changed"
	RequestBodyContentEncodingChangedId  = "request-body-content-encoding-changed"

	RequestPropertyContentSchemaAddedId      = "request-property-content-schema-added"
	RequestPropertyContentSchemaRemovedId    = "request-property-content-schema-removed"
	RequestPropertyContentMediaTypeChangedId = "request-property-content-media-type-changed"
	RequestPropertyContentEncodingChangedId  = "request-property-content-encoding-changed"
)
View Source 
const (
	RequestBodyDefaultValueAddedId       = "request-body-default-value-added"
	RequestBodyDefaultValueRemovedId     = "request-body-default-value-removed"
	RequestBodyDefaultValueChangedId     = "request-body-default-value-changed"
	RequestPropertyDefaultValueAddedId   = "request-property-default-value-added"
	RequestPropertyDefaultValueRemovedId = "request-property-default-value-removed"
	RequestPropertyDefaultValueChangedId = "request-property-default-value-changed"
)
View Source 
const (
	RequestBodyDependentRequiredAddedId       = "request-body-dependent-required-added"
	RequestBodyDependentRequiredRemovedId     = "request-body-dependent-required-removed"
	RequestBodyDependentRequiredChangedId     = "request-body-dependent-required-changed"
	RequestPropertyDependentRequiredAddedId   = "request-property-dependent-required-added"
	RequestPropertyDependentRequiredRemovedId = "request-property-dependent-required-removed"
	RequestPropertyDependentRequiredChangedId = "request-property-dependent-required-changed"
)
View Source 
const (
	RequestBodyDependentSchemaAddedId       = "request-body-dependent-schema-added"
	RequestBodyDependentSchemaRemovedId     = "request-body-dependent-schema-removed"
	RequestPropertyDependentSchemaAddedId   = "request-property-dependent-schema-added"
	RequestPropertyDependentSchemaRemovedId = "request-property-dependent-schema-removed"
)
View Source 
const (
	RequestPropertyDeprecatedId              = "request-property-deprecated"
	RequestPropertyDeprecatedWithSunsetId    = "request-property-deprecated-with-sunset"
	RequestPropertyDeprecatedSunsetMissingId = "request-property-deprecated-sunset-missing"
	RequestPropertyDeprecatedInvalidId       = "request-property-deprecated-sunset-invalid"
	RequestPropertyReactivatedId             = "request-property-reactivated"
	RequestPropertySunsetDateTooSmallId      = "request-property-sunset-date-too-small"
)
View Source 
const (
	RequestPropertyEnumValueRemovedId         = "request-property-enum-value-removed"
	RequestReadOnlyPropertyEnumValueRemovedId = "request-read-only-property-enum-value-removed"
	RequestPropertyEnumValueAddedId           = "request-property-enum-value-added"
)
View Source 
const (
	RequestBodyIfAddedId       = "request-body-if-added"
	RequestBodyIfRemovedId     = "request-body-if-removed"
	RequestBodyThenAddedId     = "request-body-then-added"
	RequestBodyThenRemovedId   = "request-body-then-removed"
	RequestBodyElseAddedId     = "request-body-else-added"
	RequestBodyElseRemovedId   = "request-body-else-removed"
	RequestPropertyIfAddedId   = "request-property-if-added"
	RequestPropertyIfRemovedId = "request-property-if-removed"

	RequestPropertyThenAddedId   = "request-property-then-added"
	RequestPropertyThenRemovedId = "request-property-then-removed"
	RequestPropertyElseAddedId   = "request-property-else-added"
	RequestPropertyElseRemovedId = "request-property-else-removed"
)
View Source 
const (
	RequestBodyListOfTypesWidenedId      = "request-body-list-of-types-widened"
	RequestBodyListOfTypesNarrowedId     = "request-body-list-of-types-narrowed"
	RequestPropertyListOfTypesWidenedId  = "request-property-list-of-types-widened"
	RequestPropertyListOfTypesNarrowedId = "request-property-list-of-types-narrowed"
)
View Source 
const (
	RequestBodyMaxLengthSetId     = "request-body-max-length-set"
	RequestPropertyMaxLengthSetId = "request-property-max-length-set"
)
View Source 
const (
	RequestBodyMaxLengthDecreasedId             = "request-body-max-length-decreased"
	RequestBodyMaxLengthIncreasedId             = "request-body-max-length-increased"
	RequestPropertyMaxLengthDecreasedId         = "request-property-max-length-decreased"
	RequestReadOnlyPropertyMaxLengthDecreasedId = "request-read-only-property-max-length-decreased"
	RequestPropertyMaxLengthIncreasedId         = "request-property-max-length-increased"
)
View Source 
const (
	RequestBodyMaxSetId              = "request-body-max-set"
	RequestPropertyMaxSetId          = "request-property-max-set"
	RequestBodyExclusiveMaxSetId     = "request-body-exclusive-max-set"
	RequestPropertyExclusiveMaxSetId = "request-property-exclusive-max-set"
)
View Source 
const (
	RequestBodyMaxDecreasedId                      = "request-body-max-decreased"
	RequestBodyMaxIncreasedId                      = "request-body-max-increased"
	RequestPropertyMaxDecreasedId                  = "request-property-max-decreased"
	RequestReadOnlyPropertyMaxDecreasedId          = "request-read-only-property-max-decreased"
	RequestPropertyMaxIncreasedId                  = "request-property-max-increased"
	RequestBodyExclusiveMaxDecreasedId             = "request-body-exclusive-max-decreased"
	RequestBodyExclusiveMaxIncreasedId             = "request-body-exclusive-max-increased"
	RequestPropertyExclusiveMaxDecreasedId         = "request-property-exclusive-max-decreased"
	RequestReadOnlyPropertyExclusiveMaxDecreasedId = "request-read-only-property-exclusive-max-decreased"
	RequestPropertyExclusiveMaxIncreasedId         = "request-property-exclusive-max-increased"
)
View Source 
const (
	RequestBodyMinItemsIncreasedId     = "request-body-min-items-increased"
	RequestPropertyMinItemsIncreasedId = "request-property-min-items-increased"
)
View Source 
const (
	RequestBodyMinItemsSetId     = "request-body-min-items-set"
	RequestPropertyMinItemsSetId = "request-property-min-items-set"
)
View Source 
const (
	RequestBodyMinLengthIncreasedId     = "request-body-min-length-increased"
	RequestBodyMinLengthDecreasedId     = "request-body-min-length-decreased"
	RequestPropertyMinLengthIncreasedId = "request-property-min-length-increased"
	RequestPropertyMinLengthDecreasedId = "request-property-min-length-decreased"
)
View Source 
const (
	RequestBodyMinSetId              = "request-body-min-set"
	RequestPropertyMinSetId          = "request-property-min-set"
	RequestBodyExclusiveMinSetId     = "request-body-exclusive-min-set"
	RequestPropertyExclusiveMinSetId = "request-property-exclusive-min-set"
)
View Source 
const (
	RequestBodyMinIncreasedId                      = "request-body-min-increased"
	RequestBodyMinDecreasedId                      = "request-body-min-decreased"
	RequestPropertyMinIncreasedId                  = "request-property-min-increased"
	RequestReadOnlyPropertyMinIncreasedId          = "request-read-only-property-min-increased"
	RequestPropertyMinDecreasedId                  = "request-property-min-decreased"
	RequestBodyExclusiveMinIncreasedId             = "request-body-exclusive-min-increased"
	RequestBodyExclusiveMinDecreasedId             = "request-body-exclusive-min-decreased"
	RequestPropertyExclusiveMinIncreasedId         = "request-property-exclusive-min-increased"
	RequestReadOnlyPropertyExclusiveMinIncreasedId = "request-read-only-property-exclusive-min-increased"
	RequestPropertyExclusiveMinDecreasedId         = "request-property-exclusive-min-decreased"
)
View Source 
const (
	RequestBodyOneOfAddedId       = "request-body-one-of-added"
	RequestBodyOneOfRemovedId     = "request-body-one-of-removed"
	RequestPropertyOneOfAddedId   = "request-property-one-of-added"
	RequestPropertyOneOfRemovedId = "request-property-one-of-removed"
)
View Source 
const (
	RequestPropertyPatternRemovedId     = "request-property-pattern-removed"
	RequestPropertyPatternAddedId       = "request-property-pattern-added"
	RequestPropertyPatternChangedId     = "request-property-pattern-changed"
	RequestPropertyPatternGeneralizedId = "request-property-pattern-generalized"
)
View Source 
const (
	RequestBodyPatternPropertyAddedId       = "request-body-pattern-property-added"
	RequestBodyPatternPropertyRemovedId     = "request-body-pattern-property-removed"
	RequestPropertyPatternPropertyAddedId   = "request-property-pattern-property-added"
	RequestPropertyPatternPropertyRemovedId = "request-property-pattern-property-removed"
)
View Source 
const (
	RequestBodyPrefixItemsAddedId       = "request-body-prefix-items-added"
	RequestBodyPrefixItemsRemovedId     = "request-body-prefix-items-removed"
	RequestPropertyPrefixItemsAddedId   = "request-property-prefix-items-added"
	RequestPropertyPrefixItemsRemovedId = "request-property-prefix-items-removed"
)
View Source 
const (
	RequestBodyPropertyNamesAddedId       = "request-body-property-names-added"
	RequestBodyPropertyNamesRemovedId     = "request-body-property-names-removed"
	RequestPropertyPropertyNamesAddedId   = "request-property-property-names-added"
	RequestPropertyPropertyNamesRemovedId = "request-property-property-names-removed"
)
View Source 
const (
	RequestPropertyBecameRequiredId            = "request-property-became-required"
	RequestPropertyBecameRequiredWithDefaultId = "request-property-became-required-with-default"
	RequestPropertyBecameOptionalId            = "request-property-became-optional"
)
View Source 
const (
	RequestBodyTypeGeneralizedId     = "request-body-type-generalized"
	RequestBodyTypeChangedId         = "request-body-type-changed"
	RequestPropertyTypeGeneralizedId = "request-property-type-generalized"
	RequestPropertyTypeChangedId     = "request-property-type-changed"
)
View Source 
const (
	RequestBodyUnevaluatedItemsAddedId        = "request-body-unevaluated-items-added"
	RequestBodyUnevaluatedItemsRemovedId      = "request-body-unevaluated-items-removed"
	RequestBodyUnevaluatedPropertiesAddedId   = "request-body-unevaluated-properties-added"
	RequestBodyUnevaluatedPropertiesRemovedId = "request-body-unevaluated-properties-removed"

	RequestPropertyUnevaluatedItemsAddedId        = "request-property-unevaluated-items-added"
	RequestPropertyUnevaluatedItemsRemovedId      = "request-property-unevaluated-items-removed"
	RequestPropertyUnevaluatedPropertiesAddedId   = "request-property-unevaluated-properties-added"
	RequestPropertyUnevaluatedPropertiesRemovedId = "request-property-unevaluated-properties-removed"
)
View Source 
const (
	RequestPropertyRemovedId                = "request-property-removed"
	NewRequiredRequestPropertyId            = "new-required-request-property"
	NewRequiredRequestPropertyWithDefaultId = "new-required-request-property-with-default"
	NewOptionalRequestPropertyId            = "new-optional-request-property"
	RequestBodyWrappedInOneOfId             = "request-body-wrapped-in-one-of"
)
View Source 
const (
	RequestOptionalPropertyBecameNonWriteOnlyCheckId = "request-optional-property-became-not-write-only"
	RequestOptionalPropertyBecameWriteOnlyCheckId    = "request-optional-property-became-write-only"
	RequestOptionalPropertyBecameReadOnlyCheckId     = "request-optional-property-became-read-only"
	RequestOptionalPropertyBecameNonReadOnlyCheckId  = "request-optional-property-became-not-read-only"
	RequestRequiredPropertyBecameNonWriteOnlyCheckId = "request-required-property-became-not-write-only"
	RequestRequiredPropertyBecameWriteOnlyCheckId    = "request-required-property-became-write-only"
	RequestRequiredPropertyBecameReadOnlyCheckId     = "request-required-property-became-read-only"
	RequestRequiredPropertyBecameNonReadOnlyCheckId  = "request-required-property-became-not-read-only"
)
View Source 
const (
	ResponseBodyDiscriminatorAddedId                   = "response-body-discriminator-added"
	ResponseBodyDiscriminatorRemovedId                 = "response-body-discriminator-removed"
	ResponseBodyDiscriminatorPropertyNameChangedId     = "response-body-discriminator-property-name-changed"
	ResponseBodyDiscriminatorMappingAddedId            = "response-body-discriminator-mapping-added"
	ResponseBodyDiscriminatorMappingDeletedId          = "response-body-discriminator-mapping-deleted"
	ResponseBodyDiscriminatorMappingChangedId          = "response-body-discriminator-mapping-changed"
	ResponsePropertyDiscriminatorAddedId               = "response-property-discriminator-added"
	ResponsePropertyDiscriminatorRemovedId             = "response-property-discriminator-removed"
	ResponsePropertyDiscriminatorPropertyNameChangedId = "response-property-discriminator-property-name-changed"
	ResponsePropertyDiscriminatorMappingAddedId        = "response-property-discriminator-mapping-added"
	ResponsePropertyDiscriminatorMappingDeletedId      = "response-property-discriminator-mapping-deleted"
	ResponsePropertyDiscriminatorMappingChangedId      = "response-property-discriminator-mapping-changed"
)
View Source 
const (
	RequiredResponseHeaderRemovedId = "required-response-header-removed"
	OptionalResponseHeaderRemovedId = "optional-response-header-removed"
)
View Source 
const (
	ResponseMediaTypeNameChangedId     = "response-media-type-name-changed"
	ResponseMediaTypeNameGeneralizedId = "response-media-type-name-generalized"
	ResponseMediaTypeNameSpecializedId = "response-media-type-name-specialized"
)
View Source 
const (
	ResponseMediaTypeRemovedId = "response-media-type-removed"
	ResponseMediaTypeAddedId   = "response-media-type-added"
)
View Source 
const (
	ResponseOptionalPropertyRemovedId          = "response-optional-property-removed"
	ResponseOptionalWriteOnlyPropertyRemovedId = "response-optional-write-only-property-removed"
	ResponseOptionalPropertyAddedId            = "response-optional-property-added"
	ResponseOptionalWriteOnlyPropertyAddedId   = "response-optional-write-only-property-added"
)
View Source 
const (
	ResponseOptionalPropertyBecameNonWriteOnlyId = "response-optional-property-became-not-write-only"
	ResponseOptionalPropertyBecameWriteOnlyId    = "response-optional-property-became-write-only"
	ResponseOptionalPropertyBecameReadOnlyId     = "response-optional-property-became-read-only"
	ResponseOptionalPropertyBecameNonReadOnlyId  = "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 (
	ResponseBodyAllOfAddedId                     = "response-body-all-of-added"
	ResponseBodyAllOfRemovedId                   = "response-body-all-of-removed"
	ResponsePropertyAllOfAddedId                 = "response-property-all-of-added"
	ResponsePropertyAllOfRemovedId               = "response-property-all-of-removed"
	ResponseBodyAllOfAddedAnnotationOnlyId       = "response-body-all-of-added-annotation-only"
	ResponseBodyAllOfRemovedAnnotationOnlyId     = "response-body-all-of-removed-annotation-only"
	ResponsePropertyAllOfAddedAnnotationOnlyId   = "response-property-all-of-added-annotation-only"
	ResponsePropertyAllOfRemovedAnnotationOnlyId = "response-property-all-of-removed-annotation-only"
)
View Source 
const (
	ResponseBodyAnyOfAddedId       = "response-body-any-of-added"
	ResponseBodyAnyOfRemovedId     = "response-body-any-of-removed"
	ResponsePropertyAnyOfAddedId   = "response-property-any-of-added"
	ResponsePropertyAnyOfRemovedId = "response-property-any-of-removed"
)
View Source 
const (
	ResponsePropertyBecameNullableId = "response-property-became-nullable"
	ResponseBodyBecameNullableId     = "response-body-became-nullable"
)
View Source 
const (
	ResponsePropertyBecameOptionalId          = "response-property-became-optional"
	ResponseWriteOnlyPropertyBecameOptionalId = "response-write-only-property-became-optional"
)
View Source 
const (
	ResponsePropertyBecameRequiredId          = "response-property-became-required"
	ResponseWriteOnlyPropertyBecameRequiredId = "response-write-only-property-became-required"
)
View Source 
const (
	ResponseBodyConstAddedId       = "response-body-const-added"
	ResponseBodyConstRemovedId     = "response-body-const-removed"
	ResponseBodyConstChangedId     = "response-body-const-changed"
	ResponsePropertyConstAddedId   = "response-property-const-added"
	ResponsePropertyConstRemovedId = "response-property-const-removed"
	ResponsePropertyConstChangedId = "response-property-const-changed"
)
View Source 
const (
	ResponseBodyContainsAddedId            = "response-body-contains-added"
	ResponseBodyContainsRemovedId          = "response-body-contains-removed"
	ResponseBodyMinContainsIncreasedId     = "response-body-min-contains-increased"
	ResponseBodyMinContainsDecreasedId     = "response-body-min-contains-decreased"
	ResponseBodyMaxContainsIncreasedId     = "response-body-max-contains-increased"
	ResponseBodyMaxContainsDecreasedId     = "response-body-max-contains-decreased"
	ResponsePropertyContainsAddedId        = "response-property-contains-added"
	ResponsePropertyContainsRemovedId      = "response-property-contains-removed"
	ResponsePropertyMinContainsIncreasedId = "response-property-min-contains-increased"
	ResponsePropertyMinContainsDecreasedId = "response-property-min-contains-decreased"
	ResponsePropertyMaxContainsIncreasedId = "response-property-max-contains-increased"
	ResponsePropertyMaxContainsDecreasedId = "response-property-max-contains-decreased"
)
View Source 
const (
	ResponseBodyContentSchemaAddedId      = "response-body-content-schema-added"
	ResponseBodyContentSchemaRemovedId    = "response-body-content-schema-removed"
	ResponseBodyContentMediaTypeChangedId = "response-body-content-media-type-changed"
	ResponseBodyContentEncodingChangedId  = "response-body-content-encoding-changed"

	ResponsePropertyContentSchemaAddedId      = "response-property-content-schema-added"
	ResponsePropertyContentSchemaRemovedId    = "response-property-content-schema-removed"
	ResponsePropertyContentMediaTypeChangedId = "response-property-content-media-type-changed"
	ResponsePropertyContentEncodingChangedId  = "response-property-content-encoding-changed"
)
View Source 
const (
	ResponseBodyDefaultValueAddedId       = "response-body-default-value-added"
	ResponseBodyDefaultValueRemovedId     = "response-body-default-value-removed"
	ResponseBodyDefaultValueChangedId     = "response-body-default-value-changed"
	ResponsePropertyDefaultValueAddedId   = "response-property-default-value-added"
	ResponsePropertyDefaultValueRemovedId = "response-property-default-value-removed"
	ResponsePropertyDefaultValueChangedId = "response-property-default-value-changed"
)
View Source 
const (
	ResponseBodyDependentRequiredAddedId       = "response-body-dependent-required-added"
	ResponseBodyDependentRequiredRemovedId     = "response-body-dependent-required-removed"
	ResponseBodyDependentRequiredChangedId     = "response-body-dependent-required-changed"
	ResponsePropertyDependentRequiredAddedId   = "response-property-dependent-required-added"
	ResponsePropertyDependentRequiredRemovedId = "response-property-dependent-required-removed"
	ResponsePropertyDependentRequiredChangedId = "response-property-dependent-required-changed"
)
View Source 
const (
	ResponseBodyDependentSchemaAddedId       = "response-body-dependent-schema-added"
	ResponseBodyDependentSchemaRemovedId     = "response-body-dependent-schema-removed"
	ResponsePropertyDependentSchemaAddedId   = "response-property-dependent-schema-added"
	ResponsePropertyDependentSchemaRemovedId = "response-property-dependent-schema-removed"
)
View Source 
const (
	ResponsePropertyDeprecatedId              = "response-property-deprecated"
	ResponsePropertyDeprecatedWithSunsetId    = "response-property-deprecated-with-sunset"
	ResponsePropertyDeprecatedSunsetMissingId = "response-property-deprecated-sunset-missing"
	ResponsePropertyDeprecatedInvalidId       = "response-property-deprecated-sunset-invalid"
	ResponsePropertyReactivatedId             = "response-property-reactivated"
	ResponsePropertySunsetDateTooSmallId      = "response-property-sunset-date-too-small"
)
View Source 
const (
	ResponsePropertyEnumValueAddedId          = "response-property-enum-value-added"
	ResponseWriteOnlyPropertyEnumValueAddedId = "response-write-only-property-enum-value-added"
)
View Source 
const (
	ResponseBodyIfAddedId       = "response-body-if-added"
	ResponseBodyIfRemovedId     = "response-body-if-removed"
	ResponseBodyThenAddedId     = "response-body-then-added"
	ResponseBodyThenRemovedId   = "response-body-then-removed"
	ResponseBodyElseAddedId     = "response-body-else-added"
	ResponseBodyElseRemovedId   = "response-body-else-removed"
	ResponsePropertyIfAddedId   = "response-property-if-added"
	ResponsePropertyIfRemovedId = "response-property-if-removed"

	ResponsePropertyThenAddedId   = "response-property-then-added"
	ResponsePropertyThenRemovedId = "response-property-then-removed"
	ResponsePropertyElseAddedId   = "response-property-else-added"
	ResponsePropertyElseRemovedId = "response-property-else-removed"
)
View Source 
const (
	ResponseBodyListOfTypesWidenedId      = "response-body-list-of-types-widened"
	ResponseBodyListOfTypesNarrowedId     = "response-body-list-of-types-narrowed"
	ResponsePropertyListOfTypesWidenedId  = "response-property-list-of-types-widened"
	ResponsePropertyListOfTypesNarrowedId = "response-property-list-of-types-narrowed"
)
View Source 
const (
	ResponseBodyMaxIncreasedId              = "response-body-max-increased"
	ResponsePropertyMaxIncreasedId          = "response-property-max-increased"
	ResponseBodyExclusiveMaxIncreasedId     = "response-body-exclusive-max-increased"
	ResponsePropertyExclusiveMaxIncreasedId = "response-property-exclusive-max-increased"
)
View Source 
const (
	ResponseBodyMaxLengthIncreasedId     = "response-body-max-length-increased"
	ResponsePropertyMaxLengthIncreasedId = "response-property-max-length-increased"
)
View Source 
const (
	ResponseBodyMaxLengthUnsetId     = "response-body-max-length-unset"
	ResponsePropertyMaxLengthUnsetId = "response-property-max-length-unset"
)
View Source 
const (
	ResponseBodyMinDecreasedId              = "response-body-min-decreased"
	ResponsePropertyMinDecreasedId          = "response-property-min-decreased"
	ResponseBodyExclusiveMinDecreasedId     = "response-body-exclusive-min-decreased"
	ResponsePropertyExclusiveMinDecreasedId = "response-property-exclusive-min-decreased"
)
View Source 
const (
	ResponseBodyMinItemsDecreasedId     = "response-body-min-items-decreased"
	ResponsePropertyMinItemsDecreasedId = "response-property-min-items-decreased"
)
View Source 
const (
	ResponseBodyMinItemsUnsetId     = "response-body-min-items-unset"
	ResponsePropertyMinItemsUnsetId = "response-property-min-items-unset"
)
View Source 
const (
	ResponseBodyMinLengthDecreasedId     = "response-body-min-length-decreased"
	ResponsePropertyMinLengthDecreasedId = "response-property-min-length-decreased"
)
View Source 
const (
	ResponseBodyOneOfAddedId       = "response-body-one-of-added"
	ResponseBodyOneOfRemovedId     = "response-body-one-of-removed"
	ResponsePropertyOneOfAddedId   = "response-property-one-of-added"
	ResponsePropertyOneOfRemovedId = "response-property-one-of-removed"
)
View Source 
const (
	ResponseBodyPatternPropertyAddedId       = "response-body-pattern-property-added"
	ResponseBodyPatternPropertyRemovedId     = "response-body-pattern-property-removed"
	ResponsePropertyPatternPropertyAddedId   = "response-property-pattern-property-added"
	ResponsePropertyPatternPropertyRemovedId = "response-property-pattern-property-removed"
)
View Source 
const (
	ResponseBodyPrefixItemsAddedId       = "response-body-prefix-items-added"
	ResponseBodyPrefixItemsRemovedId     = "response-body-prefix-items-removed"
	ResponsePropertyPrefixItemsAddedId   = "response-property-prefix-items-added"
	ResponsePropertyPrefixItemsRemovedId = "response-property-prefix-items-removed"
)
View Source 
const (
	ResponseBodyPropertyNamesAddedId       = "response-body-property-names-added"
	ResponseBodyPropertyNamesRemovedId     = "response-body-property-names-removed"
	ResponsePropertyPropertyNamesAddedId   = "response-property-property-names-added"
	ResponsePropertyPropertyNamesRemovedId = "response-property-property-names-removed"
)
View Source 
const (
	ResponseBodyTypeChangedId         = "response-body-type-changed"
	ResponseBodyTypeGeneralizedId     = "response-body-type-generalized"
	ResponseBodyTypeSpecializedId     = "response-body-type-specialized"
	ResponsePropertyTypeChangedId     = "response-property-type-changed"
	ResponsePropertyTypeGeneralizedId = "response-property-type-generalized"
	ResponsePropertyTypeSpecializedId = "response-property-type-specialized"
)
View Source 
const (
	ResponseBodyUnevaluatedItemsAddedId        = "response-body-unevaluated-items-added"
	ResponseBodyUnevaluatedItemsRemovedId      = "response-body-unevaluated-items-removed"
	ResponseBodyUnevaluatedPropertiesAddedId   = "response-body-unevaluated-properties-added"
	ResponseBodyUnevaluatedPropertiesRemovedId = "response-body-unevaluated-properties-removed"

	ResponsePropertyUnevaluatedItemsAddedId        = "response-property-unevaluated-items-added"
	ResponsePropertyUnevaluatedItemsRemovedId      = "response-property-unevaluated-items-removed"
	ResponsePropertyUnevaluatedPropertiesAddedId   = "response-property-unevaluated-properties-added"
	ResponsePropertyUnevaluatedPropertiesRemovedId = "response-property-unevaluated-properties-removed"
)
View Source 
const (
	ResponseRequiredPropertyRemovedId          = "response-required-property-removed"
	ResponseRequiredWriteOnlyPropertyRemovedId = "response-required-write-only-property-removed"
	ResponseRequiredPropertyAddedId            = "response-required-property-added"
	ResponseRequiredWriteOnlyPropertyAddedId   = "response-required-write-only-property-added"
	ResponseBodyWrappedInOneOfId               = "response-body-wrapped-in-one-of"
)
View Source 
const (
	ResponseRequiredPropertyBecameNonWriteOnlyId = "response-required-property-became-not-write-only"
	ResponseRequiredPropertyBecameWriteOnlyId    = "response-required-property-became-write-only"
	ResponseRequiredPropertyBecameReadOnlyId     = "response-required-property-became-read-only"
	ResponseRequiredPropertyBecameNonReadOnlyId  = "response-required-property-became-not-read-only"
)
View Source 
const (
	ResponseSuccessStatusRemovedId    = "response-success-status-removed"
	ResponseNonSuccessStatusRemovedId = "response-non-success-status-removed"
	ResponseSuccessStatusAddedId      = "response-success-status-added"
	ResponseNonSuccessStatusAddedId   = "response-non-success-status-added"
)
View Source 
const (
	WebhookAddedId    = "webhook-added"
	WebhookRemovedId  = "webhook-removed"
	ComponentWebhooks = "webhooks"
)
View Source 
const (
	DefaultBetaDeprecationDays   = uint(0)
	DefaultStableDeprecationDays = uint(0)
)
View Source 
const ComponentSecuritySchemes = "securitySchemes"
View Source 
const DefaultStabilityLevel = StabilityLevelBeta

DefaultStabilityLevel is the default stability level when none is specified. This matches the documented CLI default of "beta".

View Source 
const (
	EndpointAddedId = "endpoint-added"
)
View Source 
const (
	NewRequestPathParameterId = "new-request-path-parameter"
)
View Source 
const (
	NewRequiredRequestHeaderPropertyId = "new-required-request-header-property"
)
View Source 
const (
	RequestBodyBecameEnumId = "request-body-became-enum"
)
View Source 
const (
	RequestBodyEnumValueRemovedId = "request-body-enum-value-removed"
)
View Source 
const (
	RequestBodyRemovedId = "request-body-removed"
)
View Source 
const (
	RequestHeaderPropertyBecameEnumId = "request-header-property-became-enum"
)
View Source 
const (
	RequestHeaderPropertyBecameRequiredId = "request-header-property-became-required"
)
View Source 
const (
	RequestParameterBecameEnumId = "request-parameter-became-enum"
)
View Source 
const (
	RequestParameterMaxLengthSetId = "request-parameter-max-length-set"
)
View Source 
const (
	RequestParameterMinItemsSetId = "request-parameter-min-items-set"
)
View Source 
const (
	RequestParameterXExtensibleEnumValueRemovedId = "request-parameter-x-extensible-enum-value-removed"
)
View Source 
const (
	RequestPropertyBecameEnumId = "request-property-became-enum"
)
View Source 
const (
	RequestPropertyXExtensibleEnumValueRemovedId = "request-property-x-extensible-enum-value-removed"
)
View Source 
const (
	ResponseHeaderAddedId = "response-header-added"
)
View Source 
const (
	ResponseHeaderBecameOptionalId = "response-header-became-optional"
)
View Source 
const (
	ResponseMediaTypeEnumValueRemovedId = "response-mediatype-enum-value-removed"
)
View Source 
const (
	ResponsePropertyEnumValueRemovedId = "response-property-enum-value-removed"
)

Variables

This section is empty.

Functions

func CompareChanges added in v1.11.10 

func CompareChanges(a, b Change) int

func GetAllRuleIds 

func GetAllRuleIds() []string

func GetCheckLevels 

func GetCheckLevels() map[string]Level

GetCheckLevels gets levels for all backward compatibility checks

func GetOptionalRuleIds 

func GetOptionalRuleIds() []string

func GetSeverityLevels 

func GetSeverityLevels(source io.Reader) (map[string]Level, error)

GetSeverityLevels reads severity levels from a reader and returns a map of severity levels

func GetSupportedColorValues 

func GetSupportedColorValues() []string

func GetSupportedStabilityLevels added in v1.20.0 

func GetSupportedStabilityLevels() []string

GetSupportedStabilityLevels returns the list of valid stability level strings.

func IsColorEnabled added in v1.16.0 

func IsColorEnabled(colorMode ColorMode) bool

IsColorEnabled is the exported form of isColorEnabled. Lets oasdiff packages outside checker (validate, future subcommands) gate their own color logic on the same auto-detect + override convention.

func IsDecreased 

func IsDecreased(from any, to any) bool

func IsDecreasedValue 

func IsDecreasedValue(diff *diff.ValueDiff) bool

func IsIncreased 

func IsIncreased(from any, to any) bool

func IsIncreasedValue 

func IsIncreasedValue(diff *diff.ValueDiff) bool

func OperationFieldSources added in v1.12.0 

func OperationFieldSources(operationsSources *diff.OperationsSourcesMap, operationItem *diff.MethodDiff, field string) (*Source, *Source)

OperationFieldSources returns source locations from a specific field within operation Origins. Falls back to operation-level sources when the field is not found in origin data.

func ParameterFieldSources added in v1.12.0 

func ParameterFieldSources(operationsSources *diff.OperationsSourcesMap, operationItem *diff.MethodDiff, paramDiff *diff.ParameterDiff, field string) (*Source, *Source)

ParameterFieldSources returns source locations from a specific field within parameter Origins. Falls back to parameter-level sources when the field is not found in origin data.

func ParameterSources added in v1.12.0 

func ParameterSources(operationsSources *diff.OperationsSourcesMap, operationItem *diff.MethodDiff, paramDiff *diff.ParameterDiff) (*Source, *Source)

parameterSources returns source locations from parameter Origins. Falls back to operation-level sources when parameter origin data is unavailable.

func ProcessSeverityLevels 

func ProcessSeverityLevels(file string) (map[string]Level, error)

ProcessSeverityLevels reads a file with severity levels and returns a map of severity levels

func ResponseSources added in v1.12.0 

func ResponseSources(operationsSources *diff.OperationsSourcesMap, operationItem *diff.MethodDiff, responseDiff *diff.ResponseDiff) (*Source, *Source)

responseSources returns source locations from response Origins. Falls back to operation-level sources when response origin data is unavailable.

func SchemaAddedItemSources added in v1.12.0 

func SchemaAddedItemSources(operationsSources *diff.OperationsSourcesMap, operationItem *diff.MethodDiff, schemaDiff *diff.SchemaDiff, field string, value string) (*Source, *Source)

SchemaAddedItemSources returns source locations for an added sequence item. Base source is nil, revision source points to the specific added item.

func SchemaDeletedItemSources added in v1.12.0 

func SchemaDeletedItemSources(operationsSources *diff.OperationsSourcesMap, operationItem *diff.MethodDiff, schemaDiff *diff.SchemaDiff, field string, value string) (*Source, *Source)

SchemaDeletedItemSources returns source locations for a deleted sequence item. Base source points to the specific deleted item, revision source is nil.

func SchemaFieldSources added in v1.12.0 

func SchemaFieldSources(operationsSources *diff.OperationsSourcesMap, operationItem *diff.MethodDiff, schemaDiff *diff.SchemaDiff, field string) (*Source, *Source)

schemaFieldSources returns source locations from a specific field within schema Origins. Falls back to schema-level sources when the field is not found in origin data.

func SchemaSources added in v1.12.0 

func SchemaSources(operationsSources *diff.OperationsSourcesMap, operationItem *diff.MethodDiff, schemaDiff *diff.SchemaDiff) (*Source, *Source)

schemaSources returns source locations from schema Origins. Falls back to operation-level sources when schema origin data is unavailable.

func SetPipedOutput 

func SetPipedOutput(val *bool) *bool

func SubschemaSources added in v1.15.0 

func SubschemaSources(operationsSources *diff.OperationsSourcesMap, operationItem *diff.MethodDiff, schemaDiff *diff.SchemaDiff, field string, baseIndex, revisionIndex int) (*Source, *Source)

SubschemaSources returns source locations for a specific subschema within an allOf/oneOf/anyOf array. For added subschemas, baseIndex should be -1; for deleted subschemas, revisionIndex should be -1.

Types

type Action 

type Action int8
const (
	ActionAdd Action = iota
	ActionRemove
	ActionChange
	ActionGeneralize
	ActionSpecialize
	ActionIncrease
	ActionDecrease
	ActionSet
	ActionNone
)

func (Action) String added in v1.20.1 

func (a Action) String() string

type ApiChange 

type ApiChange struct {
	CommonChange

	Id          string
	Args        []any
	Comment     string
	Details     string
	Level       Level
	Operation   string
	OperationId string
	Path        string
	Source      *load.Source

	// DEPRECATED: Will be removed after migration to BaseSource/RevisionSource
	SourceFile      string
	SourceLine      int
	SourceLineEnd   int
	SourceColumn    int
	SourceColumnEnd int
}

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

func NewApiChange 

func NewApiChange(id string, config *Config, args []any, comment string, operationsSources *diff.OperationsSourcesMap, operation *openapi3.Operation, method, path string) ApiChange

NewApiChange creates a new ApiChange TODO: use opInfo to simplify the function signature

func (ApiChange) GetArgs 

func (c ApiChange) GetArgs() []any

func (ApiChange) GetComment 

func (c ApiChange) GetComment(l Localizer) string

func (ApiChange) GetId 

func (c ApiChange) GetId() string

func (ApiChange) GetLevel 

func (c ApiChange) GetLevel() Level

func (ApiChange) GetOperation 

func (c ApiChange) GetOperation() string

func (ApiChange) GetOperationId 

func (c ApiChange) GetOperationId() string

func (ApiChange) GetPath 

func (c ApiChange) GetPath() string

func (ApiChange) GetSection 

func (c ApiChange) GetSection() string

func (ApiChange) GetSource 

func (c ApiChange) GetSource() string

func (ApiChange) GetSourceColumn 

func (c ApiChange) GetSourceColumn() int

func (ApiChange) GetSourceColumnEnd 

func (c ApiChange) GetSourceColumnEnd() int

func (ApiChange) GetSourceFile 

func (c ApiChange) GetSourceFile() string

func (ApiChange) GetSourceLine 

func (c ApiChange) GetSourceLine() int

func (ApiChange) GetSourceLineEnd 

func (c ApiChange) GetSourceLineEnd() int

func (ApiChange) GetText 

func (c ApiChange) GetText(l Localizer) string

func (ApiChange) GetUncolorizedText 

func (c ApiChange) GetUncolorizedText(l Localizer) string

func (ApiChange) IsBreaking 

func (c ApiChange) IsBreaking() bool

func (ApiChange) MatchIgnore 

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

func (ApiChange) MultiLineError 

func (c ApiChange) MultiLineError(l Localizer, colorMode ColorMode) string

func (ApiChange) SingleLineError 

func (c ApiChange) SingleLineError(l Localizer, colorMode ColorMode) string

func (ApiChange) WithDetails added in v1.11.9 

func (c ApiChange) WithDetails(details string) ApiChange

WithDetails returns a copy of the ApiChange with Details set

func (ApiChange) WithSources added in v1.12.0 

func (a ApiChange) WithSources(baseSource, revisionSource *Source) ApiChange

WithSources returns a copy of the ApiChange with BaseSource and RevisionSource populated

type Area added in v1.18.3 

type Area int8

Area is the OpenAPI Object a rule concerns, aligned with the OpenAPI spec's object model. 

const (
	AreaSchema Area = iota
	AreaParameters
	AreaRequestBody
	AreaResponses
	AreaPaths
	AreaHeaders
	AreaSecurity
	AreaTags
	AreaComponents
	AreaNone
)

func (Area) String added in v1.20.1 

func (a Area) String() string

type BackwardCompatibilityCheck 

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

BackwardCompatibilityCheck, or a check, is a function that receives a diff report and returns a list of changes

type BackwardCompatibilityChecks 

type BackwardCompatibilityChecks []BackwardCompatibilityCheck

func GetAllChecks 

func GetAllChecks() BackwardCompatibilityChecks

GetAllChecks gets all backward compatibility checks

type BackwardCompatibilityRule 

type BackwardCompatibilityRule struct {
	Id          string
	Level       Level
	Description string
	Handler     BackwardCompatibilityCheck
	Direction   Direction
	Area        Area
	Kind        Kind
	Action      Action
}

type BackwardCompatibilityRules 

type BackwardCompatibilityRules []BackwardCompatibilityRule

func GetAllRules 

func GetAllRules() BackwardCompatibilityRules

func GetOptionalRules 

func GetOptionalRules() BackwardCompatibilityRules

type Change 

type Change interface {
	GetSection() string
	IsBreaking() bool
	GetId() string
	GetText(l Localizer) string
	GetArgs() []any
	GetUncolorizedText(l Localizer) string
	GetComment(l Localizer) string
	GetLevel() Level
	GetOperation() string
	GetOperationId() string
	GetPath() string
	GetSource() string
	GetAttributes() map[string]any

	// Location tracking methods
	GetBaseSource() *Source
	GetRevisionSource() *Source

	// DEPRECATED: Will be removed after GitHubActionsFormatter migration
	GetSourceFile() string
	GetSourceLine() int
	GetSourceLineEnd() int
	GetSourceColumn() int
	GetSourceColumnEnd() int
	MatchIgnore(ignorePath, ignoreLine string, l Localizer) bool
	SingleLineError(l Localizer, colorMode ColorMode) string
	MultiLineError(l Localizer, colorMode ColorMode) string
}

type Changes 

type Changes []Change

func APIAddedCheck 

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

func APIComponentsSchemaRemovedCheck 

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

func APIComponentsSecurityUpdatedCheck 

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 

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 

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 

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

func AddedRequestBodyCheck 

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

func CheckBackwardCompatibility 

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

CheckBackwardCompatibility runs the checks with level WARN and ERR

Example 
package main

import (
	"fmt"
	"os"
	"strings"

	"github.com/getkin/kin-openapi/openapi3"
	"github.com/oasdiff/oasdiff/checker"
	"github.com/oasdiff/oasdiff/diff"
	"github.com/oasdiff/oasdiff/load"
)

func main() {
	loader := openapi3.NewLoader()
	loader.IsExternalRefsAllowed = true

	s1, err := load.NewSpecInfo(loader, load.NewSource("../data/openapi-test1.yaml"))
	if err != nil {
		fmt.Fprintf(os.Stderr, "failed to load spec: %v", err)
		return
	}

	s2, err := load.NewSpecInfo(loader, load.NewSource("../data/openapi-test3.yaml"))
	if err != nil {
		fmt.Fprintf(os.Stderr, "failed to load spec: %v", err)
		return
	}

	diffRes, operationsSources, err := diff.GetPathsDiff(diff.NewConfig(),
		[]*load.SpecInfo{s1},
		[]*load.SpecInfo{s2},
	)

	if err != nil {
		fmt.Fprintf(os.Stderr, "diff failed with %v", err)
		return
	}

	errs := checker.CheckBackwardCompatibility(checker.NewConfig(checker.GetAllChecks()), diffRes, operationsSources)

	// process configuration file for ignoring errors
	errs, err = checker.ProcessIgnoredBackwardCompatibilityErrors(checker.ERR, errs, "../data/ignore-err-example.txt", checker.NewDefaultLocalizer())
	if err != nil {
		fmt.Fprintf(os.Stderr, "ignore errors failed with %v", err)
		return
	}

	// process configuration file for ignoring warnings
	errs, err = checker.ProcessIgnoredBackwardCompatibilityErrors(checker.WARN, errs, "../data/ignore-warn-example.txt", checker.NewDefaultLocalizer())
	if err != nil {
		fmt.Fprintf(os.Stderr, "ignore warnings failed with %v", err)
		return
	}

	// pretty print breaking changes errors
	if len(errs) > 0 {
		localizer := checker.NewDefaultLocalizer()
		count := errs.GetLevelCount()
		fmt.Print(localizer("total-errors", len(errs), count[checker.ERR], "error", count[checker.WARN], "warning"))
		for _, bcerr := range errs {
			fmt.Printf("%s\n\n", strings.TrimRight(bcerr.SingleLineError(localizer, checker.ColorNever), " "))
		}
	}

}

Output:
4 breaking changes: 1 error, 3 warning
error at ../data/openapi-test3.yaml, in API GET /api/{domain}/{project}/badges/security-score removed the success response with the status `201` [response-success-status-removed].

warning at ../data/openapi-test3.yaml, in API GET /api/{domain}/{project}/badges/security-score deleted the `cookie` request parameter `test` [request-parameter-removed]. This is a warning because some clients may return an error when receiving an unexpected parameter. It is recommended to deprecate the parameter first.

warning at ../data/openapi-test3.yaml, in API GET /api/{domain}/{project}/badges/security-score deleted the `header` request parameter `user` [request-parameter-removed]. This is a warning because some clients may return an error when receiving an unexpected parameter. It is recommended to deprecate the parameter first.

warning at ../data/openapi-test3.yaml, in API GET /api/{domain}/{project}/badges/security-score deleted the `query` request parameter `filter` [request-parameter-removed]. This is a warning because some clients may return an error when receiving an unexpected parameter. It is recommended to deprecate the parameter first.

func CheckBackwardCompatibilityUntilLevel 

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

CheckBackwardCompatibilityUntilLevel runs the checks with level equal or higher than the given level. It does not mutate the caller's diffReport; clonePathsDiffForCheck isolates the pipeline's mutation surface.

func MediaTypeSchemaExistenceCheck added in v1.21.0 

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

MediaTypeSchemaExistenceCheck classifies a schema added to, or removed from, a media type that exists on both sides (the media type itself is unchanged, only its schema appears or disappears). The per-schema-change checks skip these one-sided schema diffs (see modifiedSchemaPresentBothSides / #1047), so this check is what reports them, by request/response contravariance: 

request body, schema added   -> breaking (ERR): a body that accepted anything
                                now requires a specific shape (narrowing)
request body, schema removed -> info: the body got more permissive
response, schema added       -> info: the response got more specific
response, schema removed     -> breaking (WARN): a typed response is no longer
                                guaranteed (the output contract loosened)

func NewRequestNonPathDefaultParameterCheck 

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

func NewRequestNonPathParameterCheck 

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 ProcessIgnoredBackwardCompatibilityErrors 

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

func RequestBodyBecameEnumCheck 

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

func RequestBodyEnumValueRemovedCheck 

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

func RequestBodyMediaTypeChangedCheck 

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

func RequestBodyRemovedCheck added in v1.11.2 

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

func RequestBodyRequiredUpdatedCheck 

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

func RequestDiscriminatorUpdatedCheck 

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

func RequestHeaderPropertyBecameEnumCheck 

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 

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

func RequestParameterDefaultValueChangedCheck 

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

func RequestParameterDeprecationCheck 

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

func RequestParameterEnumValueUpdatedCheck 

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

func RequestParameterListOfTypesChangedCheck added in v1.11.6 

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

func RequestParameterMaxItemsUpdatedCheck 

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

func RequestParameterMaxLengthSetCheck 

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

func RequestParameterMaxLengthUpdatedCheck 

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

func RequestParameterMaxSetCheck 

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

func RequestParameterMaxUpdatedCheck 

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

func RequestParameterMinItemsSetCheck 

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

func RequestParameterMinItemsUpdatedCheck 

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

func RequestParameterMinLengthUpdatedCheck 

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

func RequestParameterMinSetCheck 

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

func RequestParameterMinUpdatedCheck 

func RequestParameterMinUpdatedCheck(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 

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

func RequestParameterSunsetChangedCheck 

func RequestParameterSunsetChangedCheck(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 RequestPropertyAllOfUpdatedCheck 

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

func RequestPropertyAnyOfUpdatedCheck 

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

func RequestPropertyBecameEnumCheck 

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

func RequestPropertyBecameNotNullableCheck 

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

func RequestPropertyConstChangedCheck added in v1.15.0 

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

func RequestPropertyContainsUpdatedCheck added in v1.15.0 

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

func RequestPropertyContentUpdatedCheck added in v1.15.0 

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

func RequestPropertyDefaultValueChangedCheck 

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

func RequestPropertyDependentRequiredChangedCheck added in v1.15.0 

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

func RequestPropertyDependentSchemasUpdatedCheck added in v1.15.0 

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

func RequestPropertyDeprecationCheck added in v1.11.9 

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

RequestPropertyDeprecationCheck detects deprecated properties in request bodies

func RequestPropertyEnumValueUpdatedCheck 

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

func RequestPropertyIfUpdatedCheck added in v1.15.0 

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

func RequestPropertyListOfTypesChangedCheck added in v1.11.6 

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

func RequestPropertyMaxDecreasedCheck 

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

func RequestPropertyMaxLengthSetCheck 

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

func RequestPropertyMaxLengthUpdatedCheck 

func RequestPropertyMaxLengthUpdatedCheck(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 RequestPropertyMinLengthUpdatedCheck 

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

func RequestPropertyMinSetCheck 

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

func RequestPropertyOneOfUpdatedCheck 

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

func RequestPropertyPatternPropertiesUpdatedCheck added in v1.15.0 

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

func RequestPropertyPatternUpdatedCheck 

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

func RequestPropertyPrefixItemsUpdatedCheck added in v1.15.0 

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

func RequestPropertyPropertyNamesUpdatedCheck added in v1.15.0 

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

func RequestPropertyRequiredUpdatedCheck 

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

func RequestPropertyStabilityUpdatedCheck added in v1.20.0 

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

RequestPropertyStabilityUpdatedCheck detects request properties where x-stability-level changed. Only emits changes when the property's base stability meets the configured threshold.

func RequestPropertyTypeChangedCheck 

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

func RequestPropertyUnevaluatedUpdatedCheck added in v1.15.0 

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

func RequestPropertyUpdatedCheck 

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

func RequestPropertyWriteOnlyReadOnlyCheck 

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

func RequestPropertyXExtensibleEnumValueRemovedCheck 

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

func ResponseDiscriminatorUpdatedCheck 

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

func ResponseHeaderAddedCheck added in v1.21.0 

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

ResponseHeaderAddedCheck reports a response header that was added. Adding a response header is non-breaking, so it is reported at INFO. It is the mirror of ResponseHeaderRemovedCheck (see #1033).

func ResponseHeaderBecameOptionalCheck 

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

func ResponseHeaderRemovedCheck 

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

func ResponseMediaTypeEnumValueRemovedCheck 

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

func ResponseMediaTypeNameUpdatedCheck added in v1.11.4 

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

func ResponseMediaTypeUpdatedCheck 

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

func ResponseNonSuccessStatusUpdatedCheck 

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

func ResponseOptionalPropertyUpdatedCheck 

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

func ResponseOptionalPropertyWriteOnlyReadOnlyCheck 

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

func ResponseParameterEnumValueRemovedCheck 

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

func ResponsePatternAddedOrChangedCheck 

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

func ResponsePropertyAllOfUpdatedCheck 

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

func ResponsePropertyAnyOfUpdatedCheck 

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

func ResponsePropertyBecameNullableCheck 

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 

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

func ResponsePropertyConstChangedCheck added in v1.15.0 

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

func ResponsePropertyContainsUpdatedCheck added in v1.15.0 

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

func ResponsePropertyContentUpdatedCheck added in v1.15.0 

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

func ResponsePropertyDefaultValueChangedCheck 

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

func ResponsePropertyDependentRequiredChangedCheck added in v1.15.0 

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

func ResponsePropertyDependentSchemasUpdatedCheck added in v1.15.0 

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

func ResponsePropertyDeprecationCheck added in v1.11.9 

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

ResponsePropertyDeprecationCheck detects deprecated properties in response bodies

func ResponsePropertyEnumValueAddedCheck 

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

func ResponsePropertyIfUpdatedCheck added in v1.15.0 

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

func ResponsePropertyListOfTypesChangedCheck added in v1.11.6 

func ResponsePropertyListOfTypesChangedCheck(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 

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

func ResponsePropertyPatternPropertiesUpdatedCheck added in v1.15.0 

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

func ResponsePropertyPrefixItemsUpdatedCheck added in v1.15.0 

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

func ResponsePropertyPropertyNamesUpdatedCheck added in v1.15.0 

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

func ResponsePropertyStabilityUpdatedCheck added in v1.20.0 

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

ResponsePropertyStabilityUpdatedCheck detects response properties where x-stability-level changed. Only emits changes when the property's base stability meets the configured threshold.

func ResponsePropertyTypeChangedCheck 

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

func ResponsePropertyUnevaluatedUpdatedCheck added in v1.15.0 

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

func ResponseRequiredPropertyUpdatedCheck 

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

func ResponseRequiredPropertyWriteOnlyReadOnlyCheck 

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

func ResponseSuccessStatusUpdatedCheck 

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

func WebhookUpdatedCheck added in v1.15.0 

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

func (Changes) GetLevelCount 

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

func (Changes) HasLevelOrHigher 

func (changes Changes) HasLevelOrHigher(level Level) bool

type ColorMode 

type ColorMode int
const (
	ColorAlways ColorMode = iota
	ColorNever
	ColorAuto
	ColorInvalid
)

func NewColorMode 

func NewColorMode(color string) (ColorMode, error)

type CommonChange 

type CommonChange struct {
	// Location information for correlation UI
	BaseSource     *Source // Location in base (original) file
	RevisionSource *Source // Location in revision (modified) file

	Attributes map[string]any
}

func (CommonChange) GetAttributes 

func (c CommonChange) GetAttributes() map[string]any

func (CommonChange) GetBaseSource added in v1.12.0 

func (c CommonChange) GetBaseSource() *Source

func (CommonChange) GetRevisionSource added in v1.12.0 

func (c CommonChange) GetRevisionSource() *Source

type ComponentChange 

type ComponentChange struct {
	CommonChange

	Id        string
	Args      []any
	Comment   string
	Level     Level
	Component string

	// DEPRECATED: Will be removed after migration to BaseSource/RevisionSource
	SourceFile      string
	SourceLine      int
	SourceLineEnd   int
	SourceColumn    int
	SourceColumnEnd int
}

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

func (ComponentChange) GetArgs 

func (c ComponentChange) GetArgs() []any

func (ComponentChange) GetComment 

func (c ComponentChange) GetComment(l Localizer) string

func (ComponentChange) GetId 

func (c ComponentChange) GetId() string

func (ComponentChange) GetLevel 

func (c ComponentChange) GetLevel() Level

func (ComponentChange) GetOperation 

func (ComponentChange) GetOperation() string

func (ComponentChange) GetOperationId 

func (ComponentChange) GetOperationId() string

func (ComponentChange) GetPath 

func (ComponentChange) GetPath() string

func (ComponentChange) GetSection 

func (c ComponentChange) GetSection() string

func (ComponentChange) GetSource 

func (c ComponentChange) GetSource() string

func (ComponentChange) GetSourceColumn 

func (c ComponentChange) GetSourceColumn() int

func (ComponentChange) GetSourceColumnEnd 

func (c ComponentChange) GetSourceColumnEnd() int

func (ComponentChange) GetSourceFile 

func (c ComponentChange) GetSourceFile() string

func (ComponentChange) GetSourceLine 

func (c ComponentChange) GetSourceLine() int

func (ComponentChange) GetSourceLineEnd 

func (c ComponentChange) GetSourceLineEnd() int

func (ComponentChange) GetText 

func (c ComponentChange) GetText(l Localizer) string

func (ComponentChange) GetUncolorizedText 

func (c ComponentChange) GetUncolorizedText(l Localizer) string

func (ComponentChange) IsBreaking 

func (c ComponentChange) IsBreaking() bool

func (ComponentChange) MatchIgnore 

func (c ComponentChange) MatchIgnore(ignorePath, ignoreLine string, l Localizer) bool

func (ComponentChange) MultiLineError 

func (c ComponentChange) MultiLineError(l Localizer, colorMode ColorMode) string

func (ComponentChange) SingleLineError 

func (c ComponentChange) SingleLineError(l Localizer, colorMode ColorMode) string

func (ComponentChange) WithSources added in v1.12.0 

func (c ComponentChange) WithSources(baseSource, revisionSource *Source) ComponentChange

WithSources returns a copy of the ComponentChange with BaseSource and RevisionSource populated

type Config 

type Config struct {
	Checks              BackwardCompatibilityChecks
	MinSunsetBetaDays   uint
	MinSunsetStableDays uint
	LogLevels           map[string]Level
	Attributes          []string
	StabilityLevel      StabilityLevel
}

func NewConfig 

func NewConfig(checks BackwardCompatibilityChecks, opts ...Option) *Config

NewConfig creates a new configuration with default values, then applies the given options in order.

type Direction 

type Direction int8
const (
	DirectionRequest Direction = iota
	DirectionResponse
	DirectionNone
)

func (Direction) String added in v1.20.1 

func (d Direction) String() string

type Kind added in v1.18.3 

type Kind int8

Kind is the aspect of the API contract a rule concerns, orthogonal to Area. 

const (
	KindExistence Kind = iota
	KindRequiredness
	KindMutability
	KindType
	KindConstraints
	KindValues
	KindStructure
	KindLifecycle
	KindNone
)

func (Kind) String added in v1.20.1 

func (k Kind) String() string

type Level 

type Level int
const (
	ERR     Level = 3
	WARN    Level = 2
	INFO    Level = 1
	NONE    Level = 0
	INVALID Level = -1
)

func NewLevel 

func NewLevel(level string) (Level, error)

func (Level) IsBreaking 

func (level Level) IsBreaking() bool

func (Level) PrettyString 

func (level Level) PrettyString() string

func (Level) String 

func (level Level) String() string

func (Level) StringCond 

func (level Level) StringCond(colorMode ColorMode) string

type Localizer 

type Localizer func(key string, args ...any) string

func NewDefaultLocalizer 

func NewDefaultLocalizer() Localizer

func NewLocalizer 

func NewLocalizer(locale string) Localizer

type Option added in v1.15.3 

type Option func(*Config)

Option configures a Config during NewConfig. Options compose: each receives the Config after defaults and prior options have been applied. Use the With* constructors below to obtain Options.

func WithAttributes added in v1.15.3 

func WithAttributes(attributes []string) Option

WithAttributes sets the list of attributes to be used.

func WithChecks added in v1.15.3 

func WithChecks(checks BackwardCompatibilityChecks) Option

WithChecks sets the list of checks to be used (replaces the constructor's checks argument).

func WithDeprecation added in v1.15.3 

func WithDeprecation(deprecationDaysBeta uint, deprecationDaysStable uint) Option

WithDeprecation sets the number of days before sunset for deprecation warnings.

func WithOptionalCheck added in v1.15.3 

func WithOptionalCheck(id string) Option

WithOptionalCheck adds a single check to the list of optional checks.

func WithOptionalChecks added in v1.15.3 

func WithOptionalChecks(ids []string) Option

WithOptionalChecks overrides the log level of the given checks to ERR so they will appear in `oasdiff breaking`.

func WithSeverityLevels added in v1.15.3 

func WithSeverityLevels(severityLevels map[string]Level) Option

WithSeverityLevels overrides per-check log levels from the given map.

func WithSingleCheck added in v1.15.3 

func WithSingleCheck(check BackwardCompatibilityCheck) Option

WithSingleCheck sets a single check to be used (replaces the constructor's checks argument).

func WithStabilityLevel added in v1.20.0 

func WithStabilityLevel(level string) Option

WithStabilityLevel sets the minimum stability level from a string. If the level is empty, the config is unchanged.

type SecurityChange 

type SecurityChange struct {
	CommonChange

	Id      string
	Args    []any
	Comment string
	Level   Level

	// DEPRECATED: Will be removed after migration to BaseSource/RevisionSource
	SourceFile      string
	SourceLine      int
	SourceLineEnd   int
	SourceColumn    int
	SourceColumnEnd int
}

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

func (SecurityChange) GetArgs 

func (c SecurityChange) GetArgs() []any

func (SecurityChange) GetComment 

func (c SecurityChange) GetComment(l Localizer) string

func (SecurityChange) GetId 

func (c SecurityChange) GetId() string

func (SecurityChange) GetLevel 

func (c SecurityChange) GetLevel() Level

func (SecurityChange) GetOperation 

func (r SecurityChange) GetOperation() string

func (SecurityChange) GetOperationId 

func (SecurityChange) GetOperationId() string

func (SecurityChange) GetPath 

func (SecurityChange) GetPath() string

func (SecurityChange) GetSection 

func (c SecurityChange) GetSection() string

func (SecurityChange) GetSource 

func (c SecurityChange) GetSource() string

func (SecurityChange) GetSourceColumn 

func (c SecurityChange) GetSourceColumn() int

func (SecurityChange) GetSourceColumnEnd 

func (c SecurityChange) GetSourceColumnEnd() int

func (SecurityChange) GetSourceFile 

func (c SecurityChange) GetSourceFile() string

func (SecurityChange) GetSourceLine 

func (c SecurityChange) GetSourceLine() int

func (SecurityChange) GetSourceLineEnd 

func (c SecurityChange) GetSourceLineEnd() int

func (SecurityChange) GetText 

func (c SecurityChange) GetText(l Localizer) string

func (SecurityChange) GetUncolorizedText 

func (c SecurityChange) GetUncolorizedText(l Localizer) string

func (SecurityChange) IsBreaking 

func (c SecurityChange) IsBreaking() bool

func (SecurityChange) MatchIgnore 

func (c SecurityChange) MatchIgnore(ignorePath, ignoreLine string, l Localizer) bool

func (SecurityChange) MultiLineError 

func (c SecurityChange) MultiLineError(l Localizer, colorMode ColorMode) string

func (SecurityChange) SingleLineError 

func (c SecurityChange) SingleLineError(l Localizer, colorMode ColorMode) string

func (SecurityChange) WithSources added in v1.12.0 

func (c SecurityChange) WithSources(baseSource, revisionSource *Source) SecurityChange

WithSources returns a copy of the SecurityChange with BaseSource and RevisionSource populated

type Source added in v1.12.0 

type Source struct {
	File   string `json:"file,omitempty" yaml:"file,omitempty"`     // File path (relative or absolute)
	Line   int    `json:"line,omitempty" yaml:"line,omitempty"`     // Line number (1-based)
	Column int    `json:"column,omitempty" yaml:"column,omitempty"` // Column number (1-based)
}

Source represents the location of a change in an OpenAPI spec file

func NewEmptySource added in v1.12.0 

func NewEmptySource() *Source

func NewSource added in v1.12.0 

func NewSource(file string, line int, column int) *Source

func NewSourceFromField added in v1.12.0 

func NewSourceFromField(operationsSources *diff.OperationsSourcesMap, operation *openapi3.Operation, origin *openapi3.Origin, field string) *Source

func NewSourceFromOrigin added in v1.12.0 

func NewSourceFromOrigin(operationsSources *diff.OperationsSourcesMap, operation *openapi3.Operation, origin *openapi3.Origin) *Source

func NewSourceFromSequenceItem added in v1.12.0 

func NewSourceFromSequenceItem(operationsSources *diff.OperationsSourcesMap, operation *openapi3.Operation, origin *openapi3.Origin, field string, value string) *Source

NewSourceFromSequenceItem returns the source location of a specific item in a sequence-valued field (e.g. type: [string, null]). It looks up the item by value in Origin.Sequences[field]. If multiple items share the same value, it returns the first match.

func SchemaMapItemSource added in v1.15.0 

func SchemaMapItemSource(operationsSources *diff.OperationsSourcesMap, operation *openapi3.Operation, schemas openapi3.Schemas, name string) *Source

SchemaMapItemSource returns the source location for a named schema within a Schemas map (e.g., a specific key in dependentSchemas, patternProperties, or properties). It uses the schema's own Origin rather than the parent field's origin.

type StabilityLevel added in v1.20.0 

type StabilityLevel int

StabilityLevel represents a threshold for filtering operations by their x-stability-level. Higher values include more stability levels (e.g., StabilityLevelDraft includes all levels). The enum is a pure ordering: level >= threshold means "included." 

const (
	// StabilityLevelDraft includes all operations (stable, beta, alpha, and draft).
	StabilityLevelDraft StabilityLevel = iota + 1
	// StabilityLevelAlpha includes stable, beta, and alpha operations.
	StabilityLevelAlpha
	// StabilityLevelBeta includes stable and beta operations.
	StabilityLevelBeta
	// StabilityLevelStable includes only stable operations.
	StabilityLevelStable
)

func ParseStabilityLevel added in v1.20.0 

func ParseStabilityLevel(s string) StabilityLevel

ParseStabilityLevel converts a stability string to a StabilityLevel. An empty string is treated as stable (implicit stable).

func (StabilityLevel) IsIncluded added in v1.20.0 

func (sl StabilityLevel) IsIncluded(stability string) bool

IsIncluded returns true if the given stability label meets the configured threshold. For example, if the threshold is StabilityLevelDraft, all levels are included. If the threshold is StabilityLevelAlpha, draft is excluded but alpha/beta/stable are included. An empty stability string is treated as "stable".

Source Files

View all Source files

Directories

Path Synopsis
Package generator generates consistent breaking change and changelog message definitions.
 Package generator generates consistent breaking change and changelog message definitions.
Package localizations provides localized messages for breaking change and changelog output.
 Package localizations provides localized messages for breaking change and changelog output.

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.