From: Julien Lancelot <julien.lancelot@sonarsource.com>
Date: Wed, 28 Mar 2018 08:22:00 +0000 (+0200)
Subject: SONAR-10342 Improve some ws description
X-Git-Tag: 7.5~1421
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=2cf5df7861fd9dc81abde2d4c63edb86a065b3c6;p=sonarqube.git

SONAR-10342 Improve some ws description
---

diff --git a/server/sonar-server/src/main/java/org/sonar/server/user/ws/SearchAction.java b/server/sonar-server/src/main/java/org/sonar/server/user/ws/SearchAction.java
index 64c6cb335b4..b869f805f22 100644
--- a/server/sonar-server/src/main/java/org/sonar/server/user/ws/SearchAction.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/user/ws/SearchAction.java
@@ -20,7 +20,6 @@
 package org.sonar.server.user.ws;
 
 import com.google.common.collect.Multimap;
-
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
@@ -108,7 +107,7 @@ public class SearchAction implements UsersWsAction {
 
     action.createParam(TEXT_QUERY)
       .setMinimumLength(2)
-      .setDescription("Filter on login or name.");
+      .setDescription("Filter on login, name and email");
   }
 
   @Override
diff --git a/server/sonar-server/src/test/java/org/sonar/server/component/ws/SearchActionTest.java b/server/sonar-server/src/test/java/org/sonar/server/component/ws/SearchActionTest.java
index 72e26463c8c..246c8ef682e 100644
--- a/server/sonar-server/src/test/java/org/sonar/server/component/ws/SearchActionTest.java
+++ b/server/sonar-server/src/test/java/org/sonar/server/component/ws/SearchActionTest.java
@@ -20,7 +20,6 @@
 package org.sonar.server.component.ws;
 
 import com.google.common.base.Joiner;
-import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -127,7 +126,7 @@ public class SearchActionTest {
     assertThat(pageSize.isRequired()).isFalse();
     assertThat(pageSize.defaultValue()).isEqualTo("100");
     assertThat(pageSize.maximumValue()).isEqualTo(500);
-    assertThat(pageSize.description()).isEqualTo("Page size. Must be greater than 0 and less than 500");
+    assertThat(pageSize.description()).isEqualTo("Page size. Must be greater than 0 and less or equal than 500");
 
     WebService.Param qualifiers = action.param("qualifiers");
     assertThat(qualifiers.isRequired()).isTrue();
diff --git a/server/sonar-server/src/test/java/org/sonar/server/organization/ws/SearchActionTest.java b/server/sonar-server/src/test/java/org/sonar/server/organization/ws/SearchActionTest.java
index 4294078260c..74927b7fb91 100644
--- a/server/sonar-server/src/test/java/org/sonar/server/organization/ws/SearchActionTest.java
+++ b/server/sonar-server/src/test/java/org/sonar/server/organization/ws/SearchActionTest.java
@@ -98,7 +98,7 @@ public class SearchActionTest {
     assertThat(pageSize.isRequired()).isFalse();
     assertThat(pageSize.defaultValue()).isEqualTo("100");
     assertThat(pageSize.maximumValue()).isEqualTo(500);
-    assertThat(pageSize.description()).isEqualTo("Page size. Must be greater than 0 and less than 500");
+    assertThat(pageSize.description()).isEqualTo("Page size. Must be greater than 0 and less or equal than 500");
 
     WebService.Param member = action.param("member");
     assertThat(member.since()).isEqualTo("7.0");
diff --git a/server/sonar-server/src/test/java/org/sonar/server/project/ws/SearchActionTest.java b/server/sonar-server/src/test/java/org/sonar/server/project/ws/SearchActionTest.java
index 04d6aaf3fd7..bb6f7739efd 100644
--- a/server/sonar-server/src/test/java/org/sonar/server/project/ws/SearchActionTest.java
+++ b/server/sonar-server/src/test/java/org/sonar/server/project/ws/SearchActionTest.java
@@ -387,7 +387,7 @@ public class SearchActionTest {
     Param psParam = action.param("ps");
     assertThat(psParam.isRequired()).isFalse();
     assertThat(psParam.defaultValue()).isEqualTo("100");
-    assertThat(psParam.description()).isEqualTo("Page size. Must be greater than 0 and less than 500");
+    assertThat(psParam.description()).isEqualTo("Page size. Must be greater than 0 and less or equal than 500");
 
     Param visibilityParam = action.param("visibility");
     assertThat(visibilityParam.isRequired()).isFalse();
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/server/ws/WebService.java b/sonar-plugin-api/src/main/java/org/sonar/api/server/ws/WebService.java
index 90d3e237a54..10d6868499e 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/server/ws/WebService.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/server/ws/WebService.java
@@ -390,7 +390,7 @@ public interface WebService extends Definable<WebService.Context> {
         .setDeprecatedKey("pageSize", "5.2")
         .setDefaultValue(String.valueOf(defaultPageSize))
         .setMaximumValue(maxPageSize)
-        .setDescription("Page size. Must be greater than 0 and less than " + maxPageSize)
+        .setDescription("Page size. Must be greater than 0 and less or equal than " + maxPageSize)
         .setExampleValue("20");
     }