Skip to content

feat(core): add asyncapi-operation-security-defined lint rule#2759

Open
harshit078 wants to merge 23 commits intoRedocly:mainfrom
harshit078:add-asyncapi-rule
Open

feat(core): add asyncapi-operation-security-defined lint rule#2759
harshit078 wants to merge 23 commits intoRedocly:mainfrom
harshit078:add-asyncapi-rule

Conversation

@harshit078
Copy link
Copy Markdown
Contributor

@harshit078 harshit078 commented Apr 21, 2026

What/Why/How?

  • Added asyncapi-operation-security-defined rule for AsyncAPI 2.x which reports when a security scheme referenced from an operation or server security array is not defined in ``components.securitySchemes.

Reference

#2667

Testing

Screenshots (optional)

Check yourself

  • This PR follows the contributing guide
  • All new/updated code is covered by tests
  • Core code changed? - Tested with other Redocly products (internal contributions only)
  • New package installed? - Tested in different environments (browser/node)
  • Documentation update has been considered

Security

  • The security impact of the change has been considered
  • Code follows company security practices and guidelines

Note

Medium Risk
Introduces a new built-in lint rule and enables it by default in AsyncAPI minimal/recommended configs, which may surface new errors/warnings in existing AsyncAPI projects after upgrade.

Overview
Adds a new AsyncAPI lint rule, security-defined, that reports when an operation/server security entry references a scheme not defined in components.securitySchemes (AsyncAPI 2.x) or when an AsyncAPI 3.0 security $ref either points outside #/components/securitySchemes or resolves to an undefined scheme.

Registers the rule for both async2 and async3, adds test coverage, and enables it across the built-in minimal, recommended, recommended-strict, spec, and all config presets (plus config snapshot updates). Documentation is updated to list the rule, add a dedicated rule page, include it in ruleset templates/sidebars, and publish a changeset.

Reviewed by Cursor Bugbot for commit bf96d18. Bugbot is set up for automated code reviews on this repo. Configure here.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 21, 2026

🦋 Changeset detected

Latest commit: bf96d18

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
@redocly/openapi-core Minor
@redocly/cli Minor
@redocly/respect-core Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@harshit078 harshit078 changed the title feat: Add asyncapi-operation-security-defined lint rule feat(core): Add asyncapi-operation-security-defined lint rule Apr 24, 2026
@harshit078 harshit078 marked this pull request as ready for review April 24, 2026 07:51
@harshit078 harshit078 requested review from a team as code owners April 24, 2026 07:51
@harshit078 harshit078 changed the title feat(core): Add asyncapi-operation-security-defined lint rule feat(core): add asyncapi-operation-security-defined lint rule Apr 24, 2026
Copy link
Copy Markdown
Contributor

@vadyvas vadyvas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest a slightly different approach:

  1. keep the AsyncAPI logic separate and do not reuse shared logic from the OAS rule
  2. use the same rule name, security-defined, for AsyncAPI as well, and register the AsyncAPI implementation in the AsyncAPI ruleset
  3. do not update the v1 docs in this PR

I think this would make the change smaller, clearer, and safer.

Thank you for the contribution, overall the PR looks good

Comment thread packages/core/src/rules/async2/asyncapi-operation-security-defined.ts Outdated
Comment thread packages/core/src/rules/common/security-scheme-references.ts Outdated
Comment thread packages/core/src/rules/async2/index.ts Outdated
Comment thread docs/@v1/guides/lint-asyncapi.md Outdated
Comment thread packages/core/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap Outdated
@harshit078 harshit078 requested a review from vadyvas April 30, 2026 12:45
Copy link
Copy Markdown
Contributor

@vadyvas vadyvas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left a few comments, could you take a look?

'info-contact': InfoContact as Async2Rule,
'info-license-strict': InfoLicenseStrict as Async2Rule,
'operation-operationId': OperationOperationId as Async2Rule,
'security-defined': SecurityDefined,
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add support for AsyncAPI 3 as well. Right now the rule only applies to AsyncAPI2

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay sure !

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code uses the rule name security-defined, but the docs still say asyncapi-operation-security-defined
Can you update related changes?

@@ -0,0 +1,83 @@
# asyncapi-operation-security-defined
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please don’t add this rule to the v1 docs

Comment thread docs/@v1/v1.sidebars.yaml Outdated
Comment thread packages/core/src/rules/async2/index.ts
Comment thread docs/@v2/rules/async/security-defined.md
Comment thread docs/@v1/rules/built-in-rules.md Outdated
Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 2 potential issues.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 75bf960. Configure here.

Comment thread packages/core/src/rules/async3/security-defined.ts
Comment thread docs/@v1/rules/ruleset-templates.md Outdated
@harshit078 harshit078 requested a review from vadyvas May 6, 2026 10:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants