fix(validation): allow Design Guide filter suffixes in parameter casing#389
Merged
hdamker merged 1 commit intoJul 23, 2026
Merged
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.
What type of PR is this?
bug
What this PR does / why we need it:
camara-parameter-name-casing-conventionin the r4 ruleset (linting/config/.spectral-r4.yaml) requires query/path parameter names to match^[a-z][a-zA-Z0-9]*$, with no allowance for the filtering-operation suffixes the Design Guide §4.3.2 requires (.gte,.gt,.lte,.lt). Any spec following the Design Guide's own filtering examples verbatim (e.g.creationDate.gte) gets a false-positive warning.Fix: the pattern now allows those four suffixes as an optional exact tail —
^[a-z][a-zA-Z0-9]*(\.(gte|gt|lte|lt))?$. The base name still has to be lowerCamelCase, and an unrecognized suffix or a badly-cased base name still gets flagged. Scoped to the r4 ruleset only —.spectral-r3.4.yamldoesn't define this rule.Which issue(s) this PR fixes:
Fixes #388
Special notes for reviewers:
Added test coverage in
validation/tests/test_spectral_gap_rules.py: all four suffixes passing, an unrecognized suffix still failing, and a badly-cased base name with a valid suffix still failing. Fullvalidation/tests/suite (1216 tests) passes locally.Changelog input
Additional documentation
This section can be blank.