Document PutActive/DeleteActive classes
Change-Id: I079f7a7c0fbeca64c99bb196e0bb1a294d366879 Signed-off-by: Edwin Kempin <ekempin@google.com>
This commit is contained in:

committed by
David Pursehouse

parent
7926ef3fb4
commit
c7b4cf3fac
@@ -30,6 +30,15 @@ import com.google.inject.Singleton;
|
|||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
import org.eclipse.jgit.errors.ConfigInvalidException;
|
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)
|
@RequiresCapability(GlobalCapability.MODIFY_ACCOUNT)
|
||||||
@Singleton
|
@Singleton
|
||||||
public class DeleteActive implements RestModifyView<AccountResource, Input> {
|
public class DeleteActive implements RestModifyView<AccountResource, Input> {
|
||||||
|
@@ -27,6 +27,15 @@ import com.google.inject.Singleton;
|
|||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
import org.eclipse.jgit.errors.ConfigInvalidException;
|
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)
|
@RequiresCapability(GlobalCapability.MODIFY_ACCOUNT)
|
||||||
@Singleton
|
@Singleton
|
||||||
public class PutActive implements RestModifyView<AccountResource, Input> {
|
public class PutActive implements RestModifyView<AccountResource, Input> {
|
||||||
|
Reference in New Issue
Block a user