website/docs: Fix documentation about attribute merging for indirect membership#12168
Merged
tanberry merged 1 commit intogoauthentik:mainfrom Nov 26, 2024
Merged
website/docs: Fix documentation about attribute merging for indirect membership#12168tanberry merged 1 commit intogoauthentik:mainfrom
tanberry merged 1 commit intogoauthentik:mainfrom
Conversation
…membership While for role memberships, it is true that they are only applied for _direct_ memberships, this does not appear to be the case for attributes (which is good as this also follows the "Hierarchy" system documented in the same file). In terms of the implementation, this is the case due to the call to `all_groups()` in https://github.com/goauthentik/authentik/blob/3d5a189fa732ef462dbbd73b88c128ebaf1833f9/authentik/core/models.py#L312-L313, introduced in goauthentik#6017. Looking through the files in there, it is clear that this line in the documentation is from before that point: https://github.com/goauthentik/authentik/blob/95e60a035df11d6f89db18cba3ae978d13d212b8/website/docs/user-group/group.md?plain=1#L15. tl;dr: the documentation was correct before goauthentik#6017, but is now out of date. This change fixes that. Signed-off-by: Zuri Klaschka <pklaschka@users.noreply.github.com>
✅ Deploy Preview for authentik-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for authentik-storybook canceled.
|
Contributor
|
Thanks very much @pklaschka for this catch! And for the link to #6017. We appreciate you helping us keep the Docs up-to-date! |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #12168 +/- ##
==========================================
- Coverage 92.67% 92.50% -0.17%
==========================================
Files 761 761
Lines 38025 38025
==========================================
- Hits 35239 35175 -64
- Misses 2786 2850 +64
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
tanberry
approved these changes
Nov 26, 2024
kensternberg-authentik
added a commit
that referenced
this pull request
Nov 26, 2024
* main: website/docs: Add note about single group per role (#12169) website/docs: Fix documentation about attribute merging for indirect membership (#12168) root: support running authentik in subpath (#8675) docs: fix contribution link (#12189) core, web: update translations (#12190) core: Bump msgraph-sdk from 1.12.0 to 1.13.0 (#12191) core: Bump selenium from 4.26.1 to 4.27.0 (#12192)
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.
tl;dr: the documentation about how attributes get merged was correct before #6017, but is now out of date. This change fixes that.
Details
While for role memberships, it is true that they are only applied for direct memberships, this does not appear to be the case for attributes (which is good as this also follows the "Hierarchy" system documented in the same file).
In terms of the implementation, this is the case due to the call to
all_groups()inauthentik/authentik/core/models.py
Lines 312 to 313 in 3d5a189
authentik/website/docs/user-group/group.md
Line 15 in 95e60a0
Checklist
ak test authentik/)make lint-fix)If an API change has been made
make gen-build)If changes to the frontend have been made
make web)If applicable
make website)