diff options
4 files changed, 19 insertions, 6 deletions
diff --git a/server/sonar-server/src/main/java/org/sonar/server/projectanalysis/ws/CreateEventAction.java b/server/sonar-server/src/main/java/org/sonar/server/projectanalysis/ws/CreateEventAction.java index f2359791b87..ebb196c6459 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/projectanalysis/ws/CreateEventAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/projectanalysis/ws/CreateEventAction.java @@ -72,12 +72,14 @@ public class CreateEventAction implements ProjectAnalysesWsAction { @Override public void define(WebService.NewController context) { WebService.NewAction action = context.createAction("create_event") - .setDescription("Add an event to a project analysis.<br>" + + .setDescription("Create a project analysis event.<br>" + + "Only event of category '%s' and '%s' can be created.<br>" + "Requires one of the following permissions:" + "<ul>" + " <li>'Administer System'</li>" + " <li>'Administer' rights on the specified project</li>" + - "</ul>") + "</ul>", + VERSION.name(), OTHER.name()) .setSince("6.3") .setPost(true) .setResponseExample(getClass().getResource("create_event-example.json")) diff --git a/server/sonar-server/src/main/java/org/sonar/server/projectanalysis/ws/DeleteAction.java b/server/sonar-server/src/main/java/org/sonar/server/projectanalysis/ws/DeleteAction.java index 9e709934987..23566a0529c 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/projectanalysis/ws/DeleteAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/projectanalysis/ws/DeleteAction.java @@ -52,7 +52,7 @@ public class DeleteAction implements ProjectAnalysesWsAction { @Override public void define(WebService.NewController context) { WebService.NewAction action = context.createAction("delete") - .setDescription("Delete an analysis.<br>" + + .setDescription("Delete a project analysis.<br>" + "Requires one of the following permissions:" + "<ul>" + " <li>'Administer System'</li>" + @@ -63,6 +63,7 @@ public class DeleteAction implements ProjectAnalysesWsAction { .setHandler(this); action.createParam(PARAM_ANALYSIS) + .setDescription("Analysis key") .setExampleValue(Uuids.UUID_EXAMPLE_04) .setRequired(true); } diff --git a/server/sonar-server/src/main/java/org/sonar/server/projectanalysis/ws/DeleteEventAction.java b/server/sonar-server/src/main/java/org/sonar/server/projectanalysis/ws/DeleteEventAction.java index 9bc6df2ce8d..d5d686a9f3b 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/projectanalysis/ws/DeleteEventAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/projectanalysis/ws/DeleteEventAction.java @@ -26,6 +26,7 @@ import org.sonar.api.server.ws.Request; import org.sonar.api.server.ws.Response; import org.sonar.api.server.ws.WebService; import org.sonar.api.web.UserRole; +import org.sonar.core.util.Uuids; import org.sonar.db.DbClient; import org.sonar.db.DbSession; import org.sonar.db.component.SnapshotDto; @@ -37,6 +38,7 @@ import org.sonarqube.ws.client.projectanalysis.DeleteEventRequest; import static com.google.common.base.Preconditions.checkArgument; import static java.lang.String.format; import static org.sonar.server.projectanalysis.ws.EventValidator.checkModifiable; +import static org.sonarqube.ws.client.projectanalysis.EventCategory.OTHER; import static org.sonarqube.ws.client.projectanalysis.EventCategory.VERSION; import static org.sonarqube.ws.client.projectanalysis.ProjectAnalysesWsParameters.PARAM_EVENT; @@ -52,18 +54,21 @@ public class DeleteEventAction implements ProjectAnalysesWsAction { @Override public void define(WebService.NewController context) { WebService.NewAction action = context.createAction("delete_event") - .setDescription("Delete an analysis event.<br>" + + .setDescription("Delete a project analysis event.<br>" + + "Only event of category '%s' and '%s' can be deleted.<br>" + "Requires one of the following permissions:" + "<ul>" + " <li>'Administer System'</li>" + " <li>'Administer' rights on the specified project</li>" + - "</ul>") + "</ul>", + VERSION.name(), OTHER.name()) .setPost(true) .setSince("6.3") .setHandler(this); action.createParam(PARAM_EVENT) .setDescription("Event key") + .setExampleValue(Uuids.UUID_EXAMPLE_02) .setRequired(true); } diff --git a/server/sonar-server/src/main/java/org/sonar/server/projectanalysis/ws/UpdateEventAction.java b/server/sonar-server/src/main/java/org/sonar/server/projectanalysis/ws/UpdateEventAction.java index 49aedaa0dd5..ca265096df4 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/projectanalysis/ws/UpdateEventAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/projectanalysis/ws/UpdateEventAction.java @@ -29,6 +29,7 @@ import org.sonar.api.server.ws.Request; import org.sonar.api.server.ws.Response; import org.sonar.api.server.ws.WebService; import org.sonar.api.web.UserRole; +import org.sonar.core.util.Uuids; import org.sonar.db.DbClient; import org.sonar.db.DbSession; import org.sonar.db.component.SnapshotDto; @@ -37,6 +38,7 @@ import org.sonar.server.exceptions.NotFoundException; import org.sonar.server.user.UserSession; import org.sonarqube.ws.ProjectAnalyses.Event; import org.sonarqube.ws.ProjectAnalyses.UpdateEventResponse; +import org.sonarqube.ws.client.projectanalysis.EventCategory; import org.sonarqube.ws.client.projectanalysis.UpdateEventRequest; import static java.lang.String.format; @@ -61,11 +63,13 @@ public class UpdateEventAction implements ProjectAnalysesWsAction { public void define(WebService.NewController context) { WebService.NewAction action = context.createAction("update_event") .setDescription("Update a project analysis event.<br>" + + "Only events of category '%s' and '%s' can be updated.<br>" + "Requires one of the following permissions:" + "<ul>" + " <li>'Administer System'</li>" + " <li>'Administer' rights on the specified project</li>" + - "</ul>") + "</ul>", + EventCategory.VERSION.name(), EventCategory.OTHER.name()) .setSince("6.3") .setPost(true) .setResponseExample(getClass().getResource("update_event-example.json")) @@ -73,6 +77,7 @@ public class UpdateEventAction implements ProjectAnalysesWsAction { action.createParam(PARAM_EVENT) .setDescription("Event key") + .setExampleValue(Uuids.UUID_EXAMPLE_08) .setRequired(true); action.createParam(PARAM_NAME) |