fix(api): include required scope in API key 403 error messages - #528
Open
Ayomide3271 wants to merge 1 commit into
Open
fix(api): include required scope in API key 403 error messages#528Ayomide3271 wants to merge 1 commit into
Ayomide3271 wants to merge 1 commit into
Conversation
Make ApiKeyScopeGuard 403 responses indicate which scope was required. The missing-scope path previously returned an opaque message, and the insufficient-scope path now shares a consistent message builder. Fixes Ignition-World#440
|
@Ayomide3271 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
1 participant
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.
Description
Closes #440
The
ApiKeyScopeGuard403 responses were opaque — they did not indicate which scope was required. Specifically, when a request reached a@RequireScope(...)route without an attached API key scope, the guard returned a generic403("API key scope information is missing") that named no required scope at all.This change makes every 403 raised by API key scope enforcement identify the required scope:
API key is missing a scope. Required: write.API key scope 'read' is insufficient. Required: write.Changes
ignition-api/src/api-keys/api-key-scope.guard.ts— the missing-scope error now includes the required scope(s); the insufficient-scope error shares the same message builder.ignition-api/src/api-keys/api-key-scope.guard.spec.ts— added regression tests asserting the 403 message names the required scope in both the missing-user and missing-scope cases.Testing
ApiKeyScopeGuardunit tests: 10/10 passPR Checklist