SONAR-16412 Add link to markdown syntax in documentation of Web API rules endpoint

diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/rule/ws/CreateAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/rule/ws/CreateAction.java
index 04ddcd300c39d90ca6f4224cf6ebe5dd733ced9c..fe17a6db14785baf4a7101cd51a2c5327bc94066 100644 (file)
--- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/rule/ws/CreateAction.java
+++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/rule/ws/CreateAction.java
@@ -110,7 +110,7 @@ public class CreateAction implements RulesWsAction {
     action
       .createParam(PARAM_DESCRIPTION)
       .setRequired(true)
-      .setDescription("Rule description")
+      .setDescription("Rule description in <a href='/formatting/help'>markdown format</a>")
       .setExampleValue("Description of my custom rule");
 
     action

diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/rule/ws/UpdateAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/rule/ws/UpdateAction.java
index c6f791f70561d5c418ddcbd400b1b2b49d41989b..1b47dbd1bb5eb76b00a784c9adeeec129db9088b 100644 (file)
--- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/rule/ws/UpdateAction.java
+++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/rule/ws/UpdateAction.java
@@ -104,7 +104,7 @@ public class UpdateAction implements RulesWsAction {
       .setExampleValue("java8,security");
 
     action.createParam(PARAM_MARKDOWN_NOTE)
-      .setDescription("Optional note in markdown format. Use empty value to remove current note. Note is not changed " +
+      .setDescription("Optional note in <a href='/formatting/help'>markdown format</a>. Use empty value to remove current note. Note is not changed " +
         "if the parameter is not set.")
       .setExampleValue("my *note*");
 
@@ -131,7 +131,7 @@ public class UpdateAction implements RulesWsAction {
 
     action
       .createParam(PARAM_DESCRIPTION)
-      .setDescription("Rule description (mandatory for custom rule and manual rule)")
+      .setDescription("Rule description (mandatory for custom rule and manual rule) in <a href='/formatting/help'>markdown format</a>")
       .setExampleValue("Description of my custom rule");
 
     action