From: Julien Lancelot <julien.lancelot@sonarsource.com>
Date: Fri, 18 Apr 2014 09:48:34 +0000 (+0200)
Subject: Set /api/rules/list as internal
X-Git-Tag: 4.3~9
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=cf5d6ed12b92c401091875f64c591d29786827f4;p=sonarqube.git

Set /api/rules/list as internal
---

diff --git a/sonar-server/src/main/java/org/sonar/server/rule/ws/RulesWs.java b/sonar-server/src/main/java/org/sonar/server/rule/ws/RulesWs.java
index 20ad416fd0f..d7a4dd13826 100644
--- a/sonar-server/src/main/java/org/sonar/server/rule/ws/RulesWs.java
+++ b/sonar-server/src/main/java/org/sonar/server/rule/ws/RulesWs.java
@@ -43,9 +43,10 @@ public class RulesWs implements WebService {
     controller.createAction("list")
       .setDescription("List rules that match the given criteria")
       .setSince("4.3")
+      .setInternal(true)
       .setHandler(searchHandler)
       .createParam("s", "To return rules whose title contains this string.")
-      .createParam("k", "An optional query that will be matched exactly agains rule keys.")
+      .createParam("k", "Key of the rule, for example : 'findbugs:DMI_USELESS_SUBSTRING'.")
       .createParam("languages", "Comma-separated list of language keys")
       .createParam("repositories", "Comma-separated list of repositories")
       .createParam("severities", "Comma-separated list of severities. Possible values: INFO | MINOR | MAJOR | CRITICAL | BLOCKER.")