commit cc730a66f5f0784bd13005833267933827397fb3
author Jian Li <pyguni@gmail.com> Tue May 10 16:36:16 2016 -0700
committer Gerrit Code Review <gerrit@onlab.us> Wed May 11 04:34:59 2016 +0000
tree 20568051815fa5a2e82c056430209c4079ce7b9a
parent 5617994076a5f5a90e8b5354316e36b9420a50d3

Clean up source code of REST API

- Add missing @Produces annotation
- Correct comments
- Restrict variable access level

Change-Id: I7f75650b83651248370e7781b1e8aec7eac2314c

web/api/src/main/java/org/onosproject/rest/resources/MastershipWebResource.java

diff --git a/web/api/src/main/java/org/onosproject/rest/resources/MastershipWebResource.java b/web/api/src/main/java/org/onosproject/rest/resources/MastershipWebResource.java
index 99cc28c..dcbf394 100644
--- a/web/api/src/main/java/org/onosproject/rest/resources/MastershipWebResource.java
+++ b/web/api/src/main/java/org/onosproject/rest/resources/MastershipWebResource.java
@@ -65,7 +65,7 @@
      * Returns the role of the local node for the specified device.
      *
      * @param deviceId device identifier
-     * @return role of the current node
+     * @return 200 OK with role of the current node
      * @onos.rsModel MastershipRole
      */
     @GET
@@ -81,7 +81,7 @@
      * Returns the current master for a given device.
      *
      * @param deviceId device identifier
-     * @return the identifier of the master controller for the device
+     * @return 200 OK with the identifier of the master controller for the device
      * @onos.rsModel NodeId
      */
     @GET
@@ -101,7 +101,7 @@
      * preference. The first entry in the list is the current master.
      *
      * @param deviceId device identifier
-     * @return a list of controller identifiers
+     * @return 200 OK with a list of controller identifiers
      * @onos.rsModel RoleInfo
      */
     @GET
@@ -118,7 +118,7 @@
      * Returns the devices for which a controller is master.
      *
      * @param nodeId controller identifier
-     * @return a set of device identifiers
+     * @return 200 OK with a set of device identifiers
      * @onos.rsModel DeviceIds
      */
     @GET
@@ -141,7 +141,7 @@
      * device forcing master selection if necessary.
      *
      * @param deviceId device identifier
-     * @return the role of this controller instance
+     * @return 200 OK with the role of this controller instance
      * @onos.rsModel MastershipRole
      */
     @GET
@@ -160,7 +160,7 @@
      * for this device, no master selection will occur.
      *
      * @param deviceId device identifier
-     * @return status of the request
+     * @return status of the request - CREATED if the JSON is correct
      */
     @GET
     @Produces(MediaType.APPLICATION_JSON)
@@ -181,7 +181,6 @@
      */
     @PUT
     @Consumes(MediaType.APPLICATION_JSON)
-    @Produces(MediaType.APPLICATION_JSON)
     public Response setRole(InputStream stream) {
 
         try {