From 03b28c575824f0bb69a28044616b73123c5246bb Mon Sep 17 00:00:00 2001 From: Edwin Kempin Date: Fri, 27 Dec 2019 12:48:02 +0100 Subject: [PATCH] Document GetGroups class Change-Id: Iaf18eac6e7885b261ccf407ec51cbff23508fb54 Signed-off-by: Edwin Kempin --- .../google/gerrit/server/restapi/account/GetGroups.java | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/java/com/google/gerrit/server/restapi/account/GetGroups.java b/java/com/google/gerrit/server/restapi/account/GetGroups.java index 22492a751f..eff4b3acdd 100644 --- a/java/com/google/gerrit/server/restapi/account/GetGroups.java +++ b/java/com/google/gerrit/server/restapi/account/GetGroups.java @@ -31,6 +31,15 @@ import java.util.ArrayList; import java.util.List; import java.util.Set; +/** + * REST endpoint to get all known groups of an account (groups that contain the account as member). + * + *

This REST endpoint handles {@code GET /accounts//groups} requests. + * + *

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 public class GetGroups implements RestReadView { private final GroupControl.Factory groupControlFactory;