more api documentation

This commit is contained in:
Athou
2013-04-17 13:26:14 +02:00
parent ef3508f393
commit 4c927630a7
8 changed files with 87 additions and 21 deletions

View File

@@ -6,16 +6,31 @@ import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;
import com.wordnik.swagger.annotations.ApiClass;
import com.wordnik.swagger.annotations.ApiProperty;
@SuppressWarnings("serial")
@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
@ApiClass("User information")
public class UserModel implements Serializable {
@ApiProperty(value = "user id", required = true)
private Long id;
@ApiProperty(value = "user name", required = true)
private String name;
@ApiProperty("user email, if any")
private String email;
@ApiProperty(value = "user password, never returned by the api")
private String password;
@ApiProperty(value = "account status")
private boolean enabled;
@ApiProperty(value = "user is admin")
private boolean admin;
public Long getId() {