Repository navigation
fix: inherit root-level OpenAPI security requirements - #1157
Merged
Merged
Conversation
Use root-level security when an operation has no declaration, so the request console sends configured credentials for inherited requirements. Preserve explicit overrides, public operations and optional authentication. Add parser regression tests for inheritance, overrides and absent requirements.
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
2 participants
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.
Problem
Operations that inherit root-level OpenAPI
securityare shown as not requiringauthentication. Their Try requests omit the configured credentials because
groupByTags()copies only the operation-level declaration.Observed with npm
rapidoc@10.1.0and confirmed in current master.Fix
Use
pathOrHookObj.security ?? openApiSpec.securitywhen grouping operations.Explicit operation overrides remain unchanged, including
security: []forpublic operations and an empty object permitting optional authentication.
If neither level declares security, the existing behavior is preserved.
This follows the OpenAPI Operation Object security contract.
Tests
Five parser regression cases cover inherited requirements, public operations,
overrides, optional authentication and absent requirements. The inheritance case
fails on unpatched master and passes with the fix.
All 129 unit tests pass:
node --test --test-isolation=none tests/unit/*.test.jsThe isolation flag is used for the local sandbox; tests use the existing Node
test framework and are included by the standard
test:unitglob. Dependencieswere reused from an existing installation. A full production build was not run.