From 3cf797fba679c4466d8e8023b0639b06e8434050 Mon Sep 17 00:00:00 2001 From: charitha Date: Mon, 30 Jan 2017 17:25:27 +0530 Subject: [PATCH] Removed hardcoded device types in swagger docs --- .../service/api/DeviceManagementService.java | 25 ++++++++----------- .../api/DeviceTypeManagementService.java | 5 ++-- .../service/api/PolicyManagementService.java | 5 ++-- .../admin/DeviceManagementAdminService.java | 5 ++-- 4 files changed, 16 insertions(+), 24 deletions(-) diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/DeviceManagementService.java b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/DeviceManagementService.java index 05a22be16d9..6bf11f4ac4f 100644 --- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/DeviceManagementService.java +++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/DeviceManagementService.java @@ -321,9 +321,8 @@ public interface DeviceManagementService { Response getDevice( @ApiParam( name = "type", - value = "The device type, such as ios, android or windows.", - required = true, - allowableValues = "android, ios, windows") + value = "The device type name, such as ios, android, windows or fire-alarm.", + required = true) @PathParam("type") @Size(max = 45) String type, @@ -556,9 +555,8 @@ public interface DeviceManagementService { Response getFeaturesOfDevice( @ApiParam( name = "type", - value = "The device type, such as ios, android or windows.", - required = true, - allowableValues = "android, ios, windows") + value = "The device type name, such as ios, android, windows or fire-alarm.", + required = true) @PathParam("type") @Size(max = 45) String type, @@ -723,9 +721,8 @@ public interface DeviceManagementService { Response getInstalledApplications( @ApiParam( name = "type", - value = "The device type, such as ios, android or windows.", - required = true, - allowableValues = "android, ios, windows") + value = "The device type name, such as ios, android, windows or fire-alarm.", + required = true) @PathParam("type") @Size(max = 45) String type, @@ -825,9 +822,8 @@ public interface DeviceManagementService { Response getDeviceOperations( @ApiParam( name = "type", - value = "The device type, such as ios, android or windows.", - required = true, - allowableValues = "android, ios, windows") + value = "The device type name, such as ios, android, windows or fire-alarm.", + required = true) @PathParam("type") @Size(max = 45) String type, @@ -936,9 +932,8 @@ public interface DeviceManagementService { Response getEffectivePolicyOfDevice( @ApiParam( name = "type", - value = "The device type, such as ios, android or windows.", - required = true, - allowableValues = "android, ios, windows") + value = "The device type name, such as ios, android, windows or fire-alarm.", + required = true) @PathParam("type") @Size(max = 45) String type, diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/DeviceTypeManagementService.java b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/DeviceTypeManagementService.java index 83566b6f12c..b71c918fca6 100644 --- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/DeviceTypeManagementService.java +++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/DeviceTypeManagementService.java @@ -192,9 +192,8 @@ public interface DeviceTypeManagementService { Response getFeatures( @ApiParam( name = "type", - value = "The device type, such as ios, android or windows.", - required = true, - allowableValues = "android, ios, windows") + value = "The device type name, such as ios, android, windows or fire-alarm.", + required = true) @PathParam("type") @Size(max = 45) String type, diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/PolicyManagementService.java b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/PolicyManagementService.java index 8656456f1fe..ed49af08cc3 100644 --- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/PolicyManagementService.java +++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/PolicyManagementService.java @@ -672,9 +672,8 @@ public interface PolicyManagementService { Response getEffectivePolicy( @ApiParam( name = "deviceType", - value = "The device type, such as ios, android or windows.", - required = true, - allowableValues = "android, ios, windows") + value = "The device type name, such as ios, android, windows or fire-alarm.", + required = true) @PathParam("deviceType") @Size(max = 45) String deviceType, diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/admin/DeviceManagementAdminService.java b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/admin/DeviceManagementAdminService.java index 14a34d35206..0ac06771516 100644 --- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/admin/DeviceManagementAdminService.java +++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/service/api/admin/DeviceManagementAdminService.java @@ -136,9 +136,8 @@ public interface DeviceManagementAdminService { String name, @ApiParam( name = "type", - value = "The type of the device, such as android, ios or windows.", - required = true, - allowableValues = "android, ios, windows") + value = "The device type name, such as ios, android, windows or fire-alarm.", + required = true) @QueryParam("type") @Size(min = 2, max = 45) String type,