diff options
| author | Duarte Meneses <duarte.meneses@sonarsource.com> | 2020-08-13 15:21:04 -0500 |
|---|---|---|
| committer | sonartech <sonartech@sonarsource.com> | 2020-08-14 20:16:19 +0000 |
| commit | 187597cbd491fff2718156633aab259c658ce830 (patch) | |
| tree | a16c9db6aeeabc9db1c71388922d229b86f2ba0c /server | |
| parent | f4733cb9ef274b0b990b0459b3c523eb756ce5cb (diff) | |
| download | sonarqube-187597cbd491fff2718156633aab259c658ce830.tar.gz sonarqube-187597cbd491fff2718156633aab259c658ce830.zip | |
SONAR-13497 Improve WS documentation of /api/projects
Diffstat (limited to 'server')
3 files changed, 3 insertions, 2 deletions
diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/project/ws/DeleteAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/project/ws/DeleteAction.java index 70c68287e25..50d36ffcf27 100644 --- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/project/ws/DeleteAction.java +++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/project/ws/DeleteAction.java @@ -68,6 +68,7 @@ public class DeleteAction implements ProjectsWsAction { action .createParam(PARAM_PROJECT) .setDescription("Project key") + .setRequired(true) .setExampleValue(KEY_PROJECT_EXAMPLE_001); } diff --git a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/project/ws/SearchAction.java b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/project/ws/SearchAction.java index 4131aae98b5..f2eb37551b3 100644 --- a/server/sonar-webserver-webapi/src/main/java/org/sonar/server/project/ws/SearchAction.java +++ b/server/sonar-webserver-webapi/src/main/java/org/sonar/server/project/ws/SearchAction.java @@ -83,7 +83,7 @@ public class SearchAction implements ProjectsWsAction { WebService.NewAction action = context.createAction(ACTION_SEARCH) .setSince("6.3") .setDescription("Search for projects or views to administrate them.<br>" + - "Requires 'System Administrator' permission") + "Requires 'Administer System' permission") .addPagingParams(100, MAX_PAGE_SIZE) .setResponseExample(getClass().getResource("search-example.json")) .setHandler(this); diff --git a/server/sonar-webserver-webapi/src/test/java/org/sonar/server/project/ws/SearchActionTest.java b/server/sonar-webserver-webapi/src/test/java/org/sonar/server/project/ws/SearchActionTest.java index 5c950cf6161..9accaa07d3e 100644 --- a/server/sonar-webserver-webapi/src/test/java/org/sonar/server/project/ws/SearchActionTest.java +++ b/server/sonar-webserver-webapi/src/test/java/org/sonar/server/project/ws/SearchActionTest.java @@ -324,7 +324,7 @@ public class SearchActionTest { WebService.Action action = ws.getDef(); assertThat(action.key()).isEqualTo("search"); assertThat(action.isPost()).isFalse(); - assertThat(action.description()).isEqualTo("Search for projects or views to administrate them.<br>Requires 'System Administrator' permission"); + assertThat(action.description()).isEqualTo("Search for projects or views to administrate them.<br>Requires 'Administer System' permission"); assertThat(action.isInternal()).isFalse(); assertThat(action.since()).isEqualTo("6.3"); assertThat(action.handler()).isEqualTo(ws.getDef().handler()); |