diff options
| author | Aurelien Poscia <aurelien.poscia@sonarsource.com> | 2022-05-13 14:34:27 +0200 |
|---|---|---|
| committer | sonartech <sonartech@sonarsource.com> | 2022-05-13 20:02:50 +0000 |
| commit | d782e04fa04567dcfafd237bc4f10a6c62f13972 (patch) | |
| tree | 9938dbdd6e36c3b6f5205c80b201b713eb748176 /server | |
| parent | 46543413d0cc6188a95260ec9a1c0d9b5da26e82 (diff) | |
| download | sonarqube-d782e04fa04567dcfafd237bc4f10a6c62f13972.tar.gz sonarqube-d782e04fa04567dcfafd237bc4f10a6c62f13972.zip | |
SONAR-16412 Add link to markdown syntax in documentation of Web API rules endpoint
Diffstat (limited to 'server')
| -rw-r--r-- | server/sonar-webserver-webapi/src/main/java/org/sonar/server/rule/ws/CreateAction.java | 2 | ||||
| -rw-r--r-- | server/sonar-webserver-webapi/src/main/java/org/sonar/server/rule/ws/UpdateAction.java | 4 |
2 files changed, 3 insertions, 3 deletions
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 04ddcd300c3..fe17a6db147 100644 --- 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 c6f791f7056..1b47dbd1bb5 100644 --- 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 |