Document GetAgreements class

Change-Id: I6aab9e7650c91b4c6d8f0fb2d93f7339acb1fefe
Signed-off-by: Edwin Kempin <ekempin@google.com>
This commit is contained in:
Edwin Kempin
2019-12-27 13:49:48 +01:00
committed by David Pursehouse
parent 80738a6ddd
commit f168e3a3cd

View File

@@ -42,6 +42,14 @@ import java.util.Collection;
import java.util.List;
import org.eclipse.jgit.lib.Config;
/**
* REST endpoint to get all contributor agreements that have been signed by an account.
*
* <p>This REST endpoint handles {@code GET /accounts/<account-identifier>/agreements} requests.
*
* <p>Contributor agreements are only available if contributor agreements have been enabled in
* {@code gerrit.config} (see {@code auth.contributorAgreements}).
*/
@Singleton
public class GetAgreements implements RestReadView<AccountResource> {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();