From d019e89214bbc7024f8142c46153e884ccbd078c Mon Sep 17 00:00:00 2001
From: Simon Brandhof <simon.brandhof@sonarsource.com>
Date: Wed, 12 Apr 2017 22:05:09 +0200
Subject: [PATCH] SONAR-9129 fix some glitches in doc of api/qualityprofiles

---
 .../server/qualityprofile/ws/ActivateRuleAction.java     | 9 +++++----
 .../server/qualityprofile/ws/ActivateRulesAction.java    | 2 +-
 .../server/qualityprofile/ws/DeactivateRuleAction.java   | 2 +-
 3 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ActivateRuleAction.java b/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ActivateRuleAction.java
index a7972794a35..358a9b4cb6e 100644
--- a/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ActivateRuleAction.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ActivateRuleAction.java
@@ -36,6 +36,7 @@ import org.sonar.server.qualityprofile.RuleActivator;
 import org.sonar.server.qualityprofile.index.ActiveRuleIndexer;
 import org.sonar.server.user.UserSession;
 
+import static java.lang.String.format;
 import static org.sonarqube.ws.client.qualityprofile.QualityProfileWsParameters.ACTION_ACTIVATE_RULE;
 import static org.sonarqube.ws.client.qualityprofile.QualityProfileWsParameters.ActivateActionParameters.PARAM_PARAMS;
 import static org.sonarqube.ws.client.qualityprofile.QualityProfileWsParameters.ActivateActionParameters.PARAM_PROFILE_KEY;
@@ -69,7 +70,7 @@ public class ActivateRuleAction implements QProfileWsAction {
       .setSince("4.4");
 
     activate.createParam(PARAM_PROFILE_KEY)
-      .setDescription("Key of Quality profile, can be obtained through <code>api/profiles/list</code>")
+      .setDescription("Key of Quality profile, can be obtained through <code>api/qualityprofiles/search</code>")
       .setRequired(true)
       .setExampleValue(Uuids.UUID_EXAMPLE_01);
 
@@ -79,12 +80,12 @@ public class ActivateRuleAction implements QProfileWsAction {
       .setExampleValue("squid:AvoidCycles");
 
     activate.createParam(PARAM_SEVERITY)
-      .setDescription(String.format("Severity. Ignored if parameter %s is true.", PARAM_RESET))
+      .setDescription(format("Severity. Ignored if parameter %s is true.", PARAM_RESET))
       .setPossibleValues(Severity.ALL);
 
     activate.createParam(PARAM_PARAMS)
-      .setDescription(String.format("Parameters as semi-colon list of <key>=<value>, for example " +
-        "'<code>params=key1=v1;key2=v2</code>'. Ignored if parameter %s is true.", PARAM_RESET));
+      .setDescription(format("Parameters as semi-colon list of <key>=<value>. Ignored if parameter %s is true.", PARAM_RESET))
+    .setExampleValue("params=key1=v1;key2=v2");
 
     activate.createParam(PARAM_RESET)
       .setDescription("Reset severity and parameters of activated rule. Set the values defined on parent profile " +
diff --git a/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ActivateRulesAction.java b/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ActivateRulesAction.java
index c24ca57836d..be3752196d9 100644
--- a/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ActivateRulesAction.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ActivateRulesAction.java
@@ -66,7 +66,7 @@ public class ActivateRulesAction implements QProfileWsAction {
     defineRuleSearchParameters(activate);
 
     activate.createParam(PROFILE_KEY)
-      .setDescription("Quality Profile Key. To retrieve a profile key for a given language please see the api/qprofiles documentation")
+      .setDescription("Quality Profile Key. To retrieve a profile key for a given language please see the api/qualityprofiles documentation")
       .setRequired(true)
       .setExampleValue("java:MyProfile");
 
diff --git a/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/DeactivateRuleAction.java b/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/DeactivateRuleAction.java
index c5fb6278007..3f6d1f66fcb 100644
--- a/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/DeactivateRuleAction.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/DeactivateRuleAction.java
@@ -59,7 +59,7 @@ public class DeactivateRuleAction implements QProfileWsAction {
       .setSince("4.4");
 
     deactivate.createParam(PARAM_PROFILE_KEY)
-      .setDescription("Key of Quality profile, can be obtained through <code>api/profiles/list</code>")
+      .setDescription("Key of Quality profile, can be obtained through <code>api/qualityprofiles/search</code>")
       .setRequired(true)
       .setExampleValue(Uuids.UUID_EXAMPLE_01);
 
-- 
2.39.5