Переглянути джерело

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

tags/9.5.0.56709
Aurelien Poscia 2 роки тому
джерело
коміт
d782e04fa0

+ 1
- 1
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

+ 2
- 2
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

Завантаження…
Відмінити
Зберегти