Document PutActive/DeleteActive classes

Change-Id: I079f7a7c0fbeca64c99bb196e0bb1a294d366879
Signed-off-by: Edwin Kempin <ekempin@google.com>
This commit is contained in:
Edwin Kempin
2019-12-27 11:38:05 +01:00
committed by David Pursehouse
parent 7926ef3fb4
commit c7b4cf3fac
2 changed files with 18 additions and 0 deletions

View File

@@ -30,6 +30,15 @@ import com.google.inject.Singleton;
import java.io.IOException;
import org.eclipse.jgit.errors.ConfigInvalidException;
/**
* REST endpoint to mark an account as inactive.
*
* <p>This REST endpoint handles {@code DELETE /accounts/<account-identifier>/active} requests.
*
* <p>Inactive accounts cannot login into Gerrit.
*
* <p>Marking an account as active is handled by {@link PutActive}.
*/
@RequiresCapability(GlobalCapability.MODIFY_ACCOUNT)
@Singleton
public class DeleteActive implements RestModifyView<AccountResource, Input> {

View File

@@ -27,6 +27,15 @@ import com.google.inject.Singleton;
import java.io.IOException;
import org.eclipse.jgit.errors.ConfigInvalidException;
/**
* REST endpoint to mark an account as active.
*
* <p>This REST endpoint handles {@code PUT /accounts/<account-identifier>/active} requests.
*
* <p>Only active accounts can login into Gerrit.
*
* <p>Marking an account as inactive is handled by {@link DeleteActive}.
*/
@RequiresCapability(GlobalCapability.MODIFY_ACCOUNT)
@Singleton
public class PutActive implements RestModifyView<AccountResource, Input> {