fix(err): filter false-positive ExampleElement mutually exclusive resolver errors#10822
Open
maruthang wants to merge 1 commit intoswagger-api:masterfrom
Open
fix(err): filter false-positive ExampleElement mutually exclusive resolver errors#10822maruthang wants to merge 1 commit intoswagger-api:masterfrom
maruthang wants to merge 1 commit intoswagger-api:masterfrom
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.
Description
Added an
ExampleMutuallyExclusiveerror transformer that filters out false-positive resolver errors where apidom-reference incorrectly reports "ExampleElement value and externalValue fields are mutually exclusive" when onlyexternalValueis present. The transformer is registered in the error transformer hook alongside the existingnot-of-typeandparameter-oneoftransformers.Motivation and Context
Fixes #10418
When a spec uses
$refat the path level and the referenced file contains examples withexternalValue, the upstream apidom-reference library throws a false-positive mutual exclusivity error. This causes Swagger UI to display a spurious error message to users even though their spec is valid. This fix suppresses those false-positive errors at the error transformer layer, following the same pattern already used for other known false-positive errors.How Has This Been Tested?
test/unit/core/plugins/err/transformers/example-mutually-exclusive.js:Screenshots (if appropriate):
N/A - no UI changes.
Checklist
My PR contains...
src/is unmodified: changes to documentation, CI, metadata, etc.)package.json)My changes...
Documentation
Automated tests