chore: add reference links for common build-in rules#2839
chore: add reference links for common build-in rules#2839DmitryAnansky wants to merge 9 commits into
Conversation
|
|
DmitryAnansky
force-pushed
the
chore/add-reference-links-for-common-rules
branch
from
5f050b8 to
3c75048
Compare
|
📦 A new experimental 🧪 version v0.0.0-snapshot.1779977489 of Redocly CLI has been published for testing. Install with NPM: npm install @redocly/cli@0.0.0-snapshot.1779977489
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1779977489
# or
npm install @redocly/respect-core@0.0.0-snapshot.1779977489 |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 4928a50. Configure here.
tatomyr
changed the title
tatomyr
changed the title
3 participants
What/Why/How?
Reference
#2734
Testing
Screenshots (optional)
Check yourself
Security
Note
Low Risk
Mostly additive metadata on lint output and doc/test updates; behavior of rule logic is unchanged aside from optional reference URLs on reports.
Overview
Lint findings from built-in rules now include a
referenceURL pointing to the matching Redocly docs page (OAS, Async, Arazzo, and Respect rules). Shared helpers such asvalidateExample,validateMimeType,validateDefinedAndNonEmpty, andvalidateResponseCodeswere updated to take options objects so callers can pass that link through consistently.Documentation fixes correct typos in slugs and rule names:
request-mime-type(was “mine”) andx-security-scheme-required-values(was “schema”), with config examples and source links aligned. Test snapshots were updated to expect the newreferencefield on reported problems.Reviewed by Cursor Bugbot for commit 3ba393b. Bugbot is set up for automated code reviews on this repo. Configure here.