Document AccountInfo and AccountDetailInfo classes

Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: Id6154a8ea886d55e0beacb3a098f10116bc18375
This commit is contained in:
Edwin Kempin
2019-12-30 12:59:17 +01:00
parent 494d93fd26
commit 4d251c27ac
2 changed files with 17 additions and 0 deletions

View File

@@ -16,6 +16,15 @@ package com.google.gerrit.extensions.common;
import java.sql.Timestamp;
/**
* Representation of a (detailed) account in the REST API.
*
* <p>This class determines the JSON format of (detailed) accounts in the REST API.
*
* <p>This class extends {@link AccountInfo} (which defines fields for account properties that are
* frequently used) and provides additional fields for account details which are needed only in some
* cases.
*/
public class AccountDetailInfo extends AccountInfo {
public Timestamp registeredOn;

View File

@@ -18,6 +18,14 @@ import com.google.common.base.MoreObjects;
import java.util.List;
import java.util.Objects;
/**
* Representation of an account in the REST API.
*
* <p>This class determines the JSON format of accounts in the REST API.
*
* <p>This class defines fields for account properties that are frequently used. Additional fields
* are defined in {@link AccountDetailInfo}.
*/
public class AccountInfo {
public Integer _accountId;
public String name;