opendev/gerrit
Code Issues Proposed changes

Document GetGroups class

Browse Source 
Change-Id: Iaf18eac6e7885b261ccf407ec51cbff23508fb54
Signed-off-by: Edwin Kempin <ekempin@google.com>
This commit is contained in:
Edwin Kempin
2019-12-27 12:48:02 +01:00
committed by David Pursehouse
parent f93dfe0701
commit 03b28c5758
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
java/com/google/gerrit/server/restapi/account/GetGroups.java
View File

@@ -31,6 +31,15 @@ import java.util.ArrayList;
import java.util.List; import java.util.List;
import java.util.Set; import java.util.Set;
/**
* REST endpoint to get all known groups of an account (groups that contain the account as member).
*
* <p>This REST endpoint handles {@code GET /accounts/<account-identifier>/groups} requests.
*
* <p>The response may not contain all groups of the account as not all groups may be known (see
* {@link com.google.gerrit.server.account.GroupMembership#getKnownGroups()}). In addition groups
* that are not visible to the calling user are filtered out.
*/
@Singleton @Singleton
public class GetGroups implements RestReadView<AccountResource> { public class GetGroups implements RestReadView<AccountResource> {
private final GroupControl.Factory groupControlFactory; private final GroupControl.Factory groupControlFactory;