feat: treat experimental apiKind identically to no-BWC in compatibility scope#88
Open
makeev-pavel wants to merge 1 commit into
Open
feat: treat experimental apiKind identically to no-BWC in compatibility scope#88makeev-pavel wants to merge 1 commit into
makeev-pavel wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Treat
x-api-kind: experimentalidentically tox-api-kind: no-BWCwhen classifying API changes. Operations and channels marked asexperimentalnow produce risky (instead of breaking) changes in both REST and AsyncAPI compatibility scopes.Changes
Source code (3 files, ~30 lines):
src/consts.ts— addedisNoBwcOrExperimentalhelpersrc/components/compare/rest.bwc.validation.ts— replaced direct=== NO_BWCchecks withisNoBwcOrExperimental(), added predicate-basedcheckAllMethodsMatchApiKindto handle mixed apiKind within a single pathItem (e.g. GET=no-BWC, POST=experimental)src/components/compare/async.bwc.validation.ts— updatedtoApiCompatibilityKindto treat experimental the same as no-BWCTests (3 files, +133 tests):
test/apiKinds.test.ts— experimental-only (labels, info, operation, remove), mixed no-BWC/experimental, mixed apiKind within pathItemtest/asyncapi-build-apikind.test.ts—calculateAsyncApiKindunit tests for experimental and mixedtest/asyncapi-changelog-apikind.test.ts— full experimental coverage across all scopes (root, channel, operation), all change types (remove operation/channel/message, modify payload)Fixtures (22 YAML files):