aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-server
diff options
context:
space:
mode:
authorSimon Brandhof <simon.brandhof@sonarsource.com>2017-05-03 18:03:34 +0200
committerSimon Brandhof <simon.brandhof@sonarsource.com>2017-05-03 21:36:16 +0200
commit6d18fa56e8782e022169738587750dfe59b4015a (patch)
treeaf24851f0cfe5c18683fb0ed3828e6c2f9d22a51 /server/sonar-server
parentb6c626d517f2a9783688b80a8dac0d5ba8a1f794 (diff)
downloadsonarqube-6d18fa56e8782e022169738587750dfe59b4015a.tar.gz
sonarqube-6d18fa56e8782e022169738587750dfe59b4015a.zip
SONAR-9129 improve descriptions of api/qualityprofiles
Diffstat (limited to 'server/sonar-server')
-rw-r--r--server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ActivateRulesAction.java2
-rw-r--r--server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/DeactivateRulesAction.java2
-rw-r--r--server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/SearchAction.java3
3 files changed, 3 insertions, 4 deletions
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 4200ae9e062..a0816c04fdf 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/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");
diff --git a/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/DeactivateRulesAction.java b/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/DeactivateRulesAction.java
index 546b5b89eee..5273652df08 100644
--- a/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/DeactivateRulesAction.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/DeactivateRulesAction.java
@@ -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");
}
diff --git a/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/SearchAction.java b/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/SearchAction.java
index dfae9ba3ba1..cf0da1c57d9 100644
--- a/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/SearchAction.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/SearchAction.java
@@ -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();