Merged
Conversation
…tive RequiredRoles and RequiredPermissions
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors route authorization to support declarative role checks via OpenAPIOptions.RequiredRoles, adds a WithRoles helper, and exposes required roles in generated OpenAPI as an extension.
Changes:
- Add
RequiredRolestoOpenAPIOptionsand aWithRoles(...)helper for composing role requirements. - Enforce required roles during request parsing/authorization and include
x-required-rolesin the generated OpenAPI operation objects. - Add tests validating role enforcement and OpenAPI extension output; update the auth example to use declarative roles.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
types.go |
Adds RequiredRoles to operation options and modernizes some interface{} types to any. |
fiberoapi.go |
Emits x-required-roles OpenAPI extension per operation. |
common.go |
Invokes role validation during request parsing when authorization is enabled. |
auth.go |
Introduces validateRequiredRoles helper for role enforcement. |
auth_helpers.go |
Adds WithRoles helper for appending required roles. |
auth_test.go |
Adds tests for role enforcement and OpenAPI extension emission. |
_examples/auth/main.go |
Updates example routes to use RequiredRoles/RequiredPermissions instead of manual checks. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
…uthorization call
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.
Enhance route authorization by implementing declarative role checks using
RequiredRoles. Introduce theWithRoleshelper function for appending roles, validate roles in the input parsing, and update OpenAPI specifications to include required roles. Add comprehensive tests for the new functionality.