opendev/gerrit
Code Issues Proposed changes

Merge "Document GetAvatar / GetAvatarChangeUrl classes"

Browse Source
This commit is contained in:
David Pursehouse
2020-01-13 08:29:06 +00:00
committed by Gerrit Code Review
parent 974ab5c72b f6f43ded4e
commit ff923cbc38
2 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
java/com/google/gerrit/server/restapi/account/GetAvatar.java
View File

@@ -26,6 +26,13 @@ import com.google.inject.Inject;
import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeUnit;
import org.kohsuke.args4j.Option; 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> { public class GetAvatar implements RestReadView<AccountResource> {
private final DynamicItem<AvatarProvider> avatarProvider; private final DynamicItem<AvatarProvider> avatarProvider;

9
java/com/google/gerrit/server/restapi/account/GetAvatarChangeUrl.java
View File

@@ -24,6 +24,15 @@ import com.google.gerrit.server.avatar.AvatarProvider;
import com.google.inject.Inject; import com.google.inject.Inject;
import com.google.inject.Singleton; 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 @Singleton
public class GetAvatarChangeUrl implements RestReadView<AccountResource> { public class GetAvatarChangeUrl implements RestReadView<AccountResource> {
private final DynamicItem<AvatarProvider> avatarProvider; private final DynamicItem<AvatarProvider> avatarProvider;