Merge pull request #572 from charithag/master-update-swagger-docs

Update swagger docs

components/mobile-plugins/android-plugin/org.wso2.carbon.device.mgt.mobile.android.api/src/main/java/org/wso2/carbon/mdm/services/android/services/DeviceManagementAdminService.java

@@ -415,7 +415,7 @@ public interface DeviceManagementAdminService {
             value = "Clearing the Password on Android Devices",
             notes = "Clear the password on Android devices",
             response = Activity.class,
-            tags = "Android Device Management Administrative Service.",
+            tags = "Android Device Management Administrative Service",
             extensions = {
                     @Extension(properties = {
                             @ExtensionProperty(name = AndroidConstants.SCOPE, value = "perm:android:clear-password")

components/mobile-plugins/windows-plugin/org.wso2.carbon.device.mgt.mobile.windows.api/src/main/java/org/wso2/carbon/device/mgt/mobile/windows/api/services/DeviceManagementAdminService.java

@@ -179,7 +179,7 @@ public interface DeviceManagementAdminService {
             value = "Dis-enrol the windows Devices",
             notes = "Dis-enroll on Android devices",
             response = Activity.class,
-            tags = "Windows Device Management Administrative Service.",
+            tags = "Windows Device Management Administrative Service",
             extensions = {
                     @Extension(properties = {
                             @ExtensionProperty(name = Constants.SCOPE, value = "perm:windows:disenroll")

components/mobile-plugins/windows-plugin/org.wso2.carbon.device.mgt.mobile.windows.api/src/main/java/org/wso2/carbon/device/mgt/mobile/windows/api/services/DeviceManagementService.java

@@ -18,8 +18,6 @@
 
 package org.wso2.carbon.device.mgt.mobile.windows.api.services;
 
-
-import io.swagger.annotations.*;
 import org.w3c.dom.Document;
 import org.wso2.carbon.apimgt.annotations.api.Scope;
 import org.wso2.carbon.apimgt.annotations.api.Scopes;
@@ -28,7 +26,6 @@ import org.wso2.carbon.device.mgt.mobile.windows.api.common.PluginConstants;
 import org.wso2.carbon.device.mgt.mobile.windows.api.common.exceptions.WindowsConfigurationException;
 import org.wso2.carbon.device.mgt.mobile.windows.api.common.exceptions.WindowsDeviceEnrolmentException;
 import org.wso2.carbon.device.mgt.mobile.windows.api.operations.WindowsOperationException;
-import org.wso2.carbon.device.mgt.mobile.windows.api.operations.util.Constants;
 
 import javax.ws.rs.Consumes;
 import javax.ws.rs.POST;
@@ -57,55 +54,6 @@ public interface DeviceManagementService {
     @POST
     @Consumes({PluginConstants.SYNCML_MEDIA_TYPE, MediaType.APPLICATION_XML})
     @Produces(PluginConstants.SYNCML_MEDIA_TYPE)
-    @ApiOperation(
-            httpMethod = "POST",
-            value = "Getting pending operations for Windows device.",
-            notes = "Using this API to fetching more information to enroll the Device and " +
-                    "getting pending operations.",
-            tags = "Windows Device Management Administrative Service",
-            extensions = {
-                    @Extension(properties = {
-                            @ExtensionProperty(name = Constants.SCOPE, value = "perm:android:enroll")
-                    })
-            }
-    )
-    @ApiResponses(value = {
-            @ApiResponse(
-                    code = 201,
-                    message = "Ok. \n Successfully getting pending operations.",
-                    responseHeaders = {
-                            @ResponseHeader(
-                                    name = "Content-Location",
-                                    description = "URL of the activity instance that refers to the scheduled operation."),
-                            @ResponseHeader(
-                                    name = "Content-Type",
-                                    description = "Content type of the body"),
-                            @ResponseHeader(
-                                    name = "ETag",
-                                    description = "Entity Tag of the response resource.\n" +
-                                            "Used by caches, or in conditional requests."),
-                            @ResponseHeader(
-                                    name = "Last-Modified",
-                                    description = "Date and time the resource was last modified. \n" +
-                                            "Used by caches, or in conditional requests.")}),
-            @ApiResponse(
-                    code = 303,
-                    message = "See Other. \n The source can be retrieved from the URL specified in the location header.",
-                    responseHeaders = {
-                            @ResponseHeader(
-                                    name = "Content-Location",
-                                    description = "The Source URL of the document.")}),
-            @ApiResponse(
-                    code = 400,
-                    message = "Bad Request. \n Invalid request or validation error."),
-            @ApiResponse(
-                    code = 415,
-                    message = "Unsupported media type. \n The format of the requested entity was not supported.\n"),
-            @ApiResponse(
-                    code = 500,
-                    message = "Internal Server Error. \n " +
-                            "Server error occurred while getting pending operations.")
-    })
     Response getResponse(Document request) throws WindowsDeviceEnrolmentException, WindowsOperationException,
             NotificationManagementException, WindowsConfigurationException;
 

components/mobile-plugins/windows-plugin/org.wso2.carbon.device.mgt.mobile.windows.api/src/main/java/org/wso2/carbon/device/mgt/mobile/windows/api/services/discovery/DiscoveryService.java

@@ -18,8 +18,6 @@
 
 package org.wso2.carbon.device.mgt.mobile.windows.api.services.discovery;
 
-import io.swagger.annotations.*;
-import org.wso2.carbon.device.mgt.common.operation.mgt.Activity;
 import org.wso2.carbon.device.mgt.mobile.windows.api.common.PluginConstants;
 import org.wso2.carbon.device.mgt.mobile.windows.api.common.exceptions.WindowsDeviceEnrolmentException;
 import org.wso2.carbon.device.mgt.mobile.windows.api.services.discovery.beans.DiscoveryRequest;
@@ -27,13 +25,8 @@ import org.wso2.carbon.device.mgt.mobile.windows.api.services.discovery.beans.Di
 
 import javax.jws.WebMethod;
 import javax.jws.WebParam;
-import javax.jws.WebResult;
 import javax.jws.WebService;
-import javax.ws.rs.GET;
 import javax.ws.rs.POST;
-import javax.ws.rs.Path;
-import javax.ws.rs.core.MediaType;
-import javax.ws.rs.core.Response;
 import javax.xml.ws.BindingType;
 import javax.xml.ws.RequestWrapper;
 import javax.xml.ws.ResponseWrapper;
@@ -48,68 +41,12 @@ import javax.xml.ws.soap.SOAPBinding;
 @BindingType(value = SOAPBinding.SOAP12HTTP_BINDING)
 public interface DiscoveryService {
     @POST
-    @ApiOperation(
+
-            httpMethod = "POST",
-            value = "Discovering the server Enrollment policy and Enrollment service Endpoints.",
-            notes = "Using this API to discover the Enrollment policy,Enrollment service and " +
-                    "federated login page server endpoints in the server. ",
-            response = DiscoveryResponse.class,
-            tags = "Windows Device Enrollment.",
-            authorizations = {
-                    @Authorization(
-                            value = "permission",
-                            scopes = {@AuthorizationScope(
-                                    scope = "/device-mgt/devices/enroll/windows",
-                                    description = "Discover the service endpoints.")}
-                    )
-            }
-    )
-    @ApiResponses(value = {
-            @ApiResponse(
-                    code = 200,
-                    message = "Ok. \n Accepted and getting server endpoints.",
-                    response = DiscoveryResponse.class,
-                    responseHeaders = {
-                            @ResponseHeader(
-                                    name = "Content-Location",
-                                    description = "URL of the activity instance."),
-                            @ResponseHeader(
-                                    name = "Content-Type",
-                                    description = "Content type of the body"),
-                            @ResponseHeader(
-                                    name = "ETag",
-                                    description = "Entity Tag of the response resource.\n" +
-                                            "Used by caches, or in conditional requests."),
-                            @ResponseHeader(
-                                    name = "Last-Modified",
-                                    description = "Date and time the resource was last modified. \n" +
-                                            "Used by caches, or in conditional requests.")}),
-            @ApiResponse(
-                    code = 303,
-                    message = "See Other. \n The source can be retrieved from the URLr.",
-                    responseHeaders = {
-                            @ResponseHeader(
-                                    name = "Content-Location",
-                                    description = "The Source URL of the document.")}),
-            @ApiResponse(
-                    code = 400,
-                    message = "Bad Request. \n Invalid request or validation error."),
-            @ApiResponse(
-                    code = 415,
-                    message = "Unsupported media type. \n The format of the requested entity was not supported.\n"),
-            @ApiResponse(
-                    code = 500,
-                    message = "Internal Server Error. \n " +
-                            "Server error occurred while fetching the server endpoints.")
-    })
     @RequestWrapper(localName = "Discover", targetNamespace = PluginConstants.DISCOVERY_SERVICE_TARGET_NAMESPACE)
     @WebMethod(operationName = "Discover")
     @ResponseWrapper(localName = "DiscoverResponse", targetNamespace = PluginConstants.DISCOVERY_SERVICE_TARGET_NAMESPACE)
     void discover(
             @WebParam(name = "request", targetNamespace = PluginConstants.DISCOVERY_SERVICE_TARGET_NAMESPACE)
-            @ApiParam(
-                    name = "DiscoveryRequest",
-                    value = "Discovery service SOAP request.")
             DiscoveryRequest request,
             @WebParam(mode = WebParam.Mode.OUT, name = "DiscoverResult",
                     targetNamespace = PluginConstants.DISCOVERY_SERVICE_TARGET_NAMESPACE)

components/mobile-plugins/windows-plugin/org.wso2.carbon.device.mgt.mobile.windows.api/src/main/java/org/wso2/carbon/device/mgt/mobile/windows/api/services/enrollment/EnrollmentService.java

@@ -18,7 +18,6 @@
 
 package org.wso2.carbon.device.mgt.mobile.windows.api.services.enrollment;
 
-import io.swagger.annotations.*;
 import org.wso2.carbon.device.mgt.mobile.windows.api.common.PluginConstants;
 import org.wso2.carbon.device.mgt.mobile.windows.api.common.exceptions.WAPProvisioningException;
 import org.wso2.carbon.device.mgt.mobile.windows.api.common.exceptions.WindowsDeviceEnrolmentException;
@@ -45,59 +44,6 @@ public interface EnrollmentService {
     @ResponseWrapper(localName = "RequestSecurityTokenResponseCollection", targetNamespace =
             PluginConstants.WS_TRUST_TARGET_NAMESPACE)
     @POST
-    @ApiOperation(
-            httpMethod = "POST",
-            value = "Signing the certificate signing request(CSR) and provide request security token response.",
-            notes = "Using this API to fetching more information to enroll the Device and " +
-                    "getting pending operations.",
-            tags = "Windows 10 Device Enrollment Service.",
-            authorizations = {
-                    @Authorization(
-                            value = "permission",
-                            scopes = {@AuthorizationScope(
-                                    scope = "/device-mgt/devices/enroll/windows",
-                                    description = "Signing the certificate signing request(CSR) " +
-                                            "and provide request security token response")}
-                    )
-            }
-    )
-    @ApiResponses(value = {
-            @ApiResponse(
-                    code = 200,
-                    message = "Ok.Successfully signed the CSR.",
-                    responseHeaders = {
-                            @ResponseHeader(
-                                    name = "Content-Location",
-                                    description = "URL of the activity instance that refers to the scheduled operation."),
-                            @ResponseHeader(
-                                    name = "Content-Type",
-                                    description = "Content type of the body"),
-                            @ResponseHeader(
-                                    name = "ETag",
-                                    description = "Entity Tag of the response resource.\n" +
-                                            "Used by caches, or in conditional requests."),
-                            @ResponseHeader(
-                                    name = "Last-Modified",
-                                    description = "Date and time the resource was last modified. \n" +
-                                            "Used by caches, or in conditional requests.")}),
-            @ApiResponse(
-                    code = 303,
-                    message = "See Other. \n The source can be retrieved from the URL specified in the location header.",
-                    responseHeaders = {
-                            @ResponseHeader(
-                                    name = "Content-Location",
-                                    description = "The Source URL of the document.")}),
-            @ApiResponse(
-                    code = 400,
-                    message = "Bad Request. \n Invalid request or validation error."),
-            @ApiResponse(
-                    code = 415,
-                    message = "Unsupported media type. \n The format of the requested entity was not supported.\n"),
-            @ApiResponse(
-                    code = 500,
-                    message = "Internal Server Error. \n " +
-                            "Server error occurred while Signing the CSR.")
-    })
     void requestSecurityToken(
             @WebParam(name = "TokenType", targetNamespace = PluginConstants.WS_TRUST_TARGET_NAMESPACE)
             String tokenType,

components/mobile-plugins/windows-plugin/org.wso2.carbon.device.mgt.mobile.windows.api/src/main/java/org/wso2/carbon/device/mgt/mobile/windows/api/services/syncml/SyncmlService.java

@@ -18,12 +18,10 @@
 
 package org.wso2.carbon.device.mgt.mobile.windows.api.services.syncml;
 
-import io.swagger.annotations.*;
 import org.w3c.dom.Document;
 import org.wso2.carbon.apimgt.annotations.api.Scope;
 import org.wso2.carbon.apimgt.annotations.api.Scopes;
 import org.wso2.carbon.device.mgt.common.notification.mgt.NotificationManagementException;
-import org.wso2.carbon.device.mgt.common.operation.mgt.Activity;
 import org.wso2.carbon.device.mgt.mobile.windows.api.common.PluginConstants;
 import org.wso2.carbon.device.mgt.mobile.windows.api.common.exceptions.WindowsConfigurationException;
 import org.wso2.carbon.device.mgt.mobile.windows.api.common.exceptions.WindowsDeviceEnrolmentException;
@@ -57,59 +55,6 @@ public interface SyncmlService {
     @POST
     @Consumes({PluginConstants.SYNCML_MEDIA_TYPE, MediaType.APPLICATION_XML})
     @Produces(PluginConstants.SYNCML_MEDIA_TYPE)
-    @ApiOperation(
-            httpMethod = "POST",
-            value = "Getting pending operations for Windows device.",
-            notes = "Using this API to fetching more information to enroll the Device and " +
-                    "getting pending operations.",
-            tags = "Windows Device Management Administrative Service",
-            authorizations = {
-                    @Authorization(
-                            value = "permission",
-                            scopes = {@AuthorizationScope(
-                                    scope = "/device-mgt/devices/enroll/windows",
-                                    description = "Getting pending operations and " +
-                                            "device information to enroll the device")}
-                    )
-            }
-    )
-    @ApiResponses(value = {
-            @ApiResponse(
-                    code = 201,
-                    message = "Ok. \n Successfully getting pending operations.",
-                    responseHeaders = {
-                            @ResponseHeader(
-                                    name = "Content-Location",
-                                    description = "URL of the activity instance that refers to the scheduled operation."),
-                            @ResponseHeader(
-                                    name = "Content-Type",
-                                    description = "Content type of the body"),
-                            @ResponseHeader(
-                                    name = "ETag",
-                                    description = "Entity Tag of the response resource.\n" +
-                                            "Used by caches, or in conditional requests."),
-                            @ResponseHeader(
-                                    name = "Last-Modified",
-                                    description = "Date and time the resource was last modified. \n" +
-                                            "Used by caches, or in conditional requests.")}),
-            @ApiResponse(
-                    code = 303,
-                    message = "See Other. \n The source can be retrieved from the URL specified in the location header.",
-                    responseHeaders = {
-                            @ResponseHeader(
-                                    name = "Content-Location",
-                                    description = "The Source URL of the document.")}),
-            @ApiResponse(
-                    code = 400,
-                    message = "Bad Request. \n Invalid request or validation error."),
-            @ApiResponse(
-                    code = 415,
-                    message = "Unsupported media type. \n The format of the requested entity was not supported.\n"),
-            @ApiResponse(
-                    code = 500,
-                    message = "Internal Server Error. \n " +
-                            "Server error occurred while getting pending operations.")
-    })
     Response getResponse(Document request) throws WindowsDeviceEnrolmentException, WindowsOperationException,
             NotificationManagementException, WindowsConfigurationException;
 

components/mobile-plugins/windows-plugin/org.wso2.carbon.device.mgt.mobile.windows.api/src/main/java/org/wso2/carbon/device/mgt/mobile/windows/api/services/wstep/CertificateEnrollmentService.java

@@ -52,59 +52,6 @@ public interface CertificateEnrollmentService {
     @ResponseWrapper(localName = "RequestSecurityTokenResponseCollection", targetNamespace =
             PluginConstants.WS_TRUST_TARGET_NAMESPACE)
     @POST
-    @ApiOperation(
-            httpMethod = "POST",
-            value = "Signing the certificate signing request(CSR) and provide request security token response.",
-            notes = "Using this API to fetching more information to enroll the Device and " +
-                    "getting pending operations.",
-            tags = "Windows Device Enrollment Service.",
-            authorizations = {
-                    @Authorization(
-                            value = "permission",
-                            scopes = {@AuthorizationScope(
-                                    scope = "/device-mgt/devices/enroll/windows",
-                                    description = "GSigning the certificate signing request(CSR) " +
-                                            "and provide request security token response")}
-                    )
-            }
-    )
-    @ApiResponses(value = {
-            @ApiResponse(
-                    code = 200,
-                    message = "Ok.Successfully signed the CSR.",
-                    responseHeaders = {
-                            @ResponseHeader(
-                                    name = "Content-Location",
-                                    description = "URL of the activity instance that refers to the scheduled operation."),
-                            @ResponseHeader(
-                                    name = "Content-Type",
-                                    description = "Content type of the body"),
-                            @ResponseHeader(
-                                    name = "ETag",
-                                    description = "Entity Tag of the response resource.\n" +
-                                            "Used by caches, or in conditional requests."),
-                            @ResponseHeader(
-                                    name = "Last-Modified",
-                                    description = "Date and time the resource was last modified. \n" +
-                                            "Used by caches, or in conditional requests.")}),
-            @ApiResponse(
-                    code = 303,
-                    message = "See Other. \n The source can be retrieved from the URL specified in the location header.",
-                    responseHeaders = {
-                            @ResponseHeader(
-                                    name = "Content-Location",
-                                    description = "The Source URL of the document.")}),
-            @ApiResponse(
-                    code = 400,
-                    message = "Bad Request. \n Invalid request or validation error."),
-            @ApiResponse(
-                    code = 415,
-                    message = "Unsupported media type. \n The format of the requested entity was not supported.\n"),
-            @ApiResponse(
-                    code = 500,
-                    message = "Internal Server Error. \n " +
-                            "Server error occurred while Signing the CSR.")
-    })
     void requestSecurityToken(
             @WebParam(name = "TokenType", targetNamespace = PluginConstants.WS_TRUST_TARGET_NAMESPACE)
             String tokenType,

components/mobile-plugins/windows-plugin/org.wso2.carbon.device.mgt.mobile.windows.api/src/main/java/org/wso2/carbon/device/mgt/mobile/windows/api/services/xcep/CertificateEnrollmentPolicyService.java

@@ -18,7 +18,6 @@
 
 package org.wso2.carbon.device.mgt.mobile.windows.api.services.xcep;
 
-import io.swagger.annotations.*;
 import org.wso2.carbon.device.mgt.mobile.windows.api.common.PluginConstants;
 import org.wso2.carbon.device.mgt.mobile.windows.api.services.xcep.beans.*;
 
@@ -27,7 +26,6 @@ import javax.jws.WebParam;
 import javax.jws.WebService;
 import javax.ws.rs.Consumes;
 import javax.ws.rs.POST;
-import javax.ws.rs.Path;
 import javax.ws.rs.Produces;
 import javax.ws.rs.core.MediaType;
 import javax.xml.bind.annotation.XmlSeeAlso;
@@ -56,59 +54,6 @@ public interface CertificateEnrollmentPolicyService {
     @POST
     @Consumes({PluginConstants.SYNCML_MEDIA_TYPE, MediaType.APPLICATION_XML})
     @Produces(PluginConstants.SYNCML_MEDIA_TYPE)
-    @ApiOperation(
-            httpMethod = "POST",
-            value = "Getting pending operations for Windows device.",
-            notes = "Using this API to fetching more information to enroll the Device and " +
-                    "getting pending operations.",
-            tags = "Windows Device Management Administrative Service",
-            authorizations = {
-                    @Authorization(
-                            value = "permission",
-                            scopes = {@AuthorizationScope(
-                                    scope = "/device-mgt/devices/enroll/windows",
-                                    description = "Getting pending operations and " +
-                                            "device information to enroll the device")}
-                    )
-            }
-    )
-    @ApiResponses(value = {
-            @ApiResponse(
-                    code = 201,
-                    message = "Ok. \n Successfully getting pending operations.",
-                    responseHeaders = {
-                            @ResponseHeader(
-                                    name = "Content-Location",
-                                    description = "URL of the activity instance that refers to the scheduled operation."),
-                            @ResponseHeader(
-                                    name = "Content-Type",
-                                    description = "Content type of the body"),
-                            @ResponseHeader(
-                                    name = "ETag",
-                                    description = "Entity Tag of the response resource.\n" +
-                                            "Used by caches, or in conditional requests."),
-                            @ResponseHeader(
-                                    name = "Last-Modified",
-                                    description = "Date and time the resource was last modified. \n" +
-                                            "Used by caches, or in conditional requests.")}),
-            @ApiResponse(
-                    code = 303,
-                    message = "See Other. \n The source can be retrieved from the URL specified in the location header.",
-                    responseHeaders = {
-                            @ResponseHeader(
-                                    name = "Content-Location",
-                                    description = "The Source URL of the document.")}),
-            @ApiResponse(
-                    code = 400,
-                    message = "Bad Request. \n Invalid request or validation error."),
-            @ApiResponse(
-                    code = 415,
-                    message = "Unsupported media type. \n The format of the requested entity was not supported.\n"),
-            @ApiResponse(
-                    code = 500,
-                    message = "Internal Server Error. \n " +
-                            "Server error occurred while getting pending operations.")
-    })
     void getPolicies(
             @WebParam(name = "client", targetNamespace = PluginConstants.
                     ENROLLMENT_POLICY_TARGET_NAMESPACE)