From: Jacek <jacek.poreda@sonarsource.com>
Date: Mon, 23 Sep 2019 08:19:17 +0000 (+0200)
Subject: Improve set action description
X-Git-Tag: 8.0~59
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=a78423a63dd2c279ca7c80dfbbb75f616d3bc5d7;p=sonarqube.git

Improve set action description
---

diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/newcodeperiod/ws/SetAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/newcodeperiod/ws/SetAction.java
index 96458fbb3e9..3effb0b21e4 100644
--- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/newcodeperiod/ws/SetAction.java
+++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/newcodeperiod/ws/SetAction.java
@@ -20,11 +20,9 @@
 package org.sonar.server.newcodeperiod.ws;
 
 import com.google.common.base.Preconditions;
-import java.util.Arrays;
 import java.util.EnumSet;
 import java.util.Locale;
 import java.util.Set;
-import java.util.stream.Collectors;
 import javax.annotation.Nullable;
 import org.sonar.api.server.ws.Request;
 import org.sonar.api.server.ws.Response;
@@ -80,11 +78,15 @@ public class SetAction implements NewCodePeriodsWsAction {
   public void define(WebService.NewController context) {
     WebService.NewAction action = context.createAction("set")
       .setPost(true)
-      .setDescription("Sets the setting for the New Code Period.<br>" +
+      .setDescription("Updates the setting for the New Code Period on different levels:<br>" +
+        "<ul>" +
+        "<li>Project key must be provided to update the value for a project</li>" +
+        "<li>Both project and branch keys must be provided to update the value for a branch\n</li>" +
+        "</ul>" +
         "Requires one of the following permissions: " +
         "<ul>" +
         "<li>'Administer System' to change the global setting</li>" +
-        "<li>'Administer' rights for a specified component</li>" +
+        "<li>'Administer' rights on the specified project to change the project setting</li>" +
         "</ul>")
       .setSince("8.0")
       .setHandler(this);
@@ -96,14 +98,20 @@ public class SetAction implements NewCodePeriodsWsAction {
     action.createParam(PARAM_TYPE)
       .setRequired(true)
       .setDescription("Type<br/>" +
-        "Only new code periods of the following types are allowed:" +
+        "New code periods of the following types are allowed:" +
         "<ul>" +
-        Arrays.stream(NewCodePeriodType.values())
-          .map(newCodePeriodType -> "<li>" + newCodePeriodType.name() + "</li>")
-          .collect(Collectors.joining()) +
+        "<li>" + SPECIFIC_ANALYSIS.name() + " - can be set at branch level only</li>" +
+        "<li>" + PREVIOUS_VERSION.name() + " - can be set at any level (global, project, branch)</li>" +
+        "<li>" + NUMBER_OF_DAYS.name() + " - can be set  can be set at any level (global, project, branch)</li>" +
         "</ul>");
     action.createParam(PARAM_VALUE)
-      .setDescription("Value");
+      .setDescription("Value<br/>" +
+        "For each type, a different value is expected:" +
+        "<ul>" +
+        "<li>the uuid of an analysis, when type is " + SPECIFIC_ANALYSIS.name() + "</li>" +
+        "<li>no value, when type is " + PREVIOUS_VERSION.name() + "</li>" +
+        "<li>a number, when type is " + NUMBER_OF_DAYS.name() + "</li>" +
+        "</ul>");
   }
 
   @Override