Adding swagger annotations to beans

merge-requests/1/head
Madhawa Perera 9 years ago
parent 34d4da7e66
commit 0d8010c25a

@ -18,19 +18,42 @@
package org.wso2.carbon.mdm.services.android.bean;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;
/**
* This class represents the information of setting up password policy.
*/
@ApiModel(value = "PasscodePolicy", description = "This class represents the information of setting up "
+ "password policy")
public class PasscodePolicy extends AndroidOperation implements Serializable {
@ApiModelProperty(name = "maxFailedAttempts", value = "The maximum number of times the end-user can enter"
+ " his/her device passcode incorrectly. EMM will take different courses of action based on the"
+ " OS when the failed attempts exceed the maximum failed attempts. Android devices will be "
+ "automatically reset to the original factory settings", required = true)
private int maxFailedAttempts;
@ApiModelProperty(name = "minLength", value = "The minimum number of alphanumerical values that the "
+ "end-user can enter as his/her passcode", required = true)
private int minLength;
@ApiModelProperty(name = "pinHistory", value = "The end-user will not be allowed to reuse a passcode that"
+ " he/she previously entered until he/she exceeds the set pin history length", required = true)
private int pinHistory;
@ApiModelProperty(name = "minComplexChars", value = "The minimum number of special characters that the "
+ "end-user will have to enter in his/her passcode", required = true)
private int minComplexChars;
@ApiModelProperty(name = "maxPINAgeInDays", value = "The number of days after which the device owner has"
+ " to change his/her passcode", required = true)
private int maxPINAgeInDays;
@ApiModelProperty(name = "requireAlphanumeric", value = "Whether or not it is mandatory for the end-user"
+ " to have a mix of digits and characters in his/her passcode", required = true)
private boolean requireAlphanumeric;
@ApiModelProperty(name = "allowSimple", value = "If this field is set to 'true', the device owner will be"
+ " able to have a simple passcode and the following criteria in the passcode policy will not be"
+ " applicable:\n"
+ "Minimum length\n" + "Minimum complex characters", required = true)
private boolean allowSimple;
public int getMaxFailedAttempts() {

@ -18,15 +18,24 @@
package org.wso2.carbon.mdm.services.android.bean;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;
/**
* This class represents the information of setting up webclip.
*/
@ApiModel(value = "WebClip", description = "This class represents the information of setting up webclip")
public class WebClip extends AndroidOperation implements Serializable {
@ApiModelProperty(name = "identity", value = "The URL of the application", required = true)
private String identity;
@ApiModelProperty(name = "title", value = "The name of the web application", required = true)
private String title;
@ApiModelProperty(name = "type", value = "The type of the operation. Following are the possible operation"
+ " types: install and uninstall. If the operation type is install, the web clip is added, and "
+ "if the operation type is uninstall, the existing web clip is removed", required = true)
private String type;
public String getIdentity() {

@ -18,14 +18,22 @@
package org.wso2.carbon.mdm.services.android.bean;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;
/**
* This class represents the information of configuring wifi operation.
*/
@ApiModel(value = "Wifi", description = "This class represents the information of configuring wifi operation")
public class Wifi extends AndroidOperation implements Serializable {
@ApiModelProperty(name = "ssid", value = "The name of the Wifi network that you wish to configure",
required = true)
private String ssid;
@ApiModelProperty(name = "password", value = "The password to connect to the specified Wifi network",
required = true)
private String password;
public String getSsid() {

@ -18,13 +18,18 @@
package org.wso2.carbon.mdm.services.android.bean;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;
/**
* This class represents the information of wipedata operation.
*/
@ApiModel(value = "WipeData", description = "This class represents the information of wipedata operation")
public class WipeData extends AndroidOperation implements Serializable {
@ApiModelProperty(name = "pin", value = "PIN number to proceed with the data wipe", required = true)
private String pin;
public String getPin() {

Loading…
Cancel
Save