feat(validation): check x-correlator documentation - #376
Merged
hdamker merged 2 commits intoJul 16, 2026
Conversation
hdamker
reviewed
Jul 15, 2026
hdamker
reviewed
Jul 15, 2026
hdamker
left a comment
Contributor
There was a problem hiding this comment.
Thanks @LarryHu0217 — good implementation of #371. The external $ref resolution and the callback coverage match the proposal, and the regression tests are thorough. One small suggestion inline to keep the ruleset header changelog complete.
hdamker
approved these changes
Jul 16, 2026
hdamker
left a comment
Contributor
There was a problem hiding this comment.
LGTM (EasyCLA status clarified as well)
This was referenced Jul 16, 2026
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?
enhancement/feature
What this PR does / why we need it:
Adds two warning-level Spectral rules that require every regular and callback operation to document the
x-correlatorrequest header parameter and every documented response to expose the corresponding response header. The custom function honors path-level parameters and Spectral-resolved local or external references.Which issue(s) this PR fixes:
Fixes #371
Special notes for reviewers:
The focused regression coverage includes inline definitions, path-level inheritance, local component references, external references, success and error responses, and callbacks.
Test evidence:
python -m pytest validation/tests tooling_lib/tests -q(1214 passed, 4 skipped)node --check linting/config/lint_function/*.jsnpm ci --ignore-scriptsusing the repository-required npm 11.13.0Changelog input
Additional documentation