Browse Source

SONAR-13304 Make 'branch' and 'pullRequest' parameters in Web Services public

tags/8.3.0.34182
Duarte Meneses 4 years ago
parent
commit
9b9cd018cf

+ 2
- 4
server/sonar-webserver-webapi/src/main/java/org/sonar/server/component/ws/AppAction.java View File

@@ -72,15 +72,13 @@ public class AppAction implements ComponentsWsAction {
.setSince("6.4");

action.createParam(PARAM_BRANCH)
.setDescription("Branch key")
.setDescription("Branch key. Not available in the community edition.")
.setSince("6.6")
.setInternal(true)
.setExampleValue(KEY_BRANCH_EXAMPLE_001);

action.createParam(PARAM_PULL_REQUEST)
.setDescription("Pull request id")
.setDescription("Pull request id. Not available in the community edition.")
.setSince("7.1")
.setInternal(true)
.setExampleValue(KEY_PULL_REQUEST_EXAMPLE_001);
}


+ 2
- 4
server/sonar-webserver-webapi/src/main/java/org/sonar/server/component/ws/ShowAction.java View File

@@ -84,15 +84,13 @@ public class ShowAction implements ComponentsWsAction {
.setExampleValue(KEY_PROJECT_EXAMPLE_001);

action.createParam(PARAM_BRANCH)
.setDescription("Branch key")
.setDescription("Branch key. Not available in the community edition.")
.setExampleValue(KEY_BRANCH_EXAMPLE_001)
.setInternal(true)
.setSince("6.6");

action.createParam(PARAM_PULL_REQUEST)
.setDescription("Pull request id")
.setDescription("Pull request id. Not available in the community edition.")
.setExampleValue(KEY_PULL_REQUEST_EXAMPLE_001)
.setInternal(true)
.setSince("7.1");
}


+ 2
- 4
server/sonar-webserver-webapi/src/main/java/org/sonar/server/component/ws/TreeAction.java View File

@@ -132,15 +132,13 @@ public class TreeAction implements ComponentsWsAction {
.setExampleValue(KEY_PROJECT_EXAMPLE_001);

action.createParam(PARAM_BRANCH)
.setDescription("Branch key")
.setDescription("Branch key. Not available in the community edition.")
.setExampleValue(KEY_BRANCH_EXAMPLE_001)
.setInternal(true)
.setSince("6.6");

action.createParam(PARAM_PULL_REQUEST)
.setDescription("Pull request id")
.setDescription("Pull request id. Not available in the community edition.")
.setExampleValue(KEY_PULL_REQUEST_EXAMPLE_001)
.setInternal(true)
.setSince("7.1");

action.createSortParams(SORTS, NAME_SORT, true)

+ 4
- 6
server/sonar-webserver-webapi/src/main/java/org/sonar/server/hotspot/ws/SearchAction.java View File

@@ -129,13 +129,11 @@ public class SearchAction implements HotspotsWsAction {
PARAM_HOTSPOTS))
.setExampleValue(KEY_PROJECT_EXAMPLE_001);
action.createParam(PARAM_BRANCH)
.setDescription("Branch key")
.setExampleValue(KEY_BRANCH_EXAMPLE_001)
.setInternal(true);
.setDescription("Branch key. Not available in the community edition.")
.setExampleValue(KEY_BRANCH_EXAMPLE_001);
action.createParam(PARAM_PULL_REQUEST)
.setDescription("Pull request id")
.setExampleValue(KEY_PULL_REQUEST_EXAMPLE_001)
.setInternal(true);
.setDescription("Pull request id. Not available in the community edition.")
.setExampleValue(KEY_PULL_REQUEST_EXAMPLE_001);
action.createParam(PARAM_HOTSPOTS)
.setDescription(format(
"Comma-separated list of Security Hotspot keys. This parameter is required unless %s is provided.",

+ 2
- 4
server/sonar-webserver-webapi/src/main/java/org/sonar/server/issue/ws/SearchAction.java View File

@@ -361,15 +361,13 @@ public class SearchAction implements IssuesWsAction {
.setExampleValue("bdd82933-3070-4903-9188-7d8749e8bb92");

action.createParam(PARAM_BRANCH)
.setDescription("Branch key")
.setDescription("Branch key. Not available in the community edition.")
.setExampleValue(KEY_BRANCH_EXAMPLE_001)
.setInternal(true)
.setSince("6.6");

action.createParam(PARAM_PULL_REQUEST)
.setDescription("Pull request id")
.setDescription("Pull request id. Not available in the community edition.")
.setExampleValue(KEY_PULL_REQUEST_EXAMPLE_001)
.setInternal(true)
.setSince("7.1");

action.createParam(PARAM_ORGANIZATION)

+ 2
- 4
server/sonar-webserver-webapi/src/main/java/org/sonar/server/measure/ws/ComponentTreeAction.java View File

@@ -213,15 +213,13 @@ public class ComponentTreeAction implements MeasuresWsAction {
.setDeprecatedKey(DEPRECATED_PARAM_BASE_COMPONENT_KEY, "6.6");

action.createParam(PARAM_BRANCH)
.setDescription("Branch key")
.setDescription("Branch key. Not available in the community edition.")
.setExampleValue(KEY_BRANCH_EXAMPLE_001)
.setInternal(true)
.setSince("6.6");

action.createParam(PARAM_PULL_REQUEST)
.setDescription("Pull request id")
.setDescription("Pull request id. Not available in the community edition.")
.setExampleValue(KEY_PULL_REQUEST_EXAMPLE_001)
.setInternal(true)
.setSince("7.1");

action.createParam(PARAM_METRIC_SORT)

+ 2
- 4
server/sonar-webserver-webapi/src/main/java/org/sonar/server/measure/ws/SearchHistoryAction.java View File

@@ -98,15 +98,13 @@ public class SearchHistoryAction implements MeasuresWsAction {
.setExampleValue(KeyExamples.KEY_PROJECT_EXAMPLE_001);

action.createParam(PARAM_BRANCH)
.setDescription("Branch key")
.setDescription("Branch key. Not available in the community edition.")
.setSince("6.6")
.setInternal(true)
.setExampleValue(KEY_BRANCH_EXAMPLE_001);

action.createParam(PARAM_PULL_REQUEST)
.setDescription("Pull request id")
.setDescription("Pull request id. Not available in the community edition.")
.setSince("7.1")
.setInternal(true)
.setExampleValue(KEY_PULL_REQUEST_EXAMPLE_001);

action.createParam(PARAM_METRICS)

+ 2
- 2
server/sonar-webserver-webapi/src/test/java/org/sonar/server/component/ws/ShowActionTest.java View File

@@ -84,12 +84,12 @@ public class ShowActionTest {
assertThat(component.exampleValue()).isNotNull();

WebService.Param branch = action.param(PARAM_BRANCH);
assertThat(branch.isInternal()).isTrue();
assertThat(branch.isInternal()).isFalse();
assertThat(branch.isRequired()).isFalse();
assertThat(branch.since()).isEqualTo("6.6");

WebService.Param pullRequest = action.param(PARAM_PULL_REQUEST);
assertThat(pullRequest.isInternal()).isTrue();
assertThat(pullRequest.isInternal()).isFalse();
assertThat(pullRequest.isRequired()).isFalse();
assertThat(pullRequest.since()).isEqualTo("7.1");
}

+ 1
- 1
server/sonar-webserver-webapi/src/test/java/org/sonar/server/component/ws/TreeActionTest.java View File

@@ -110,7 +110,7 @@ public class TreeActionTest {
assertThat(component.exampleValue()).isNotNull();

Param branch = action.param(PARAM_BRANCH);
assertThat(branch.isInternal()).isTrue();
assertThat(branch.isInternal()).isFalse();
assertThat(branch.isRequired()).isFalse();
assertThat(branch.since()).isEqualTo("6.6");
}

+ 1
- 1
server/sonar-webserver-webapi/src/test/java/org/sonar/server/issue/ws/SearchActionTest.java View File

@@ -1107,7 +1107,7 @@ public class SearchActionTest {
.matches(p -> p.since().equals("6.4"));

WebService.Param branch = def.param(PARAM_BRANCH);
assertThat(branch.isInternal()).isTrue();
assertThat(branch.isInternal()).isFalse();
assertThat(branch.isRequired()).isFalse();
assertThat(branch.since()).isEqualTo("6.6");


+ 1
- 1
server/sonar-webserver-webapi/src/test/java/org/sonar/server/measure/ws/SearchHistoryActionTest.java View File

@@ -439,7 +439,7 @@ public class SearchHistoryActionTest {

Param branch = definition.param("branch");
assertThat(branch.since()).isEqualTo("6.6");
assertThat(branch.isInternal()).isTrue();
assertThat(branch.isInternal()).isFalse();
assertThat(branch.isRequired()).isFalse();
}


Loading…
Cancel
Save