From: Teryk Bellahsene <teryk.bellahsene@sonarsource.com>
Date: Fri, 11 Nov 2016 08:59:30 +0000 (+0100)
Subject: SONAR-8313 Describe filter field in WS api/components/search_projects
X-Git-Tag: 6.2-RC1~124
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=103982f1e5a6a2e6484241e814bfb0ef082dce71;p=sonarqube.git

SONAR-8313 Describe filter field in WS api/components/search_projects
---

diff --git a/server/sonar-server/src/main/java/org/sonar/server/component/ws/SearchProjectsAction.java b/server/sonar-server/src/main/java/org/sonar/server/component/ws/SearchProjectsAction.java
index 3f1f5256afe..1e13d6be6fb 100644
--- a/server/sonar-server/src/main/java/org/sonar/server/component/ws/SearchProjectsAction.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/component/ws/SearchProjectsAction.java
@@ -87,7 +87,16 @@ public class SearchProjectsAction implements ComponentsWsAction {
       .setPossibleValues(SUPPORTED_FACETS);
     action
       .createParam(PARAM_FILTER)
-      .setDescription("TODO");
+      .setDescription("Filter projects on measure value, quality gate or whether a project is a favorite or not.<br>" +
+        "Examples of use:" +
+        "<ul>" +
+        " <li>to filter my favorite projects with a coverage strictly between 60% and 80%: filter=\"isFavorite and coverage > 60 and coverage < 80\"</li>" +
+        " <li>to filter projects with a Failed quality gate: filter=\"alert_status = ERROR\"</li>" +
+        " <li>to filter my favorite projects with a coverage lower than or equals to 80% and with a Passed Quality Gate: " +
+        "filter=\"isFavorite and coverage <= 80 and alert_status=OK\"</li>" +
+        " <li>to filter projects with a reliability, security and maintainability rating equals or worse than B: " +
+        "filter=\"reliability_rating>=2 and security_rating>=2 and sqale_rating>=2\"</li>" +
+        "</ul>");
   }
 
   @Override