From f66aad9e0e4f2160534df3accf631aa1f4a3b6d3 Mon Sep 17 00:00:00 2001 From: dilanua Date: Fri, 13 May 2016 02:39:30 +0530 Subject: [PATCH] Adding swagger annotations --- .../android/bean/ApplicationInstallation.java | 2 +- .../android/bean/ApplicationUninstallation.java | 13 +++++++++++++ .../android/bean/BlacklistApplications.java | 7 +++++++ .../carbon/mdm/services/android/bean/Camera.java | 7 +++++++ 4 files changed, 28 insertions(+), 1 deletion(-) diff --git a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/bean/ApplicationInstallation.java b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/bean/ApplicationInstallation.java index c7583ad7ad..b0ed373779 100644 --- a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/bean/ApplicationInstallation.java +++ b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/bean/ApplicationInstallation.java @@ -30,7 +30,7 @@ import java.io.Serializable; description = "This class carries all information related to install application") public class ApplicationInstallation extends AndroidOperation implements Serializable { - @ApiModelProperty(name = "appIdentifier", value = "DeviceIdentifier", required = true) + @ApiModelProperty(name = "appIdentifier", value = "Application Identifier", required = true) private String appIdentifier; @ApiModelProperty(name = "type", value = "Application type(Enterprise/Web/public)", required = true) diff --git a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/bean/ApplicationUninstallation.java b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/bean/ApplicationUninstallation.java index 5efb16a5b7..a946eedc72 100644 --- a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/bean/ApplicationUninstallation.java +++ b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/bean/ApplicationUninstallation.java @@ -18,16 +18,29 @@ 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 uninstall application operation. */ +@ApiModel(value = "ApplicationUninstallation", + description = "This class carries all information related to application uninstallation.") public class ApplicationUninstallation extends AndroidOperation implements Serializable { + @ApiModelProperty(name = "appIdentifier", value = "The package name of the application to be uninstalled.", required = true) private String appIdentifier; + + @ApiModelProperty(name = "type", value = "The type of the application. The following types of applications " + + "are supported: enterprise, public and webapp.", required = true) private String type; + + @ApiModelProperty(name = "url", value = "The URL of the application.", required = true) private String url; + + @ApiModelProperty(name = "name", value = "The name of the application.", required = true) private String name; public String getAppIdentifier() { diff --git a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/bean/BlacklistApplications.java b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/bean/BlacklistApplications.java index c66dbe89a6..665735b519 100644 --- a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/bean/BlacklistApplications.java +++ b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/bean/BlacklistApplications.java @@ -18,14 +18,21 @@ package org.wso2.carbon.mdm.services.android.bean; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; + import java.io.Serializable; import java.util.List; /** * This class represents the blacklist applications information. */ +@ApiModel(value = "BlacklistApplications", + description = "This class represents the blacklist applications information.") public class BlacklistApplications extends AndroidOperation implements Serializable { + @ApiModelProperty(name = "appIdentifiers", value = "A list of application package names to be blacklisted.", + required = true) private List appIdentifiers; public List getAppIdentifier() { diff --git a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/bean/Camera.java b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/bean/Camera.java index 77c0773c1e..0dad70364a 100644 --- a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/bean/Camera.java +++ b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/bean/Camera.java @@ -18,13 +18,20 @@ 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 camera operation. */ +@ApiModel(value = "Camera", + description = "This class represents the information of camera operation.") public class Camera extends AndroidOperation implements Serializable { + @ApiModelProperty(name = "enabled", value = "Disable the camera on the device by assigning false as the value or " + + "enable the camera on the device to function by defining true as the value.", required = true) private boolean enabled; public boolean isEnabled() {