Document GetAvatar / GetAvatarChangeUrl classes Change-Id: I2e4ca0a5dcdcd71becf5df9572376d8040d1c176 Signed-off-by: Edwin Kempin <ekempin@google.com>
diff --git a/java/com/google/gerrit/server/restapi/account/GetAvatar.java b/java/com/google/gerrit/server/restapi/account/GetAvatar.java index 3c1752d..5256d68 100644 --- a/java/com/google/gerrit/server/restapi/account/GetAvatar.java +++ b/java/com/google/gerrit/server/restapi/account/GetAvatar.java
@@ -26,6 +26,13 @@ import java.util.concurrent.TimeUnit; import org.kohsuke.args4j.Option; +/** + * REST endpoint to get the avatar image of an account. + * + * <p>This REST endpoint handles {@code GET /accounts/<account-identifier>/avatar} requests. + * + * <p>Avatar images are only available if an {@link AvatarProvider} plugin is installed. + */ public class GetAvatar implements RestReadView<AccountResource> { private final DynamicItem<AvatarProvider> avatarProvider;
diff --git a/java/com/google/gerrit/server/restapi/account/GetAvatarChangeUrl.java b/java/com/google/gerrit/server/restapi/account/GetAvatarChangeUrl.java index e97e0a0..a26df64 100644 --- a/java/com/google/gerrit/server/restapi/account/GetAvatarChangeUrl.java +++ b/java/com/google/gerrit/server/restapi/account/GetAvatarChangeUrl.java
@@ -24,6 +24,15 @@ import com.google.inject.Inject; import com.google.inject.Singleton; +/** + * REST endpoint to get the URL for changing the avatar image of an account. + * + * <p>This REST endpoint handles {@code GET /accounts/<account-identifier>/avatar.change.url} + * requests. + * + * <p>Avatar images are only available if an {@link AvatarProvider} plugin is installed. Not all + * avatar plugins provide a URL for changing avatar images. + */ @Singleton public class GetAvatarChangeUrl implements RestReadView<AccountResource> { private final DynamicItem<AvatarProvider> avatarProvider;