From afc7be590e4faa0ec8e89bd1bc76698559abc323 Mon Sep 17 00:00:00 2001 From: inosh-perera Date: Fri, 13 May 2016 02:50:17 +0530 Subject: [PATCH] adding swagger annotations for Android APIs --- .../carbon/mdm/services/android/bean/DeviceEncryption.java | 7 +++++++ .../carbon/mdm/services/android/bean/Disenrollment.java | 5 +++++ .../wso2/carbon/mdm/services/android/bean/LockCode.java | 6 ++++++ .../carbon/mdm/services/android/bean/Notification.java | 6 ++++++ .../bean/wrapper/BlacklistApplicationsBeanWrapper.java | 6 ++++++ .../services/android/bean/wrapper/CameraBeanWrapper.java | 7 +++++++ .../android/bean/wrapper/DisenrollmentBeanWrapper.java | 5 +++++ .../android/bean/wrapper/EncryptionBeanWrapper.java | 6 ++++++ .../services/android/bean/wrapper/LockCodeBeanWrapper.java | 7 +++++++ .../android/bean/wrapper/NotificationBeanWrapper.java | 7 +++++++ .../android/bean/wrapper/PasswordPolicyBeanWrapper.java | 7 +++++++ .../services/android/bean/wrapper/WebClipBeanWrapper.java | 7 +++++++ .../mdm/services/android/bean/wrapper/WifiBeanWrapper.java | 6 ++++++ .../services/android/bean/wrapper/WipeDataBeanWrapper.java | 6 ++++++ .../services/configuration/ConfigurationMgtService.java | 3 ++- .../services/devicemgt/DeviceManagementService.java | 2 +- .../android/services/enrollment/EnrollmentService.java | 3 ++- .../android/services/operationmgt/OperationMgtService.java | 2 +- .../android/services/policymgt/PolicyMgtService.java | 2 +- 19 files changed, 95 insertions(+), 5 deletions(-) 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/DeviceEncryption.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/DeviceEncryption.java index 2fa0890bc7..68ab6ae947 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/DeviceEncryption.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/DeviceEncryption.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 encrypt operation. */ + +@ApiModel(value = "DeviceEncryption", + description = "Details related device encryption.") public class DeviceEncryption extends AndroidOperation implements Serializable { + @ApiModelProperty(name = "encrypted", value = "Whether to enable encryption or not.", required = true) private boolean encrypted; public boolean isEncrypted() { 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/Disenrollment.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/Disenrollment.java index c1e2c48365..c591d2ae0a 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/Disenrollment.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/Disenrollment.java @@ -18,11 +18,16 @@ package org.wso2.carbon.mdm.services.android.bean; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import org.wso2.carbon.device.mgt.common.operation.mgt.Operation; import java.io.Serializable; +@ApiModel(value = "Disenrollment", + description = "Details related to disenrolling a device.") public class Disenrollment extends AndroidOperation implements Serializable { + @ApiModelProperty(name = "enabled", value = "Whether to enable disenrollment or not.", required = true) private boolean enabled; public boolean isEnabled() { 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/LockCode.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/LockCode.java index 8c95f33ecc..4c2764dade 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/LockCode.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/LockCode.java @@ -18,13 +18,19 @@ 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 changing lock code operation. */ +@ApiModel(value = "LockCode", + description = "Details related to lock code sent on device.") public class LockCode extends AndroidOperation implements Serializable { + @ApiModelProperty(name = "lockCode", value = "The lock code to be sent to the device.", required = true) private String lockCode; public String getLockCode() { 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/Notification.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/Notification.java index 2d45ad957a..e7cdb5788a 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/Notification.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/Notification.java @@ -18,13 +18,19 @@ 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 sending notification operation. */ +@ApiModel(value = "Notification", + description = "Details related to notifications passed to device.") public class Notification extends AndroidOperation implements Serializable { + @ApiModelProperty(name = "message", value = "The message to be sent to the device.", required = true) private String message; public String getMessage() { 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/wrapper/BlacklistApplicationsBeanWrapper.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/wrapper/BlacklistApplicationsBeanWrapper.java index 91c62b435b..1f824661df 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/wrapper/BlacklistApplicationsBeanWrapper.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/wrapper/BlacklistApplicationsBeanWrapper.java @@ -17,6 +17,8 @@ */ package org.wso2.carbon.mdm.services.android.bean.wrapper; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import org.wso2.carbon.mdm.services.android.bean.BlacklistApplications; import java.util.List; @@ -24,9 +26,13 @@ import java.util.List; /** * This class is used to wrap the BlacklistApplications bean with devices. */ +@ApiModel(value = "BlacklistApplicationsBeanWrapper", + description = "Mapping between blacklist application and the device ids.") public class BlacklistApplicationsBeanWrapper { + @ApiModelProperty(name = "operation", value = "Blacklist applications information", required = true) private BlacklistApplications operation; + @ApiModelProperty(name = "deviceIDs", value = "List of device Ids", required = true) private List deviceIDs; public BlacklistApplications getOperation() { 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/wrapper/CameraBeanWrapper.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/wrapper/CameraBeanWrapper.java index bbf1970f8f..9f9a014f2c 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/wrapper/CameraBeanWrapper.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/wrapper/CameraBeanWrapper.java @@ -17,6 +17,8 @@ */ package org.wso2.carbon.mdm.services.android.bean.wrapper; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import org.wso2.carbon.mdm.services.android.bean.Camera; import java.util.List; @@ -24,9 +26,14 @@ import java.util.List; /** * This class is used to wrap the Camera bean with devices. */ + +@ApiModel(value = "CameraBeanWrapper", + description = "Mapping between camera operation and device list to be applied.") public class CameraBeanWrapper { + @ApiModelProperty(name = "operation", value = "Information of camera operation", required = true) private Camera operation; + @ApiModelProperty(name = "deviceIDs", value = "List of device Ids", required = true) private List deviceIDs; public Camera getOperation() { 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/wrapper/DisenrollmentBeanWrapper.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/wrapper/DisenrollmentBeanWrapper.java index d1370633d6..86e7fb3afa 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/wrapper/DisenrollmentBeanWrapper.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/wrapper/DisenrollmentBeanWrapper.java @@ -17,13 +17,18 @@ */ package org.wso2.carbon.mdm.services.android.bean.wrapper; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import org.wso2.carbon.mdm.services.android.bean.Disenrollment; import java.util.List; +@ApiModel(value = "DisenrollmentBeanWrapper", description = "Disenrollment details are mapped to devices list.") public class DisenrollmentBeanWrapper { + @ApiModelProperty(name = "operation", value = "Disenrollment operation.", required = true) private Disenrollment operation; + @ApiModelProperty(name = "deviceIDs", value = "Device id list of the operation to be executed.", required = true) private List deviceIDs; public Disenrollment getOperation() { 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/wrapper/EncryptionBeanWrapper.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/wrapper/EncryptionBeanWrapper.java index 31de3f20a6..aeb01400aa 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/wrapper/EncryptionBeanWrapper.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/wrapper/EncryptionBeanWrapper.java @@ -17,6 +17,8 @@ */ package org.wso2.carbon.mdm.services.android.bean.wrapper; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import org.wso2.carbon.mdm.services.android.bean.DeviceEncryption; import java.util.List; @@ -24,9 +26,13 @@ import java.util.List; /** * This class is used to wrap the Encrypt bean with devices. */ +@ApiModel(value = "EncryptionBeanWrapper", + description = "Mapping between encryption operation and device list to be applied.") public class EncryptionBeanWrapper { + @ApiModelProperty(name = "operation", value = "The information of encrypt operation", required = true) private DeviceEncryption operation; + @ApiModelProperty(name = "deviceIDs", value = "List of device Ids", required = true) private List deviceIDs; public DeviceEncryption getOperation() { 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/wrapper/LockCodeBeanWrapper.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/wrapper/LockCodeBeanWrapper.java index 828aebb00f..364fd39d28 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/wrapper/LockCodeBeanWrapper.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/wrapper/LockCodeBeanWrapper.java @@ -17,6 +17,8 @@ */ package org.wso2.carbon.mdm.services.android.bean.wrapper; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import org.wso2.carbon.mdm.services.android.bean.LockCode; import java.util.List; @@ -24,9 +26,14 @@ import java.util.List; /** * This class is used to wrap the LockCode bean with devices. */ + +@ApiModel(value = "LockCodeBeanWrapper", + description = "Mapping between lock operation and device list to be applied.") public class LockCodeBeanWrapper { + @ApiModelProperty(name = "operation", value = "The information of device lock operation", required = true) private LockCode operation; + @ApiModelProperty(name = "deviceIDs", value = "List of device Ids", required = true) private List deviceIDs; public LockCode getOperation() { 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/wrapper/NotificationBeanWrapper.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/wrapper/NotificationBeanWrapper.java index a9c6a50d65..573e2affc8 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/wrapper/NotificationBeanWrapper.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/wrapper/NotificationBeanWrapper.java @@ -17,6 +17,8 @@ */ package org.wso2.carbon.mdm.services.android.bean.wrapper; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import org.wso2.carbon.mdm.services.android.bean.Notification; import java.util.List; @@ -24,9 +26,14 @@ import java.util.List; /** * This class is used to wrap the Notification bean with devices. */ + +@ApiModel(value = "NotificationBeanWrapper", + description = "Mapping between notification operation and device list to be applied.") public class NotificationBeanWrapper { + @ApiModelProperty(name = "deviceIDs", value = "List of device Ids", required = true) private List deviceIDs; + @ApiModelProperty(name = "operation", value = "The information of notification operation", required = true) private Notification operation; public List getDeviceIDs() { 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/wrapper/PasswordPolicyBeanWrapper.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/wrapper/PasswordPolicyBeanWrapper.java index a4a55ecbb5..e47ece1c5a 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/wrapper/PasswordPolicyBeanWrapper.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/wrapper/PasswordPolicyBeanWrapper.java @@ -17,6 +17,8 @@ */ package org.wso2.carbon.mdm.services.android.bean.wrapper; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import org.wso2.carbon.mdm.services.android.bean.PasscodePolicy; import java.util.List; @@ -24,9 +26,14 @@ import java.util.List; /** * This class is used to wrap the PasswordPolicy bean with devices. */ + +@ApiModel(value = "PasswordPolicyBeanWrapper", + description = "Mapping between passcode policy and device list to be applied.") public class PasswordPolicyBeanWrapper { + @ApiModelProperty(name = "operation", value = "The information of setting up password policy", required = true) private PasscodePolicy operation; + @ApiModelProperty(name = "deviceIDs", value = "List of device Ids", required = true) private List deviceIDs; public PasscodePolicy getOperation() { 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/wrapper/WebClipBeanWrapper.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/wrapper/WebClipBeanWrapper.java index 61479b521f..098a518bb3 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/wrapper/WebClipBeanWrapper.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/wrapper/WebClipBeanWrapper.java @@ -17,6 +17,8 @@ */ package org.wso2.carbon.mdm.services.android.bean.wrapper; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import org.wso2.carbon.mdm.services.android.bean.WebClip; import java.util.List; @@ -24,9 +26,14 @@ import java.util.List; /** * This class is used to wrap the WebClip bean with devices. */ + +@ApiModel(value = "WebClipBeanWrapper", + description = "Mapping between web clip operation and device list to be applied.") public class WebClipBeanWrapper { + @ApiModelProperty(name = "operation", value = "the information of setting up webclip", required = true) private WebClip operation; + @ApiModelProperty(name = "deviceIDs", value = "List of device Ids", required = true) private List deviceIDs; public WebClip getOperation() { 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/wrapper/WifiBeanWrapper.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/wrapper/WifiBeanWrapper.java index 1d3adcb70f..2d63a27d9c 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/wrapper/WifiBeanWrapper.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/wrapper/WifiBeanWrapper.java @@ -17,6 +17,8 @@ */ package org.wso2.carbon.mdm.services.android.bean.wrapper; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import org.wso2.carbon.mdm.services.android.bean.Wifi; import java.util.List; @@ -24,9 +26,13 @@ import java.util.List; /** * This class is used to wrap the Wifi bean with devices. */ +@ApiModel(value = "WifiBeanWrapper", + description = "Mapping between wifi operation and device list to be applied.") public class WifiBeanWrapper { + @ApiModelProperty(name = "operation", value = "Information of configuring wifi operation", required = true) private Wifi operation; + @ApiModelProperty(name = "deviceIDs", value = "List of device Ids", required = true) private List deviceIDs; public Wifi getOperation() { 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/wrapper/WipeDataBeanWrapper.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/wrapper/WipeDataBeanWrapper.java index a9d65485e2..1c72af45b4 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/wrapper/WipeDataBeanWrapper.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/wrapper/WipeDataBeanWrapper.java @@ -17,6 +17,8 @@ */ package org.wso2.carbon.mdm.services.android.bean.wrapper; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import org.wso2.carbon.mdm.services.android.bean.WipeData; import java.util.List; @@ -24,9 +26,13 @@ import java.util.List; /** * This class is used to wrap the WipeData bean with devices. */ +@ApiModel(value = "WipeDataBeanWrapper", + description = "Mapping between wipe operation and device list to be applied.") public class WipeDataBeanWrapper { + @ApiModelProperty(name = "operation", value = "The information of wipedata operation", required = true) private WipeData operation; + @ApiModelProperty(name = "deviceIDs", value = "List of device Ids", required = true) private List deviceIDs; public WipeData getOperation() { 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/services/configuration/ConfigurationMgtService.java b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/configuration/ConfigurationMgtService.java index ca51ac6aef..3a378d9e7a 100644 --- a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/configuration/ConfigurationMgtService.java +++ b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/configuration/ConfigurationMgtService.java @@ -77,5 +77,6 @@ public interface ConfigurationMgtService { @ApiResponse(code = 500, message = "Error occurred while modifying configuration settings of " + "Android platform") }) - Message updateConfiguration(TenantConfiguration configuration) throws AndroidAgentException; + Message updateConfiguration(@ApiParam(name = "configuration", value = "AndroidPlatformConfiguration") + TenantConfiguration configuration) throws AndroidAgentException; } 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/services/devicemgt/DeviceManagementService.java b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/devicemgt/DeviceManagementService.java index d6eae7eb11..b7036dd083 100644 --- a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/devicemgt/DeviceManagementService.java +++ b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/devicemgt/DeviceManagementService.java @@ -34,7 +34,7 @@ import java.util.List; * All end points supports JSON, XMl with content negotiation. */ -@Api(value = "DeviceManagementService") +@Api(value = "DeviceManagementService", description = "Android Device Management REST-API implementation.") @WebService @Produces({"application/json", "application/xml"}) @Consumes({"application/json", "application/xml"}) 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/services/enrollment/EnrollmentService.java b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/enrollment/EnrollmentService.java index 28cc416f78..6c6aa2e378 100644 --- a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/enrollment/EnrollmentService.java +++ b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/enrollment/EnrollmentService.java @@ -30,7 +30,8 @@ import javax.ws.rs.core.MediaType; * Android Device Enrollment REST-API implementation. * All end points supports JSON, XMl with content negotiation. */ -@Api(value = "EnrollmentService") + +@Api(value = "EnrollmentService", description = "Android Device Enrollment REST-API implementation.") @WebService @Produces({"application/json", "application/xml"}) @Consumes({"application/json", "application/xml"}) 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/services/operationmgt/OperationMgtService.java b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/operationmgt/OperationMgtService.java index 8c0cc0ff6d..d89b977c61 100644 --- a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/operationmgt/OperationMgtService.java +++ b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/operationmgt/OperationMgtService.java @@ -31,7 +31,7 @@ import java.util.List; * Android Device Operation REST-API implementation. */ -@Api("OperationMgtService") +@Api(value = "OperationMgtService", description = "Android Device Operation REST-API implementation.") public interface OperationMgtService { String ACCEPT = "Accept"; 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/services/policymgt/PolicyMgtService.java b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/policymgt/PolicyMgtService.java index 7d36987c93..e35f08b23e 100644 --- a/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/policymgt/PolicyMgtService.java +++ b/components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/policymgt/PolicyMgtService.java @@ -28,7 +28,7 @@ import javax.ws.rs.*; import javax.ws.rs.core.MediaType; import java.util.List; -@Api("PolicyMgtService") +@Api(value = "PolicyMgtService", description = "Policy management related REST-API implementation.") @WebService @Produces({"application/json", "application/xml"}) @Consumes({"application/json", "application/xml"})