fix: ingore violations from invalid locations of an api definition #716
Conversation
This file contains 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
Some extensions in an API definition, like those providing SDK-related metadata, are not valid places to check for rule violations. Since some built-in, Spectral rules use broad JSON paths for their rules, it is possible for them to report false positives within extension objects, even when the extension objects contain information that is completely unrelated to the rule (like the typed-enum rule). To avoid this in a generic way, this change filters out any rule violations that occur within our internal, SDK-related metadata extension and provides for any potential locations that may be added in the future. Signed-off-by: Dustin Popp <[email protected]>
|
We may want to do something like this at some point, but right now the only rule tripped up by the metadata is Spectral's Closing this in favor of #719 |
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.
PR summary
Some extensions in an API definition, like those providing SDK-related metadata, are not valid places to check for rule violations.
Since some built-in, Spectral rules use broad JSON paths for their rules, it is possible for them to report false positives within extension objects, even when the extension objects contain information that is completely unrelated to the rule (like the typed-enum rule).
To avoid this in a generic way, this change filters out any rule violations that occur within our internal, SDK-related metadata extension and provides for any potential locations that may be added in the future.
PR Checklist
General checklist
Please make sure that your PR fulfills the following requirements:
.secrets.baselinehas been updated as needednpm run generate-utilities-docshas been run if any files inpackages/utilities/srchave been updated