opendev/gerrit
Code Issues Proposed changes

Document GetCapabilities / GetCapabilities.CheckOne classes

Browse Source 
Change-Id: If4ecb81915f14d3fb9a09bcc951c7dd809f2fea7
Signed-off-by: Edwin Kempin <ekempin@google.com>
This commit is contained in:
Edwin Kempin
2019-12-27 13:59:05 +01:00
committed by David Pursehouse
parent f168e3a3cd
commit c61f8acce5
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
java/com/google/gerrit/server/restapi/account/GetCapabilities.java
View File

@@ -49,6 +49,11 @@ import java.util.Map;
import java.util.Set; import java.util.Set;
import org.kohsuke.args4j.Option; 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> { public class GetCapabilities implements RestReadView<AccountResource> {
@Option(name = "-q", metaVar = "CAP", usage = "Capability to inspect") @Option(name = "-q", metaVar = "CAP", usage = "Capability to inspect")
void addQuery(String name) { void addQuery(String name) {
@@ -159,6 +164,12 @@ public class GetCapabilities implements RestReadView<AccountResource> {
} }
} }
/**
* 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 @Singleton
public static class CheckOne implements RestReadView<AccountResource.Capability> { public static class CheckOne implements RestReadView<AccountResource.Capability> {
private final PermissionBackend permissionBackend; private final PermissionBackend permissionBackend;