commit c61f8acce5189536ef6c7b69dbd26b391d85f9e6
author Edwin Kempin <ekempin@google.com> Fri Dec 27 13:59:05 2019 +0100
committer David Pursehouse <dpursehouse@collab.net> Sun Jan 12 06:25:58 2020 +0000
tree 3824a7a41ea492e5f6d2b1e2053457ca5cfbbff2
parent f168e3a3cd160792945d05e243a875e346cd21cd

Document GetCapabilities / GetCapabilities.CheckOne classes

Change-Id: If4ecb81915f14d3fb9a09bcc951c7dd809f2fea7
Signed-off-by: Edwin Kempin <ekempin@google.com>

java/com/google/gerrit/server/restapi/account/GetCapabilities.java

diff --git a/java/com/google/gerrit/server/restapi/account/GetCapabilities.java b/java/com/google/gerrit/server/restapi/account/GetCapabilities.java
index fa9ab18..f3d9557 100644
--- a/java/com/google/gerrit/server/restapi/account/GetCapabilities.java
+++ b/java/com/google/gerrit/server/restapi/account/GetCapabilities.java
@@ -49,6 +49,11 @@
 import java.util.Set;
 import org.kohsuke.args4j.Option;
 
+/**
+ * REST endpoint to list the global capabilities that are assigned to an account.
+ *
+ * <p>This REST endpoint handles {@code GET /accounts/<account-identifier>/capabilities/} requests.
+ */
 public class GetCapabilities implements RestReadView<AccountResource> {
   @Option(name = "-q", metaVar = "CAP", usage = "Capability to inspect")
   void addQuery(String name) {
@@ -159,6 +164,12 @@
     }
   }
 
+  /**
+   * REST endpoint to check if a global capability is assigned to an account.
+   *
+   * <p>This REST endpoint handles {@code GET
+   * /accounts/<account-identifier>/capabilities/<capability-identifier>} requests.
+   */
   @Singleton
   public static class CheckOne implements RestReadView<AccountResource.Capability> {
     private final PermissionBackend permissionBackend;