From: lukasz-jarocki-sonarsource <lukasz.jarocki@sonarsource.com>
Date: Tue, 26 Mar 2024 15:08:36 +0000 (+0100)
Subject: SONAR-21602 improved docs for /api/components/search
X-Git-Tag: 10.5.0.89998~86
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=b4f4de2e39e4d51ed983179cf725b2cabb2ef63e;p=sonarqube.git

SONAR-21602 improved docs for /api/components/search
---

diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/component/ws/SearchAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/component/ws/SearchAction.java
index 0f06dde4ec2..c5ab1572ebd 100644
--- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/component/ws/SearchAction.java
+++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/component/ws/SearchAction.java
@@ -40,6 +40,7 @@ import org.sonar.server.component.index.ComponentIndex;
 import org.sonar.server.component.index.ComponentQuery;
 import org.sonar.server.es.SearchIdResult;
 import org.sonar.server.es.SearchOptions;
+import org.sonar.server.es.newindex.DefaultIndexSettings;
 import org.sonarqube.ws.Components;
 import org.sonarqube.ws.Components.SearchWsResponse;
 
@@ -90,7 +91,9 @@ public class SearchAction implements ComponentsWsAction {
       .setDescription("Limit search to: <ul>" +
         "<li>component names that contain the supplied string</li>" +
         "<li>component keys that are exactly the same as the supplied string</li>" +
-        "</ul>")
+        "</ul><br>" +
+        "The value length of the param must be between " + DefaultIndexSettings.MINIMUM_NGRAM_LENGTH + " and " +
+        DefaultIndexSettings.MAXIMUM_NGRAM_LENGTH + " (inclusive) characters. In case longer value is provided it will be truncated.")
       .setExampleValue("sonar");
 
     createQualifiersParameter(action, newQualifierParameterContext(i18n, resourceTypes), VALID_QUALIFIERS)