SONAR-15892 Document the behaviour of api/users/search's query param

1 files changed, 12 insertions, 1 deletions

diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/user/ws/SearchAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/user/ws/SearchAction.java
index ded708fb6b5..3e623378f71 100644
--- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/user/ws/SearchAction.java
+++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/user/ws/SearchAction.java
@@ -104,7 +104,18 @@ public class SearchAction implements UsersWsAction {
 
     action.createParam(TEXT_QUERY)
       .setMinimumLength(2)
-      .setDescription("Filter on login, name and email");
+      .setDescription("Filter on login, name and email.<br />" +
+        "This parameter can either be case sensitive and perform an exact match, or case insensitive and perform a partial match (contains), depending on the scenario:<br />" +
+        "<ul>" +
+        "  <li>" +
+        "    If the search query is <em>less or equal to 15 characters</em>, then the query is <em>case insensitive</em>, and will match any login, name, or email, that " +
+        "    <em>contains</em> the search query." +
+        "  </li>" +
+        "  <li>" +
+        "    If the search query is <em>greater than 15 characters</em>, then the query becomes <em>case sensitive</em>, and will match any login, name, or email, that " +
+        "    <em>exactly matches</em> the search query." +
+        "  </li>" +
+        "</ul>");
   }
 
   @Override