fix: narrow tags-should-be-in-sentence-case Spectral rule to avoid false positives#1635
Open
PedroAntunesCosta wants to merge 1 commit intomasterfrom
Open
fix: narrow tags-should-be-in-sentence-case Spectral rule to avoid false positives#1635PedroAntunesCosta wants to merge 1 commit intomasterfrom
PedroAntunesCosta wants to merge 1 commit intomasterfrom
Conversation
|
Thanks for your contribution. The .json file will be checked now with Spectral. |
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.
Fixes false positives in the
tags-should-be-in-sentence-caseSpectral rule that were triggered by response body schema properties namedtags.Changes
$..tags[*]with two specific paths:$.tags[*].name— targets root-level OpenAPI tag definitions$.paths.*.*.tags[*]— targets operation-level tag referencestagsin response bodiesWhy
The recursive descent operator (
$..) matched ANY property namedtagsanywhere in the document, including response body schema properties that describe an API'stagsfield. This caused false positive errors during portal builds (e.g., in the Custom Fields API schema).