David Turner revision 1 comments fixed

Author: joshua-adams-1

rest-api-spec/src/main/resources/rest-api-spec/api/cluster.allocation_explain.json

@@ -24,19 +24,19 @@
     "params":{
       "index": {
         "type": "string",
-        "description": "Specifies the index within which we would like to describe the shard"
+        "description": "Index containing the shard to be explained"
       },
       "shard": {
         "type": "number",
-        "description": "Specifies the ID of the shard that you would like an explanation for"
+        "description": "Shard ID to be explained"
       },
       "primary": {
         "type":"boolean",
         "description":"If true, returns explanation for the primary shard for the given shard ID"
       },
       "current_node": {
         "type": "string",
-        "description": "Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node"
+        "description": "Node ID or the name of the node to only explain a shard that is currently located on the specified node"
       },
       "master_timeout":{
         "type":"time",

server/src/main/java/org/elasticsearch/rest/RestRequest.java

@@ -478,7 +478,7 @@ public int paramAsInt(String key, int defaultValue) {
         }
     }
 
-    public Integer paramAsInt(String key, Integer defaultValue) {
+    public Integer paramAsInteger(String key, Integer defaultValue) {
         String sValue = param(key);
         if (sValue == null) {
             return defaultValue;

server/src/main/java/org/elasticsearch/rest/action/admin/cluster/RestClusterAllocationExplainAction.java

@@ -77,7 +77,7 @@ public RestChannelConsumer prepareRequest(final RestRequest request, final NodeC
             );
 
             clusterAllocationExplainRequest.setShard(
-                request.paramAsInt(ClusterAllocationExplainRequest.SHARD_PARAMETER_NAME, clusterAllocationExplainRequest.getShard())
+                request.paramAsInteger(ClusterAllocationExplainRequest.SHARD_PARAMETER_NAME, clusterAllocationExplainRequest.getShard())
             );
 
             clusterAllocationExplainRequest.setPrimary(
@@ -89,7 +89,6 @@ public RestChannelConsumer prepareRequest(final RestRequest request, final NodeC
             );
         }
 
-        // This checks for optionally provided query parameters
         clusterAllocationExplainRequest.includeYesDecisions(
             request.paramAsBoolean(ClusterAllocationExplainRequest.INCLUDE_YES_DECISIONS_PARAMETER_NAME, false)
         );

server/src/test/java/org/elasticsearch/rest/RestRequestTests.java

@@ -120,38 +120,56 @@ public void testApplyContentParser() throws IOException {
         assertEquals(emptyMap(), source.get());
     }
 
-    public void testParseAsIntWithNoParameters() {
+    public void testParamAsIntWithNoParameters() {
         RestRequest restRequest = contentRestRequest("", emptyMap());
-        int defaultValue = -1;
+        int defaultValue = randomInt();
         String parameterKey = randomIdentifier();
 
         int value = restRequest.paramAsInt(parameterKey, defaultValue);
         assertEquals(defaultValue, value);
-
-        Integer value2 = restRequest.paramAsInt(parameterKey, Integer.valueOf(defaultValue));
-        assertEquals(defaultValue, value2.intValue());
     }
 
-    public void testParseAsIntWithIntegerParameter() {
+    public void testParamAsIntWithIntegerParameter() {
         String parameterKey = randomIdentifier();
         RestRequest restRequest = contentRestRequest("", singletonMap(parameterKey, "123"));
-        int defaultValue = -1;
+        int defaultValue = randomInt();
 
         int value = restRequest.paramAsInt(parameterKey, defaultValue);
         assertEquals(123, value);
-
-        Integer value2 = restRequest.paramAsInt(parameterKey, Integer.valueOf(defaultValue));
-        assertEquals(123, value2.intValue());
     }
 
-    public void testParseAsIntWithoutIntegerParameter() {
+    public void testParamAsIntWithoutIntegerParameter() {
         String parameterKey = randomIdentifier();
         RestRequest restRequest = contentRestRequest("", singletonMap(parameterKey, "123T"));
-        int defaultValue = -1;
+        int defaultValue = randomInt();
 
         assertThrows(IllegalArgumentException.class, () -> { restRequest.paramAsInt(parameterKey, defaultValue); });
+    }
+
+    public void testParamAsIntegerWithNoParameters() {
+        RestRequest restRequest = contentRestRequest("", emptyMap());
+        int defaultValue = randomInt();
+        String parameterKey = randomIdentifier();
+
+        Integer value2 = restRequest.paramAsInteger(parameterKey, defaultValue);
+        assertEquals(defaultValue, value2.intValue());
+    }
+
+    public void testParamAsIntegerWithIntegerParameter() {
+        String parameterKey = randomIdentifier();
+        RestRequest restRequest = contentRestRequest("", singletonMap(parameterKey, "123"));
+        int defaultValue = randomInt();
+
+        Integer value2 = restRequest.paramAsInteger(parameterKey, defaultValue);
+        assertEquals(123, value2.intValue());
+    }
+
+    public void testParamAsIntegerWithoutIntegerParameter() {
+        String parameterKey = randomIdentifier();
+        RestRequest restRequest = contentRestRequest("", singletonMap(parameterKey, "123T"));
+        int defaultValue = randomInt();
 
-        assertThrows(IllegalArgumentException.class, () -> { restRequest.paramAsInt(parameterKey, Integer.valueOf(defaultValue)); });
+        assertThrows(IllegalArgumentException.class, () -> { restRequest.paramAsInteger(parameterKey, defaultValue); });
     }
 
     public void testContentOrSourceParam() throws IOException {