created interfaces for the api classes in order add swagger definitions

9 years ago · 36c3a057dc
parent f5915cbf5d
commit 36c3a057dc
9 changed files with 49 additions and 49 deletions
--- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Authentication.java
+++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Authentication.java
@ -24,7 +24,7 @@ import javax.ws.rs.Consumes;
 import javax.ws.rs.Produces;

 /**
- * AuthenticationImpl related REST-API interface.
+ * Authentication related REST-API interface.
 */
@Api(value = "Authentication")
@Produces({ "application/json", "application/xml" })
--- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Configuration.java
+++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Configuration.java
@ -25,7 +25,7 @@ import javax.ws.rs.*;
 import javax.ws.rs.core.Response;

 /**
- * General Tenant ConfigurationImpl REST-API implementation.
+ * General Tenant Configuration REST-API implementation.
 * All end points support JSON, XMl with content negotiation.
 */
@Api(value = "Configuration", description = "General Tenant Configuration implementation")
--- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Device.java
+++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Device.java
@ -36,7 +36,7 @@ public interface Device {
     * Get all devices. We have to use accept all the necessary query parameters sent by datatable.
     * Hence had to put lot of query params here.
     *
-     * @return DeviceImpl List
+     * @return Device List
     */
    @GET
    @ApiOperation(
@ -63,7 +63,7 @@ public interface Device {
    /**
     * Fetch device details for a given device type and device Id.
     *
-     * @return DeviceImpl wrapped inside Response
+     * @return Device wrapped inside Response
     */
    @GET
    @ApiOperation(
@ -81,8 +81,8 @@ public interface Device {
    /**
     * Fetch device details of a given user.
     *
-     * @param user         UserImpl Name
-     * @return DeviceImpl
+     * @param user         User Name
+     * @return Device
     */
    @GET
    @Path("user/{user}")
@ -91,8 +91,8 @@ public interface Device {
    /**
     * Fetch device count of a given user.
     *
-     * @param user UserImpl Name
-     * @return DeviceImpl
+     * @param user User Name
+     * @return Device
     */
    @GET
    @Path("user/{user}/count")
@ -117,7 +117,7 @@ public interface Device {
    /**
     * Get the list of devices that matches with the given name.
     *
-     * @param deviceName   DeviceImpl name
+     * @param deviceName   Device name
     * @param tenantDomain Callee tenant domain
     * @return list of devices.
     */
--- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/DeviceNotification.java
+++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/DeviceNotification.java
@ -31,7 +31,7 @@ import javax.ws.rs.Produces;
 import javax.ws.rs.core.Response;

 /**
- * DeviceNotificationImpl management REST-API implementation.
+ * DeviceNotification management REST-API implementation.
 * All end points support JSON, XMl with content negotiation.
 */
@Api(value = "DeviceNotification")
--- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Feature.java
+++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Feature.java
@ -37,9 +37,9 @@ import javax.ws.rs.core.Response;
 public interface Feature {

    /**
-     * Get all features for Mobile DeviceImpl Type
+     * Get all features for Mobile Device Type
     *
-     * @return FeatureImpl
+     * @return Feature
     */
    @GET
    @Path("/{type}")
--- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/License.java
+++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/License.java
@ -34,7 +34,7 @@ public interface License {
    /**
     * This method returns the license text related to a given device type and language code.
     *
-     * @param deviceType   DeviceImpl type, ex: android, ios
+     * @param deviceType   Device type, ex: android, ios
     * @param languageCode Language code, ex: en_US
     * @return Returns the license text
     */
@ -47,8 +47,8 @@ public interface License {
    /**
     * This method is used to add license to a specific device type.
     *
-     * @param deviceType DeviceImpl type, ex: android, ios
-     * @param license LicenseImpl object
+     * @param deviceType Device type, ex: android, ios
+     * @param license License object
     * @return Returns the acknowledgement for the action
     */
    @POST
--- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/User.java
+++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/User.java
@ -36,7 +36,7 @@ import javax.ws.rs.core.Response;
 import java.util.List;

 /**
- * This represents the JAX-RS services of UserImpl related functionality.
+ * This represents the JAX-RS services of User related functionality.
 */
@Api(value = "User")
 public interface User {
--- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/webapp/META-INF/permissions.xml
+++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/webapp/META-INF/permissions.xml
@ -2,19 +2,19 @@
 <!--
  ~ Copyright (c) 2016, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
  ~
-  ~ WSO2 Inc. licenses this file to you under the Apache LicenseImpl,
-  ~ Version 2.0 (the "LicenseImpl"); you may not use this file except
-  ~ in compliance with the LicenseImpl.
-  ~ You may obtain a copy of the LicenseImpl at
+  ~ WSO2 Inc. licenses this file to you under the Apache License,
+  ~ Version 2.0 (the "License"); you may not use this file except
+  ~ in compliance with the License.
+  ~ You may obtain a copy of the License at
  ~
  ~ http://www.apache.org/licenses/LICENSE-2.0
  ~
  ~ Unless required by applicable law or agreed to in writing,
-  ~ software distributed under the LicenseImpl is distributed on an
+  ~ software distributed under the License is distributed on an
  ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-  ~ KIND, either express or implied. See the LicenseImpl for the
+  ~ KIND, either express or implied. See the License for the
  ~ specific language governing permissions and limitations
-  ~ under the LicenseImpl.
+  ~ under the License.
  -->

 <!-- This file contains the list of permissions that are associated with URL end points
@ -29,7 +29,7 @@
 -->
 <PermissionConfiguration>
    <APIVersion></APIVersion>
-    <!-- DeviceImpl related APIs -->
+    <!-- Device related APIs -->

    <Permission>
        <name>Device Management</name>
@ -262,7 +262,7 @@
        <url>/devices/user/*</url>
        <method>GET</method>
    </Permission>
-    <!-- End of DeviceImpl related APIs -->
+    <!-- End of Device related APIs -->

    <!-- Notification related APIs -->
    <Permission>
@ -373,7 +373,7 @@
    </Permission>

    <!--<Permission>-->
-        <!--<name>Get Applications For DeviceImpl Type</name>-->
+        <!--<name>Get Applications For Device Type</name>-->
        <!--<path>/device-mgt/operations/application/view</path>-->
        <!--<url>/operations/*</url>-->
        <!--<method>GET</method>-->
@ -381,7 +381,7 @@
    <!--</Permission>-->
    <!-- End of Operations related APIs -->

-    <!-- FeatureImpl related APIs -->
+    <!-- Feature related APIs -->
    <Permission>
        <name>List policies</name>
        <path>/device-mgt/admin/policies/list</path>
@ -410,9 +410,9 @@
        <method>GET</method>
        
    </Permission>
-    <!-- End of FeatureImpl related APIs -->
+    <!-- End of Feature related APIs -->

-    <!-- RoleImpl related APIs -->
+    <!-- Role related APIs -->
    <Permission>
        <name>List roles</name>
        <path>/device-mgt/admin/roles/list</path>
@ -504,9 +504,9 @@
        <url>/roles/count</url>
        <method>GET</method>
    </Permission>
-    <!-- End of RoleImpl related APIs -->
+    <!-- End of Role related APIs -->

-    <!-- UserImpl related APIs -->
+    <!-- User related APIs -->
    <Permission>
        <name>List users</name>
        <path>/device-mgt/admin/users/list</path>
@ -660,9 +660,9 @@
        <url>/users/authorize</url>
        <method>POST</method>
    </Permission>
-    <!-- End of UserImpl related APIs -->
+    <!-- End of User related APIs -->

-    <!-- PolicyImpl related APIs -->
+    <!-- Policy related APIs -->
    <Permission>
        <name>Add Policy</name>
        <path>/device-mgt/admin/policies/add</path>
@ -816,9 +816,9 @@
        <url>/policies/*/*</url>
        <method>GET</method>
    </Permission>
-    <!-- End of PolicyImpl related APIs -->
+    <!-- End of Policy related APIs -->

-    <!-- ProfileImpl related APIs -->
+    <!-- Profile related APIs -->
    <Permission>
        <name>Add policy</name>
        <path>/device-mgt/admin/policies/add</path>
@ -839,7 +839,7 @@
        <url>/profiles/*</url>
        <method>DELETE</method>
    </Permission>
-    <!-- End of ProfileImpl related APIs -->
+    <!-- End of Profile related APIs -->

    <!--Start of the device search and information -->

@ -860,7 +860,7 @@
    <!--End of the device search and information -->


-    <!-- LicenseImpl related APIs -->
+    <!-- License related APIs -->
    <!--<Permission>-->
    <!--<name>Get license</name>-->
    <!--<path>/device-mgt/license/view</path>-->
@ -875,9 +875,9 @@
    <!--<method>POST</method>-->
    <!---->
    <!--</Permission>-->
-    <!-- End of LicenseImpl related APIs -->
+    <!-- End of License related APIs -->

-    <!-- ConfigurationImpl related APIs -->
+    <!-- Configuration related APIs -->
    <Permission>
        <name>View configuration</name>
        <path>/device-mgt/admin/platform-configs/view</path>
@ -899,9 +899,9 @@
        <method>PUT</method>
    </Permission>

-    <!-- End of ConfigurationImpl related APIs -->
+    <!-- End of Configuration related APIs -->

-    <!-- CertificateImpl related APIs -->
+    <!-- Certificate related APIs -->
    <Permission>
        <name>Save certificate in the database</name>
        <path>/device-mgt/android/certificate/save</path>
@ -920,7 +920,7 @@
        <url>/certificates/*</url>
        <method>DELETE</method>
    </Permission>
-    <!-- End of CertificateImpl related APIs -->
+    <!-- End of Certificate related APIs -->

    <!-- Group related APIs -->
    <Permission>
--- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/webapp/META-INF/webapp-classloading.xml
+++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/webapp/META-INF/webapp-classloading.xml
@ -3,19 +3,19 @@
 <!--
  ~ Copyright (c) 2015, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
  ~
-  ~ WSO2 Inc. licenses this file to you under the Apache LicenseImpl,
-  ~ Version 2.0 (the "LicenseImpl"); you may not use this file except
-  ~ in compliance with the LicenseImpl.
-  ~ You may obtain a copy of the LicenseImpl at
+  ~ WSO2 Inc. licenses this file to you under the Apache License,
+  ~ Version 2.0 (the "License"); you may not use this file except
+  ~ in compliance with the License.
+  ~ You may obtain a copy of the License at
  ~
  ~ http://www.apache.org/licenses/LICENSE-2.0
  ~
  ~ Unless required by applicable law or agreed to in writing,
-  ~ software distributed under the LicenseImpl is distributed on an
+  ~ software distributed under the License is distributed on an
  ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-  ~ KIND, either express or implied.  See the LicenseImpl for the
+  ~ KIND, either express or implied.  See the License for the
  ~ specific language governing permissions and limitations
-  ~ under the LicenseImpl.
+  ~ under the License.
  -->

 <!--