aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-server
diff options
context:
space:
mode:
authorJean-Baptiste Lievremont <jean-baptiste.lievremont@sonarsource.com>2014-07-16 17:12:08 +0200
committerJean-Baptiste Lievremont <jean-baptiste.lievremont@sonarsource.com>2014-07-16 17:12:08 +0200
commit921d66a09a53d1b23da810c4b5800d047236f44f (patch)
treeb971e1b30602ec1e8a3f8ab8ebb078cf7607fd70 /server/sonar-server
parentf92fb66e05bc0d891a97b12a5ef4952742fcbf12 (diff)
downloadsonarqube-921d66a09a53d1b23da810c4b5800d047236f44f.tar.gz
sonarqube-921d66a09a53d1b23da810c4b5800d047236f44f.zip
SONAR-5001 Allow Markdown for rule property descriptions
Diffstat (limited to 'server/sonar-server')
-rw-r--r--server/sonar-server/src/main/java/org/sonar/server/rule/ws/RuleMapping.java2
-rw-r--r--server/sonar-server/src/test/java/org/sonar/server/rule/ws/ShowActionMediumTest.java2
-rw-r--r--server/sonar-server/src/test/resources/org/sonar/server/rule/ws/CreateActionMediumTest/create_custom_rule.json2
-rw-r--r--server/sonar-server/src/test/resources/org/sonar/server/rule/ws/RulesWebServiceMediumTest/search_active_rules_params.json4
-rw-r--r--server/sonar-server/src/test/resources/org/sonar/server/rule/ws/ShowActionMediumTest/show_rule.json2
-rw-r--r--server/sonar-server/src/test/resources/org/sonar/server/rule/ws/UpdateActionMediumTest/update_custom_rule.json2
6 files changed, 7 insertions, 7 deletions
diff --git a/server/sonar-server/src/main/java/org/sonar/server/rule/ws/RuleMapping.java b/server/sonar-server/src/main/java/org/sonar/server/rule/ws/RuleMapping.java
index 68d4891f938..2b54eeea59b 100644
--- a/server/sonar-server/src/main/java/org/sonar/server/rule/ws/RuleMapping.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/rule/ws/RuleMapping.java
@@ -133,7 +133,7 @@ public class RuleMapping extends BaseMapping<RuleDoc, RuleMappingContext> {
json
.beginObject()
.prop("key", param.key())
- .prop("desc", param.description())
+ .prop("htmlDesc", param.description() == null ? null : Markdown.convertToHtml(param.description()))
.prop("defaultValue", param.defaultValue())
.endObject();
}
diff --git a/server/sonar-server/src/test/java/org/sonar/server/rule/ws/ShowActionMediumTest.java b/server/sonar-server/src/test/java/org/sonar/server/rule/ws/ShowActionMediumTest.java
index c5f1c0312e7..cc4819a9a58 100644
--- a/server/sonar-server/src/test/java/org/sonar/server/rule/ws/ShowActionMediumTest.java
+++ b/server/sonar-server/src/test/java/org/sonar/server/rule/ws/ShowActionMediumTest.java
@@ -88,7 +88,7 @@ public class ShowActionMediumTest {
.setTags(newHashSet("tag1", "tag2"))
.setSystemTags(newHashSet("systag1", "systag2"))
);
- RuleParamDto param = RuleParamDto.createFor(ruleDto).setName("regex").setType("STRING").setDescription("Reg ex").setDefaultValue(".*");
+ RuleParamDto param = RuleParamDto.createFor(ruleDto).setName("regex").setType("STRING").setDescription("Reg *exp*").setDefaultValue(".*");
ruleDao.addRuleParam(session, ruleDto, param);
session.commit();
session.clearCache();
diff --git a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/CreateActionMediumTest/create_custom_rule.json b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/CreateActionMediumTest/create_custom_rule.json
index 648e6c9b2fe..2e3f3fa36ef 100644
--- a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/CreateActionMediumTest/create_custom_rule.json
+++ b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/CreateActionMediumTest/create_custom_rule.json
@@ -18,7 +18,7 @@
"params": [
{
"key": "regex",
- "desc": "Reg ex",
+ "htmlDesc": "Reg ex",
"defaultValue": "a.*"
}
]
diff --git a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/RulesWebServiceMediumTest/search_active_rules_params.json b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/RulesWebServiceMediumTest/search_active_rules_params.json
index c2938aeb995..ec25f48afc4 100644
--- a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/RulesWebServiceMediumTest/search_active_rules_params.json
+++ b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/RulesWebServiceMediumTest/search_active_rules_params.json
@@ -4,12 +4,12 @@
"params": [
{
"key": "my_var",
- "desc": "My small description",
+ "htmlDesc": "My small description",
"defaultValue": "some value"
},
{
"key": "the_var",
- "desc": "My small description",
+ "htmlDesc": "My small description",
"defaultValue": "other value"
}
]
diff --git a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/ShowActionMediumTest/show_rule.json b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/ShowActionMediumTest/show_rule.json
index 20a27a3b683..a80d4e3fb39 100644
--- a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/ShowActionMediumTest/show_rule.json
+++ b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/ShowActionMediumTest/show_rule.json
@@ -13,7 +13,7 @@
"params": [
{
"key": "regex",
- "desc": "Reg ex",
+ "htmlDesc": "Reg <em>exp</em>",
"defaultValue": ".*"
}
]
diff --git a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/UpdateActionMediumTest/update_custom_rule.json b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/UpdateActionMediumTest/update_custom_rule.json
index 648e6c9b2fe..2e3f3fa36ef 100644
--- a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/UpdateActionMediumTest/update_custom_rule.json
+++ b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/UpdateActionMediumTest/update_custom_rule.json
@@ -18,7 +18,7 @@
"params": [
{
"key": "regex",
- "desc": "Reg ex",
+ "htmlDesc": "Reg ex",
"defaultValue": "a.*"
}
]