]> source.dussan.org Git - sonarqube.git/commitdiff
SONAR-9129 improve descriptions of api/qualityprofiles
authorSimon Brandhof <simon.brandhof@sonarsource.com>
Wed, 3 May 2017 16:03:34 +0000 (18:03 +0200)
committerSimon Brandhof <simon.brandhof@sonarsource.com>
Wed, 3 May 2017 19:36:16 +0000 (21:36 +0200)
server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ActivateRulesAction.java
server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/DeactivateRulesAction.java
server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/SearchAction.java

index 4200ae9e0627358a9ac9aca15bb83f036f1174d6..a0816c04fdfa86393631137af87d331f96786e27 100644 (file)
@@ -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/qualityprofiles documentation")
+      .setDescription("Quality Profile Key. To retrieve a profile key for a given language please see <code>api/qualityprofiles/search</code>")
       .setRequired(true)
       .setExampleValue("java:MyProfile");
 
index 546b5b89eeefdcbf71a50e57a41b07c8be448398..5273652df087725d0c756ad4d91e31136266cb33 100644 (file)
@@ -65,7 +65,7 @@ public class DeactivateRulesAction implements QProfileWsAction {
     defineRuleSearchParameters(deactivate);
 
     deactivate.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 <code>api/qualityprofiles/search</code>")
       .setRequired(true)
       .setExampleValue("java:MyProfile");
   }
index dfae9ba3ba179bbe0491f8cce70fc08e8d8c0f60..cf0da1c57d9db24800eb7f150b65f2da028db75b 100644 (file)
@@ -90,8 +90,7 @@ public class SearchAction implements QProfileWsAction {
 
     action
       .createParam(PARAM_DEFAULTS)
-      .setDescription(format("Return the quality profile marked as default for each language. " +
-        "If provided, then the parameters '%s', '%s' must not be set.",
+      .setDescription(format("If set to true, return only the quality profile marked as default for each language, '%s' and '%s' parameters must not be set.",
         PARAM_LANGUAGE, PARAM_PROJECT_KEY))
       .setDefaultValue(false)
       .setBooleanPossibleValues();