diff options
author | Simon Brandhof <simon.brandhof@sonarsource.com> | 2017-11-24 15:07:52 +0100 |
---|---|---|
committer | Daniel Schwarz <bartfastiel@users.noreply.github.com> | 2017-11-29 20:24:11 +0100 |
commit | 2f73756a57ab7ead3d913aab95f9102242ae9aac (patch) | |
tree | 9ec97573f8c28d0f0dfeb388db83d3ad4e883923 | |
parent | 05feecfee12f21d8ccce10f6d0243fe577431364 (diff) | |
download | sonarqube-2f73756a57ab7ead3d913aab95f9102242ae9aac.tar.gz sonarqube-2f73756a57ab7ead3d913aab95f9102242ae9aac.zip |
Remove documentation from generated WS client
It allows to not have to commit changes each time a description
is changed in sonar-server
Signed-off-by: Simon Brandhof <simon.brandhof@sonarsource.com>
300 files changed, 352 insertions, 2409 deletions
diff --git a/sonar-ws-generator/src/main/resources/request.vm b/sonar-ws-generator/src/main/resources/request.vm index bd84997e881..29456586a49 100644 --- a/sonar-ws-generator/src/main/resources/request.vm +++ b/sonar-ws-generator/src/main/resources/request.vm @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * $action.description.asString - * #if ($action.internal) * This is part of the internal API. #end @@ -51,10 +49,6 @@ public class $helper.requestType($webService.path.asString, $action.key.asString #foreach($param in $action.params) /** -#if ($param.description.asString) - * $param.description.asString - * -#end #if ($param.required.asBoolean) * This is a mandatory parameter. #end diff --git a/sonar-ws-generator/src/main/resources/webService.vm b/sonar-ws-generator/src/main/resources/webService.vm index be2f3bd3d40..d095234a798 100644 --- a/sonar-ws-generator/src/main/resources/webService.vm +++ b/sonar-ws-generator/src/main/resources/webService.vm @@ -33,7 +33,6 @@ $helper.responseTypeImport($webService.path.asString, $action.key.asString) #end /** - * $webService.description.asString * @see <a href="$helper.apiDocUrl($webService.path.asString)">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -45,7 +44,6 @@ public class $helper.className($webService.path.asString) extends BaseService { #foreach($action in $webService.actions) /** - * $action.description.asString * #if ($action.internal) * This is part of the internal API. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/analysisreports/AnalysisReportsService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/analysisreports/AnalysisReportsService.java index 817c0d13363..42b2aabe614 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/analysisreports/AnalysisReportsService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/analysisreports/AnalysisReportsService.java @@ -26,7 +26,6 @@ import org.sonarqube.ws.client.GetRequest; import org.sonarqube.ws.client.WsConnector; /** - * Get details about Compute Engine tasks. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/analysis_reports">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -37,7 +36,6 @@ public class AnalysisReportsService extends BaseService { } /** - * Check if the queue of Compute Engine is empty * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/analysisreports/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/analysisreports/package-info.java index 126c8ae900c..5fabf1bd7e6 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/analysisreports/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/analysisreports/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.analysisreports; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/authentication/AuthenticationService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/authentication/AuthenticationService.java index 170476f2277..07e2caf75ad 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/authentication/AuthenticationService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/authentication/AuthenticationService.java @@ -19,6 +19,7 @@ */ package org.sonarqube.ws.client.authentication; +import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; @@ -27,7 +28,6 @@ import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; /** - * Handle authentication. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/authentication">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -38,7 +38,6 @@ public class AuthenticationService extends BaseService { } /** - * Authenticate a user. * * This is part of the internal API. * This is a POST request. @@ -55,7 +54,6 @@ public class AuthenticationService extends BaseService { } /** - * Logout a user. * * This is part of the internal API. * This is a POST request. @@ -70,7 +68,6 @@ public class AuthenticationService extends BaseService { } /** - * Check credentials. * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/authentication/LoginRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/authentication/LoginRequest.java index 46d6e0b2e13..0bd2cd80060 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/authentication/LoginRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/authentication/LoginRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.authentication; +import java.util.List; import javax.annotation.Generated; /** - * Authenticate a user. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/authentication/login">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class LoginRequest { private String password; /** - * Login of the user - * * This is a mandatory parameter. */ public LoginRequest setLogin(String login) { @@ -50,8 +47,6 @@ public class LoginRequest { } /** - * Password of the user - * * This is a mandatory parameter. */ public LoginRequest setPassword(String password) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/authentication/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/authentication/package-info.java index 61fd208d68c..5cf65e25165 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/authentication/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/authentication/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.authentication; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/batch/BatchService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/batch/BatchService.java index 82e6e3f90fd..4ec736392c0 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/batch/BatchService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/batch/BatchService.java @@ -19,15 +19,16 @@ */ package org.sonarqube.ws.client.batch; +import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; import org.sonarqube.ws.client.GetRequest; +import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; import org.sonarqube.ws.Batch.WsProjectResponse; /** - * Get JAR files and referentials for batch * @see <a href="https://next.sonarqube.com/sonarqube/web_api/batch">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -38,7 +39,6 @@ public class BatchService extends BaseService { } /** - * Download a JAR file listed in the index (see batch/index) * * This is part of the internal API. * This is a GET request. @@ -54,7 +54,6 @@ public class BatchService extends BaseService { } /** - * List the JAR files to be downloaded by scanners * * This is part of the internal API. * This is a GET request. @@ -69,7 +68,6 @@ public class BatchService extends BaseService { } /** - * Return open issues * * This is part of the internal API. * This is a GET request. @@ -86,7 +84,6 @@ public class BatchService extends BaseService { } /** - * Return project repository * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/batch/FileRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/batch/FileRequest.java index 45941e25018..d54e3ca1ad7 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/batch/FileRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/batch/FileRequest.java @@ -22,8 +22,6 @@ package org.sonarqube.ws.client.batch; import javax.annotation.Generated; /** - * Download a JAR file listed in the index (see batch/index) - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/batch/file">Further information about this action online (including a response example)</a> @@ -35,8 +33,6 @@ public class FileRequest { private String name; /** - * File name - * * Example value: "batch-library-2.3.jar" */ public FileRequest setName(String name) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/batch/IssuesRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/batch/IssuesRequest.java index 7bbbfcb81f2..21de533abba 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/batch/IssuesRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/batch/IssuesRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.batch; +import java.util.List; import javax.annotation.Generated; /** - * Return open issues - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/batch/issues">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class IssuesRequest { private String key; /** - * Branch key - * * Example value: "feature/my_branch" */ public IssuesRequest setBranch(String branch) { @@ -50,8 +47,6 @@ public class IssuesRequest { } /** - * Project, module or file key - * * This is a mandatory parameter. * Example value: "my_project" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/batch/ProjectRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/batch/ProjectRequest.java index 9e89bac81f5..d674ac3ef62 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/batch/ProjectRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/batch/ProjectRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.batch; +import java.util.List; import javax.annotation.Generated; /** - * Return project repository - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/batch/project">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class ProjectRequest { private String profile; /** - * Branch key - * * Example value: "feature/my_branch" */ public ProjectRequest setBranch(String branch) { @@ -52,8 +49,6 @@ public class ProjectRequest { } /** - * Issues mode or not - * * Possible values: * <ul> * <li>"true"</li> @@ -72,8 +67,6 @@ public class ProjectRequest { } /** - * Project or module key - * * This is a mandatory parameter. * Example value: "my_project" */ @@ -87,8 +80,6 @@ public class ProjectRequest { } /** - * Profile name - * * Example value: "SonarQube Way" */ public ProjectRequest setProfile(String profile) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/batch/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/batch/package-info.java index 53ebb046e2e..dd90ac20b35 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/batch/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/batch/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.batch; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/ActivityRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/ActivityRequest.java index f762c393527..b20d3ab622c 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/ActivityRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/ActivityRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Search for tasks.<br> Requires the system administration permission, or project administration permission if componentId is set. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/ce/activity">Further information about this action online (including a response example)</a> @@ -45,8 +43,6 @@ public class ActivityRequest { private String type; /** - * Id of the component (project) to filter on - * * Example value: "AU-TpxcA-iU5OvuD2FL0" */ public ActivityRequest setComponentId(String componentId) { @@ -59,8 +55,6 @@ public class ActivityRequest { } /** - * Limit search to: <ul><li>component names that contain the supplied string</li><li>component keys that are exactly the same as the supplied string</li></ul>Must not be set together with componentId.<br />Deprecated and replaced by 'q' - * * Example value: "Apache" * @deprecated since 5.5 */ @@ -75,9 +69,7 @@ public class ActivityRequest { } /** - * Maximum date of end of task processing (inclusive) - * - * Example value: "2017-11-23T15:56:03+0100" + * Example value: "2017-10-19T13:00:00+0200" */ public ActivityRequest setMaxExecutedAt(String maxExecutedAt) { this.maxExecutedAt = maxExecutedAt; @@ -89,9 +81,7 @@ public class ActivityRequest { } /** - * Minimum date of task submission (inclusive) - * - * Example value: "2017-11-23T15:56:03+0100" + * Example value: "2017-10-19T13:00:00+0200" */ public ActivityRequest setMinSubmittedAt(String minSubmittedAt) { this.minSubmittedAt = minSubmittedAt; @@ -103,8 +93,6 @@ public class ActivityRequest { } /** - * Filter on the last tasks (only the most recent finished task by project) - * * Possible values: * <ul> * <li>"true"</li> @@ -123,8 +111,6 @@ public class ActivityRequest { } /** - * Deprecated parameter - * * @deprecated since 5.5 */ @Deprecated @@ -138,8 +124,6 @@ public class ActivityRequest { } /** - * Page size. Must be greater than 0 and less than 1000 - * * Example value: "20" */ public ActivityRequest setPs(String ps) { @@ -152,8 +136,6 @@ public class ActivityRequest { } /** - * Limit search to: <ul><li>component names that contain the supplied string</li><li>component keys that are exactly the same as the supplied string</li><li>task ids that are exactly the same as the supplied string</li></ul>Must not be set together with componentId - * * Example value: "Apache" */ public ActivityRequest setQ(String q) { @@ -166,8 +148,6 @@ public class ActivityRequest { } /** - * Comma separated list of task statuses - * * Example value: "IN_PROGRESS,SUCCESS" * Possible values: * <ul> @@ -188,8 +168,6 @@ public class ActivityRequest { } /** - * Task type - * * Example value: "REPORT" * Possible values: * <ul> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/ActivityStatusRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/ActivityStatusRequest.java index c48673a36a9..967c9a2577b 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/ActivityStatusRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/ActivityStatusRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.ce; +import java.util.List; import javax.annotation.Generated; /** - * Return CE activity related metrics.<br>Requires 'Administer System' permission or 'Administer' rights on the specified project. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/ce/activity_status">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class ActivityStatusRequest { private String componentKey; /** - * Id of the component (project) to filter on - * * Example value: "AU-TpxcA-iU5OvuD2FL0" */ public ActivityStatusRequest setComponentId(String componentId) { @@ -50,8 +47,6 @@ public class ActivityStatusRequest { } /** - * Key of the component (project) to filter on - * * Example value: "my_project" */ public ActivityStatusRequest setComponentKey(String componentKey) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/CancelRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/CancelRequest.java index bcdc60a077d..6f3a351c9a3 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/CancelRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/CancelRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.ce; +import java.util.List; import javax.annotation.Generated; /** - * Cancels a pending task.<br/>In-progress tasks cannot be canceled.<br/>Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the project related to the task</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/ce/cancel">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class CancelRequest { private String id; /** - * Id of the task to cancel. - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/CeService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/CeService.java index 85bb0d8ce1d..3d831a9e37e 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/CeService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/CeService.java @@ -35,7 +35,6 @@ import org.sonarqube.ws.Ce.TaskTypesWsResponse; import org.sonarqube.ws.Ce.WorkerCountResponse; /** - * Get information on Compute Engine tasks. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/ce">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -46,7 +45,6 @@ public class CeService extends BaseService { } /** - * Search for tasks.<br> Requires the system administration permission, or project administration permission if componentId is set. * * This is part of the internal API. * This is a GET request. @@ -70,7 +68,6 @@ public class CeService extends BaseService { } /** - * Return CE activity related metrics.<br>Requires 'Administer System' permission or 'Administer' rights on the specified project. * * This is part of the internal API. * This is a GET request. @@ -86,7 +83,6 @@ public class CeService extends BaseService { } /** - * Cancels a pending task.<br/>In-progress tasks cannot be canceled.<br/>Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the project related to the task</li></ul> * * This is part of the internal API. * This is a POST request. @@ -102,7 +98,6 @@ public class CeService extends BaseService { } /** - * Cancels all pending tasks. Requires system administration permission. In-progress tasks are not canceled. * * This is part of the internal API. * This is a POST request. @@ -117,7 +112,6 @@ public class CeService extends BaseService { } /** - * Get the pending tasks, in-progress tasks and the last executed task of a given component (usually a project).<br>Requires the following permission: 'Browse' on the specified component.<br>Either 'componentId' or 'component' must be provided. * * This is part of the internal API. * This is a GET request. @@ -133,7 +127,6 @@ public class CeService extends BaseService { } /** - * Submits a scanner report to the queue. Report is processed asynchronously. Requires analysis permission. If the project does not exist, then the provisioning permission is also required. * * This is part of the internal API. * This is a POST request. @@ -153,7 +146,6 @@ public class CeService extends BaseService { } /** - * Give Compute Engine task details such as type, status, duration and associated component.<br />Requires 'Administer System' or 'Execute Analysis' permission.<br/>Since 6.1, field "logs" is deprecated and its value is always false. * * This is part of the internal API. * This is a GET request. @@ -169,7 +161,6 @@ public class CeService extends BaseService { } /** - * List available task types * * This is part of the internal API. * This is a GET request. @@ -183,7 +174,6 @@ public class CeService extends BaseService { } /** - * Return number of Compute Engine workers.<br/>Requires the system administration permission * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/ComponentRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/ComponentRequest.java index 9e9805b0390..4a990c8e2e0 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/ComponentRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/ComponentRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.ce; +import java.util.List; import javax.annotation.Generated; /** - * Get the pending tasks, in-progress tasks and the last executed task of a given component (usually a project).<br>Requires the following permission: 'Browse' on the specified component.<br>Either 'componentId' or 'component' must be provided. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/ce/component">Further information about this action online (including a response example)</a> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/SubmitRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/SubmitRequest.java index 69f3241c40b..c873feb13e3 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/SubmitRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/SubmitRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.ce; +import java.util.List; import javax.annotation.Generated; /** - * Submits a scanner report to the queue. Report is processed asynchronously. Requires analysis permission. If the project does not exist, then the provisioning permission is also required. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/ce/submit">Further information about this action online (including a response example)</a> @@ -40,8 +39,6 @@ public class SubmitRequest { private String report; /** - * Optional characteristic of the analysis. Can be repeated to define multiple characteristics. - * * Example value: "branchType=long" */ public SubmitRequest setCharacteristic(String characteristic) { @@ -54,8 +51,6 @@ public class SubmitRequest { } /** - * Key of the organization the project belongs to - * * This is part of the internal API. * Example value: "my-org" */ @@ -69,8 +64,6 @@ public class SubmitRequest { } /** - * Optional branch of project - * * Example value: "branch-1.x" */ public SubmitRequest setProjectBranch(String projectBranch) { @@ -83,8 +76,6 @@ public class SubmitRequest { } /** - * Key of project - * * This is a mandatory parameter. * Example value: "my_project" */ @@ -98,8 +89,6 @@ public class SubmitRequest { } /** - * Optional name of the project, used only if the project does not exist yet. - * * Example value: "My Project" */ public SubmitRequest setProjectName(String projectName) { @@ -112,8 +101,6 @@ public class SubmitRequest { } /** - * Report file. Format is not an API, it changes among SonarQube versions. - * * This is a mandatory parameter. */ public SubmitRequest setReport(String report) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/TaskRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/TaskRequest.java index e21b304cdc2..d69911ee1a0 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/TaskRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/TaskRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Give Compute Engine task details such as type, status, duration and associated component.<br />Requires 'Administer System' or 'Execute Analysis' permission.<br/>Since 6.1, field "logs" is deprecated and its value is always false. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/ce/task">Further information about this action online (including a response example)</a> @@ -37,8 +35,6 @@ public class TaskRequest { private String id; /** - * Comma-separated list of the optional fields to be returned in response. - * * Possible values: * <ul> * <li>"stacktrace"</li> @@ -55,8 +51,6 @@ public class TaskRequest { } /** - * Id of task - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/package-info.java index 9971fa2fd54..2a12f5b8e20 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/ce/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.ce; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/components/AppRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/components/AppRequest.java index 3e89464c0dd..9bf3555e1a3 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/components/AppRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/components/AppRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.components; +import java.util.List; import javax.annotation.Generated; /** - * Coverage data required for rendering the component viewer.<br>Requires the following permission: 'Browse'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/components/app">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class AppRequest { private String componentId; /** - * Branch key - * * This is part of the internal API. * Example value: "feature/my_branch" */ @@ -52,8 +49,6 @@ public class AppRequest { } /** - * Component key - * * Example value: "my_project" */ public AppRequest setComponent(String component) { @@ -66,8 +61,6 @@ public class AppRequest { } /** - * Component ID - * * Example value: "AU-Tpxb--iU5OvuD2FLy" * @deprecated since 6.4 */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/components/ComponentsService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/components/ComponentsService.java index 6058084acf7..27bca3d970c 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/components/ComponentsService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/components/ComponentsService.java @@ -24,6 +24,7 @@ import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; import org.sonarqube.ws.client.GetRequest; +import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; import org.sonarqube.ws.Components.SearchWsResponse; import org.sonarqube.ws.Components.SearchProjectsWsResponse; @@ -32,7 +33,6 @@ import org.sonarqube.ws.Components.SuggestionsWsResponse; import org.sonarqube.ws.Components.TreeWsResponse; /** - * Get information about a component (file, directory, project, ...) and its ancestors or descendants. Update a project or module key. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/components">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -43,7 +43,6 @@ public class ComponentsService extends BaseService { } /** - * Coverage data required for rendering the component viewer.<br>Requires the following permission: 'Browse'. * * This is part of the internal API. * This is a GET request. @@ -61,7 +60,6 @@ public class ComponentsService extends BaseService { } /** - * Search for components * * This is part of the internal API. * This is a GET request. @@ -81,7 +79,6 @@ public class ComponentsService extends BaseService { } /** - * Search for projects * * This is part of the internal API. * This is a GET request. @@ -103,7 +100,6 @@ public class ComponentsService extends BaseService { } /** - * Returns a component (file, directory, project, view?) and its ancestors. The ancestors are ordered from the parent to the root project. The 'componentId' or 'component' parameter must be provided.<br>Requires the following permission: 'Browse' on the project of the specified component. * * This is part of the internal API. * This is a GET request. @@ -120,7 +116,6 @@ public class ComponentsService extends BaseService { } /** - * Internal WS for the top-right search engine. The result will contain component search results, grouped by their qualifiers.<p>Each result contains:<ul><li>the organization key</li><li>the component key</li><li>the component's name (unescaped)</li><li>optionally a display name, which puts emphasis to matching characters (this text contains html tags and parts of the html-escaped name)</li></ul> * * This is part of the internal API. * This is a GET request. @@ -137,7 +132,6 @@ public class ComponentsService extends BaseService { } /** - * Navigate through components based on the chosen strategy. The componentId or the component parameter must be provided.<br>Requires the following permission: 'Browse' on the specified project.<br>When limiting search with the q parameter, directories are not returned. * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/components/SearchProjectsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/components/SearchProjectsRequest.java index 32af863b2f8..a177c6ff95b 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/components/SearchProjectsRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/components/SearchProjectsRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Search for projects - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/components/search_projects">Further information about this action online (including a response example)</a> @@ -43,8 +41,6 @@ public class SearchProjectsRequest { private String s; /** - * Ascending sort - * * Possible values: * <ul> * <li>"true"</li> @@ -63,8 +59,6 @@ public class SearchProjectsRequest { } /** - * Comma-separated list of the fields to be returned in response - * * Possible values: * <ul> * <li>"analysisDate"</li> @@ -81,8 +75,6 @@ public class SearchProjectsRequest { } /** - * Comma-separated list of the facets to be computed. No facet is computed by default. - * * Possible values: * <ul> * <li>"alert_status"</li> @@ -112,8 +104,6 @@ public class SearchProjectsRequest { } /** - * Filter of projects on name, key, measure value, quality gate, language, tag or whether a project is a favorite or not.<br>The filter must be encoded to form a valid URL (for example '=' must be replaced by '%3D').<br>Examples of use:<ul> <li>to filter my favorite projects with a failed quality gate and a coverage greater than or equals to 60% and a coverage strictly lower than 80%:<br> <code>filter="alert_status = ERROR and isFavorite and coverage >= 60 and coverage < 80"</code></li> <li>to filter projects with a reliability, security and maintainability rating equals or worse than B:<br> <code>filter="reliability_rating>=2 and security_rating>=2 and sqale_rating>=2"</code></li> <li>to filter projects without duplication data:<br> <code>filter="duplicated_lines_density = NO_DATA"</code></li></ul>To filter on project name or key, use the 'query' keyword, for instance : <code>filter='query = "Sonar"'</code>.<br><br>To filter on a numeric metric, provide the metric key.<br>These are the supported metric keys:<br><ul><li>alert_status</li><li>coverage</li><li>duplicated_lines_density</li><li>lines</li><li>ncloc</li><li>ncloc_language_distribution</li><li>new_coverage</li><li>new_duplicated_lines_density</li><li>new_lines</li><li>new_maintainability_rating</li><li>new_reliability_rating</li><li>new_security_rating</li><li>reliability_rating</li><li>security_rating</li><li>sqale_rating</li></ul><br>To filter on a rating, provide the corresponding metric key (ex: reliability_rating for reliability rating).<br>The possible values are:<ul> <li>'1' for rating A</li> <li>'2' for rating B</li> <li>'3' for rating C</li> <li>'4' for rating D</li> <li>'5' for rating E</li></ul>To filter on a Quality Gate status use the metric key 'alert_status'. Only the '=' operator can be used.<br>The possible values are:<ul> <li>'OK' for Passed</li> <li>'WARN' for Warning</li> <li>'ERROR' for Failed</li></ul>To filter on language keys use the language key: <ul> <li>to filter on a single language you can use 'language = java'</li> <li>to filter on several languages you must use 'language IN (java, js)'</li></ul>Use the WS api/languages/list to find the key of a language.<br> To filter on tags use the 'tag' keyword:<ul> <li>to filter on one tag you can use <code>tag = finance</code></li> <li>to filter on several tags you must use <code>tag in (offshore, java)</code></li></ul> - * */ public SearchProjectsRequest setFilter(String filter) { this.filter = filter; @@ -125,8 +115,6 @@ public class SearchProjectsRequest { } /** - * the organization to search projects in - * * This is part of the internal API. */ public SearchProjectsRequest setOrganization(String organization) { @@ -139,8 +127,6 @@ public class SearchProjectsRequest { } /** - * 1-based page number - * * Example value: "42" */ public SearchProjectsRequest setP(String p) { @@ -153,8 +139,6 @@ public class SearchProjectsRequest { } /** - * Page size. Must be greater than 0 and less than 500 - * * Example value: "20" */ public SearchProjectsRequest setPs(String ps) { @@ -167,8 +151,6 @@ public class SearchProjectsRequest { } /** - * Sort projects by numeric metric key, quality gate status (using 'alert_status'), last analysis date (using 'analysisDate'), or by project name. - * * Possible values: * <ul> * <li>"alert_status"</li> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/components/SearchRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/components/SearchRequest.java index 9420c8fc72c..e6346de1f5c 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/components/SearchRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/components/SearchRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Search for components - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/components/search">Further information about this action online (including a response example)</a> @@ -41,8 +39,6 @@ public class SearchRequest { private List<String> qualifiers; /** - * Language key. If provided, only components for the given language are returned. - * * Example value: "" */ public SearchRequest setLanguage(String language) { @@ -55,8 +51,6 @@ public class SearchRequest { } /** - * Organization key - * * This is part of the internal API. * Example value: "my-org" */ @@ -70,8 +64,6 @@ public class SearchRequest { } /** - * 1-based page number - * * Example value: "42" */ public SearchRequest setP(String p) { @@ -84,8 +76,6 @@ public class SearchRequest { } /** - * Page size. Must be greater than 0. - * * Example value: "20" */ public SearchRequest setPs(String ps) { @@ -98,8 +88,6 @@ public class SearchRequest { } /** - * Limit search to: <ul><li>component names that contain the supplied string</li><li>component keys that are exactly the same as the supplied string</li></ul> - * * Example value: "sonar" */ public SearchRequest setQ(String q) { @@ -112,8 +100,6 @@ public class SearchRequest { } /** - * Comma-separated list of component qualifiers. Filter the results with the specified qualifiers. Possible values are:<ul><li>BRC - Sub-projects</li><li>DIR - Directories</li><li>FIL - Files</li><li>TRK - Projects</li><li>UTS - Test Files</li></ul> - * * This is a mandatory parameter. * Possible values: * <ul> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/components/ShowRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/components/ShowRequest.java index e3caebb7ce1..0474a005e73 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/components/ShowRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/components/ShowRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.components; +import java.util.List; import javax.annotation.Generated; /** - * Returns a component (file, directory, project, view?) and its ancestors. The ancestors are ordered from the parent to the root project. The 'componentId' or 'component' parameter must be provided.<br>Requires the following permission: 'Browse' on the project of the specified component. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/components/show">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class ShowRequest { private String componentId; /** - * Branch key - * * This is part of the internal API. * Example value: "feature/my_branch" */ @@ -52,8 +49,6 @@ public class ShowRequest { } /** - * Component key - * * Example value: "my_project" */ public ShowRequest setComponent(String component) { @@ -66,8 +61,6 @@ public class ShowRequest { } /** - * Component id - * * Example value: "AU-Tpxb--iU5OvuD2FLy" * @deprecated since 6.4 */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/components/SuggestionsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/components/SuggestionsRequest.java index a00335e09c9..b5f79f1cff4 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/components/SuggestionsRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/components/SuggestionsRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Internal WS for the top-right search engine. The result will contain component search results, grouped by their qualifiers.<p>Each result contains:<ul><li>the organization key</li><li>the component key</li><li>the component's name (unescaped)</li><li>optionally a display name, which puts emphasis to matching characters (this text contains html tags and parts of the html-escaped name)</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/components/suggestions">Further information about this action online (including a response example)</a> @@ -38,8 +36,6 @@ public class SuggestionsRequest { private String s; /** - * Category, for which to display the next 20 results (skipping the first 6 results) - * * Possible values: * <ul> * <li>"VW"</li> @@ -61,8 +57,6 @@ public class SuggestionsRequest { } /** - * Comma separated list of component keys, that have recently been browsed by the user. Only the first 50 items will be used. Order is not taken into account. - * * Example value: "org.sonarsource:sonarqube,some.other:project" */ public SuggestionsRequest setRecentlyBrowsed(List<String> recentlyBrowsed) { @@ -75,8 +69,6 @@ public class SuggestionsRequest { } /** - * Search query: can contain several search tokens separated by spaces. - * * Example value: "sonar" */ public SuggestionsRequest setS(String s) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/components/TreeRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/components/TreeRequest.java index 5aaa5f1c4d2..5f87fa08bad 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/components/TreeRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/components/TreeRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Navigate through components based on the chosen strategy. The componentId or the component parameter must be provided.<br>Requires the following permission: 'Browse' on the specified project.<br>When limiting search with the q parameter, directories are not returned. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/components/tree">Further information about this action online (including a response example)</a> @@ -45,8 +43,6 @@ public class TreeRequest { private String strategy; /** - * Ascending sort - * * Possible values: * <ul> * <li>"true"</li> @@ -65,8 +61,6 @@ public class TreeRequest { } /** - * Branch key - * * This is part of the internal API. * Example value: "feature/my_branch" */ @@ -80,8 +74,6 @@ public class TreeRequest { } /** - * Base component key. The search is based on this component. - * * Example value: "my_project" */ public TreeRequest setComponent(String component) { @@ -94,8 +86,6 @@ public class TreeRequest { } /** - * Base component id. The search is based on this component. - * * Example value: "AU-TpxcA-iU5OvuD2FLz" * @deprecated since 6.4 */ @@ -110,8 +100,6 @@ public class TreeRequest { } /** - * 1-based page number - * * Example value: "42" */ public TreeRequest setP(String p) { @@ -124,8 +112,6 @@ public class TreeRequest { } /** - * Page size. Must be greater than 0 and less than 500 - * * Example value: "20" */ public TreeRequest setPs(String ps) { @@ -138,8 +124,6 @@ public class TreeRequest { } /** - * Limit search to: <ul><li>component names that contain the supplied string</li><li>component keys that are exactly the same as the supplied string</li></ul> - * * Example value: "FILE_NAM" */ public TreeRequest setQ(String q) { @@ -152,8 +136,6 @@ public class TreeRequest { } /** - * Comma-separated list of component qualifiers. Filter the results with the specified qualifiers. Possible values are:<ul><li>BRC - Sub-projects</li><li>DIR - Directories</li><li>FIL - Files</li><li>TRK - Projects</li><li>UTS - Test Files</li></ul> - * * Possible values: * <ul> * <li>"BRC"</li> @@ -173,8 +155,6 @@ public class TreeRequest { } /** - * Comma-separated list of sort fields - * * Example value: "name, path" * Possible values: * <ul> @@ -193,8 +173,6 @@ public class TreeRequest { } /** - * Strategy to search for base component descendants:<ul><li>children: return the children components of the base component. Grandchildren components are not returned</li><li>all: return all the descendants components of the base component. Grandchildren are returned.</li><li>leaves: return all the descendant components (files, in general) which don't have other children. They are the leaves of the component tree.</li></ul> - * * Possible values: * <ul> * <li>"all"</li> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/components/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/components/package-info.java index f9d52cab322..aabc5280f80 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/components/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/components/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.components; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/CreateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/CreateRequest.java index 820646e3e2b..f745ee6c6ec 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/CreateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/CreateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.custommeasures; +import java.util.List; import javax.annotation.Generated; /** - * Create a custom measure.<br /> The project id or the project key must be provided (only project and module custom measures can be created). The metric id or the metric key must be provided.<br/>Requires 'Administer System' permission or 'Administer' permission on the project. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/custom_measures/create">Further information about this action online (including a response example)</a> @@ -40,8 +39,6 @@ public class CreateRequest { private String value; /** - * Description - * * Example value: "Team size growing." */ public CreateRequest setDescription(String description) { @@ -54,8 +51,6 @@ public class CreateRequest { } /** - * Metric id - * * Example value: "16" */ public CreateRequest setMetricId(String metricId) { @@ -68,8 +63,6 @@ public class CreateRequest { } /** - * Metric key - * * Example value: "ncloc" */ public CreateRequest setMetricKey(String metricKey) { @@ -82,8 +75,6 @@ public class CreateRequest { } /** - * Project id - * * Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d" */ public CreateRequest setProjectId(String projectId) { @@ -96,8 +87,6 @@ public class CreateRequest { } /** - * Project key - * * Example value: "my_project" */ public CreateRequest setProjectKey(String projectKey) { @@ -110,8 +99,6 @@ public class CreateRequest { } /** - * Measure value. Value type depends on metric type:<ul><li>INT - type: integer</li><li>FLOAT - type: double</li><li>PERCENT - type: double</li><li>BOOL - the possible values are true or false</li><li>STRING - type: string</li><li>MILLISEC - type: integer</li><li>DATA - type: string</li><li>LEVEL - the possible values are OK, WARN, ERROR</li><li>DISTRIB - type: string</li><li>RATING - type: double</li><li>WORK_DUR - long representing the number of minutes</li></ul> - * * This is a mandatory parameter. * Example value: "47" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/CustomMeasuresService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/CustomMeasuresService.java index 335d0a8db17..1267dd5d8cb 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/CustomMeasuresService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/CustomMeasuresService.java @@ -28,7 +28,6 @@ import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; /** - * Manage custom measures for a project. See also api/metrics. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/custom_measures">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -39,7 +38,6 @@ public class CustomMeasuresService extends BaseService { } /** - * Create a custom measure.<br /> The project id or the project key must be provided (only project and module custom measures can be created). The metric id or the metric key must be provided.<br/>Requires 'Administer System' permission or 'Administer' permission on the project. * * This is part of the internal API. * This is a POST request. @@ -60,7 +58,6 @@ public class CustomMeasuresService extends BaseService { } /** - * Delete a custom measure.<br /> Requires 'Administer System' permission or 'Administer' permission on the project. * * This is part of the internal API. * This is a POST request. @@ -76,7 +73,6 @@ public class CustomMeasuresService extends BaseService { } /** - * List all custom metrics for which no custom measure already exists on a given project.<br /> The project id or project key must be provided.<br />Requires 'Administer System' permission or 'Administer' permission on the project. * * This is part of the internal API. * This is a GET request. @@ -93,7 +89,6 @@ public class CustomMeasuresService extends BaseService { } /** - * List custom measures. The project id or project key must be provided.<br />Requires 'Administer System' permission or 'Administer' permission on the project. * * This is part of the internal API. * This is a GET request. @@ -113,7 +108,6 @@ public class CustomMeasuresService extends BaseService { } /** - * Update a custom measure. Value and/or description must be provided<br />Requires 'Administer System' permission or 'Administer' permission on the project. * * This is part of the internal API. * This is a POST request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/DeleteRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/DeleteRequest.java index 202abee92b6..bff9efdaa74 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/DeleteRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/DeleteRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.custommeasures; +import java.util.List; import javax.annotation.Generated; /** - * Delete a custom measure.<br /> Requires 'Administer System' permission or 'Administer' permission on the project. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/custom_measures/delete">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class DeleteRequest { private String id; /** - * Id - * * This is a mandatory parameter. * Example value: "24" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/MetricsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/MetricsRequest.java index 390587e77d4..9f533409ff3 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/MetricsRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/MetricsRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.custommeasures; +import java.util.List; import javax.annotation.Generated; /** - * List all custom metrics for which no custom measure already exists on a given project.<br /> The project id or project key must be provided.<br />Requires 'Administer System' permission or 'Administer' permission on the project. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/custom_measures/metrics">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class MetricsRequest { private String projectKey; /** - * Project id - * * Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d" */ public MetricsRequest setProjectId(String projectId) { @@ -50,8 +47,6 @@ public class MetricsRequest { } /** - * Project key - * * Example value: "my_project" */ public MetricsRequest setProjectKey(String projectKey) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/SearchRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/SearchRequest.java index 73bdf19938e..7725a4436e4 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/SearchRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/SearchRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * List custom measures. The project id or project key must be provided.<br />Requires 'Administer System' permission or 'Administer' permission on the project. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/custom_measures/search">Further information about this action online (including a response example)</a> @@ -40,8 +38,6 @@ public class SearchRequest { private String ps; /** - * Comma-separated list of the fields to be returned in response. All the fields are returned by default. - * * Possible values: * <ul> * <li>"projectId"</li> @@ -65,8 +61,6 @@ public class SearchRequest { } /** - * 1-based page number - * * Example value: "42" */ public SearchRequest setP(String p) { @@ -79,8 +73,6 @@ public class SearchRequest { } /** - * Project id - * * Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d" */ public SearchRequest setProjectId(String projectId) { @@ -93,8 +85,6 @@ public class SearchRequest { } /** - * Project key - * * Example value: "my_project" */ public SearchRequest setProjectKey(String projectKey) { @@ -107,8 +97,6 @@ public class SearchRequest { } /** - * Page size. Must be greater than 0 and less than 500 - * * Example value: "20" */ public SearchRequest setPs(String ps) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/UpdateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/UpdateRequest.java index d19835b436f..1f0b0bf5e04 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/UpdateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/UpdateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.custommeasures; +import java.util.List; import javax.annotation.Generated; /** - * Update a custom measure. Value and/or description must be provided<br />Requires 'Administer System' permission or 'Administer' permission on the project. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/custom_measures/update">Further information about this action online (including a response example)</a> @@ -49,8 +48,6 @@ public class UpdateRequest { } /** - * id - * * This is a mandatory parameter. * Example value: "42" */ @@ -64,8 +61,6 @@ public class UpdateRequest { } /** - * Measure value. Value type depends on metric type:<ul><li>INT - type: integer</li><li>FLOAT - type: double</li><li>PERCENT - type: double</li><li>BOOL - the possible values are true or false</li><li>STRING - type: string</li><li>MILLISEC - type: integer</li><li>DATA - type: string</li><li>LEVEL - the possible values are OK, WARN, ERROR</li><li>DISTRIB - type: string</li><li>RATING - type: double</li><li>WORK_DUR - long representing the number of minutes</li></ul> - * * Example value: "true" */ public UpdateRequest setValue(String value) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/package-info.java index 54c68868c23..b520c16e98d 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/custommeasures/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.custommeasures; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/duplications/DuplicationsService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/duplications/DuplicationsService.java index 4072315d103..4ec2ce3c45e 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/duplications/DuplicationsService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/duplications/DuplicationsService.java @@ -19,14 +19,16 @@ */ package org.sonarqube.ws.client.duplications; +import java.util.stream.Collectors; import javax.annotation.Generated; +import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; import org.sonarqube.ws.client.GetRequest; +import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; import org.sonarqube.ws.Duplications.ShowResponse; /** - * Get duplication information for a project. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/duplications">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -37,7 +39,6 @@ public class DuplicationsService extends BaseService { } /** - * Get duplications. Require Browse permission on file's project * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/duplications/ShowRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/duplications/ShowRequest.java index 1e8e40b72c1..fb89c536111 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/duplications/ShowRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/duplications/ShowRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.duplications; +import java.util.List; import javax.annotation.Generated; /** - * Get duplications. Require Browse permission on file's project - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/duplications/show">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class ShowRequest { private String uuid; /** - * Branch key - * * This is part of the internal API. * Example value: "feature/my_branch" */ @@ -52,8 +49,6 @@ public class ShowRequest { } /** - * File key - * * Example value: "my_project:/src/foo/Bar.php" */ public ShowRequest setKey(String key) { @@ -66,8 +61,6 @@ public class ShowRequest { } /** - * File ID. If provided, 'key' must not be provided. - * * Example value: "584a89f2-8037-4f7b-b82c-8b45d2d63fb2" * @deprecated since 6.5 */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/duplications/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/duplications/package-info.java index cbd34e1eec1..99a000b888a 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/duplications/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/duplications/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.duplications; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/editions/ApplyLicenseRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/editions/ApplyLicenseRequest.java index 1f73cdb993b..e668b2e4afa 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/editions/ApplyLicenseRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/editions/ApplyLicenseRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.editions; +import java.util.List; import javax.annotation.Generated; /** - * Apply changes to SonarQube to match the specified license. Clear error message of previous automatic install of an edition, if there is any. Require 'Administer System' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/editions/apply_license">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class ApplyLicenseRequest { private String license; /** - * the license - * * This is a mandatory parameter. */ public ApplyLicenseRequest setLicense(String license) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/editions/EditionsService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/editions/EditionsService.java index 8f7f8ecb797..61dab2f0f42 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/editions/EditionsService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/editions/EditionsService.java @@ -19,6 +19,7 @@ */ package org.sonarqube.ws.client.editions; +import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; @@ -30,7 +31,6 @@ import org.sonarqube.ws.Editions.PreviewResponse; import org.sonarqube.ws.Editions.StatusResponse; /** - * Manage SonarSource commercial editions. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/editions">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -41,7 +41,6 @@ public class EditionsService extends BaseService { } /** - * Apply changes to SonarQube to match the specified license. Clear error message of previous automatic install of an edition, if there is any. Require 'Administer System' permission. * * This is part of the internal API. * This is a POST request. @@ -57,7 +56,6 @@ public class EditionsService extends BaseService { } /** - * Clear error message of last install of an edition (if any). Require 'Administer System' permission. * * This is part of the internal API. * This is a POST request. @@ -72,7 +70,6 @@ public class EditionsService extends BaseService { } /** - * Provide data to prefill license request forms: the server ID and the total number of lines of code. * * This is part of the internal API. * This is a GET request. @@ -86,7 +83,6 @@ public class EditionsService extends BaseService { } /** - * Preview the changes to SonarQube to match the specified license. Requires 'Administer System' permission. * * This is part of the internal API. * This is a POST request. @@ -101,7 +97,6 @@ public class EditionsService extends BaseService { } /** - * Provide status of SonarSource commercial edition of the current SonarQube. Requires 'Administer System' permission. * * This is part of the internal API. * This is a GET request. @@ -115,7 +110,6 @@ public class EditionsService extends BaseService { } /** - * Uninstall the currently installed edition. Requires 'Administer System' permission. * * This is part of the internal API. * This is a POST request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/editions/PreviewRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/editions/PreviewRequest.java index a7eaea6bf95..6eb1a4e3942 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/editions/PreviewRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/editions/PreviewRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.editions; +import java.util.List; import javax.annotation.Generated; /** - * Preview the changes to SonarQube to match the specified license. Requires 'Administer System' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/editions/preview">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class PreviewRequest { private String license; /** - * the license - * * This is a mandatory parameter. */ public PreviewRequest setLicense(String license) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/editions/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/editions/package-info.java index e600294d249..78d6e826ef7 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/editions/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/editions/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.editions; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/emails/EmailsService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/emails/EmailsService.java index ba055245b67..fab6a55b6ac 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/emails/EmailsService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/emails/EmailsService.java @@ -19,14 +19,15 @@ */ package org.sonarqube.ws.client.emails; +import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; +import org.sonarqube.ws.client.GetRequest; import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; /** - * Manage emails * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/emails">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -37,7 +38,6 @@ public class EmailsService extends BaseService { } /** - * Test email configuration by sending an email<br>Requires 'Administer System' permission. * * This is part of the internal API. * This is a POST request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/emails/SendRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/emails/SendRequest.java index 62499e9d5ed..2a97433e5b9 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/emails/SendRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/emails/SendRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.emails; +import java.util.List; import javax.annotation.Generated; /** - * Test email configuration by sending an email<br>Requires 'Administer System' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/emails/send">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class SendRequest { private String to; /** - * Content of the email - * * This is a mandatory parameter. */ public SendRequest setMessage(String message) { @@ -51,8 +48,6 @@ public class SendRequest { } /** - * Subject of the email - * * Example value: "Test Message from SonarQube" */ public SendRequest setSubject(String subject) { @@ -65,8 +60,6 @@ public class SendRequest { } /** - * Email address - * * This is a mandatory parameter. * Example value: "john@doo.com" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/emails/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/emails/package-info.java index 2219eedc11c..8eb96f9b701 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/emails/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/emails/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.emails; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/favorites/AddRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/favorites/AddRequest.java index d4e18905fca..e75235caf15 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/favorites/AddRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/favorites/AddRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.favorites; +import java.util.List; import javax.annotation.Generated; /** - * Add a component (project, directory, file etc.) as favorite for the authenticated user.<br>Requires authentication and the following permission: 'Browse' on the project of the specified component. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/favorites/add">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class AddRequest { private String component; /** - * Component key - * * This is a mandatory parameter. * Example value: "my_project:/src/foo/Bar.php" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/favorites/FavoritesService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/favorites/FavoritesService.java index 1780e219093..fcd011d2470 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/favorites/FavoritesService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/favorites/FavoritesService.java @@ -19,6 +19,7 @@ */ package org.sonarqube.ws.client.favorites; +import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; @@ -28,7 +29,6 @@ import org.sonarqube.ws.client.WsConnector; import org.sonarqube.ws.Favorites.SearchResponse; /** - * Manage user favorites * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/favorites">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -39,7 +39,6 @@ public class FavoritesService extends BaseService { } /** - * Add a component (project, directory, file etc.) as favorite for the authenticated user.<br>Requires authentication and the following permission: 'Browse' on the project of the specified component. * * This is part of the internal API. * This is a POST request. @@ -55,7 +54,6 @@ public class FavoritesService extends BaseService { } /** - * Remove a component (project, directory, file etc.) as favorite for the authenticated user.<br>Requires authentication. * * This is part of the internal API. * This is a POST request. @@ -71,7 +69,6 @@ public class FavoritesService extends BaseService { } /** - * Search for the authenticated user favorites.<br>Requires authentication. * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/favorites/RemoveRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/favorites/RemoveRequest.java index a70356c2b87..8bfe4d2113c 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/favorites/RemoveRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/favorites/RemoveRequest.java @@ -22,8 +22,6 @@ package org.sonarqube.ws.client.favorites; import javax.annotation.Generated; /** - * Remove a component (project, directory, file etc.) as favorite for the authenticated user.<br>Requires authentication. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/favorites/remove">Further information about this action online (including a response example)</a> @@ -35,8 +33,6 @@ public class RemoveRequest { private String component; /** - * Component key - * * This is a mandatory parameter. * Example value: "my_project" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/favorites/SearchRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/favorites/SearchRequest.java index fb5fd19f689..1db684496a9 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/favorites/SearchRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/favorites/SearchRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.favorites; +import java.util.List; import javax.annotation.Generated; /** - * Search for the authenticated user favorites.<br>Requires authentication. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/favorites/search">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class SearchRequest { private String ps; /** - * 1-based page number - * * Example value: "42" */ public SearchRequest setP(String p) { @@ -50,8 +47,6 @@ public class SearchRequest { } /** - * Page size. Must be greater than 0 and less than 500 - * * Example value: "20" */ public SearchRequest setPs(String ps) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/favorites/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/favorites/package-info.java index 3a3d70569a0..b51f7a28260 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/favorites/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/favorites/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.favorites; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/favourites/FavouritesService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/favourites/FavouritesService.java index 5c09bfb13bb..aed3488ea82 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/favourites/FavouritesService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/favourites/FavouritesService.java @@ -28,7 +28,6 @@ import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; /** - * Removed since 6.3, please use api/favorites instead * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/favourites">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -39,7 +38,6 @@ public class FavouritesService extends BaseService { } /** - * The web service is removed and you're invited to use api/favorites instead * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/favourites/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/favourites/package-info.java index 49cec47934d..7835ea19eba 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/favourites/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/favourites/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.favourites; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/AddCommentRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/AddCommentRequest.java index ee6f39a0b92..ca04f7fd04c 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/AddCommentRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/AddCommentRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.issues; +import java.util.List; import javax.annotation.Generated; /** - * Add a comment.<br/>Requires authentication and the following permission: 'Browse' on the project of the specified issue. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/add_comment">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class AddCommentRequest { private String text; /** - * Issue key - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy" */ @@ -51,8 +48,6 @@ public class AddCommentRequest { } /** - * Comment text - * * This is a mandatory parameter. * Example value: "Won't fix because it doesn't apply to the context" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/AssignRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/AssignRequest.java index 587dd26f47b..97818a73a48 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/AssignRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/AssignRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.issues; +import java.util.List; import javax.annotation.Generated; /** - * Assign/Unassign an issue. Requires authentication and Browse permission on project - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/assign">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class AssignRequest { private String me; /** - * Login of the assignee. When not set, it will unassign the issue. Use '_me' to assign to current user - * * Example value: "admin" */ public AssignRequest setAssignee(String assignee) { @@ -51,8 +48,6 @@ public class AssignRequest { } /** - * Issue key - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy" */ @@ -66,8 +61,6 @@ public class AssignRequest { } /** - * (deprecated) Assign the issue to the logged-in user. Replaced by the parameter assignee=_me - * * Possible values: * <ul> * <li>"true"</li> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/AuthorsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/AuthorsRequest.java index 031c45f9ebb..98de8bec479 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/AuthorsRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/AuthorsRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.issues; +import java.util.List; import javax.annotation.Generated; /** - * Search SCM accounts which match a given query - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/authors">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class AuthorsRequest { private String q; /** - * The size of the list to return - * * Example value: "25" */ public AuthorsRequest setPs(String ps) { @@ -50,8 +47,6 @@ public class AuthorsRequest { } /** - * A pattern to match SCM accounts against - * * Example value: "luke" */ public AuthorsRequest setQ(String q) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/BulkChangeRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/BulkChangeRequest.java index 4ec3a531e85..77090d583c5 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/BulkChangeRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/BulkChangeRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Bulk change on issues.<br/>Requires authentication. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/bulk_change">Further information about this action online (including a response example)</a> @@ -34,19 +32,17 @@ import javax.annotation.Generated; public class BulkChangeRequest { private String addTags; - private String assign; - private String comment; + private List<String> assign; + private List<String> comment; private String doTransition; private List<String> issues; - private String plan; + private List<String> plan; private String removeTags; private String sendNotifications; - private String setSeverity; - private String setType; + private List<String> setSeverity; + private List<String> setType; /** - * Add tags - * * Example value: "security,java8" */ public BulkChangeRequest setAddTags(String addTags) { @@ -59,36 +55,30 @@ public class BulkChangeRequest { } /** - * To assign the list of issues to a specific user (login), or un-assign all the issues - * * Example value: "john.smith" */ - public BulkChangeRequest setAssign(String assign) { + public BulkChangeRequest setAssign(List<String> assign) { this.assign = assign; return this; } - public String getAssign() { + public List<String> getAssign() { return assign; } /** - * To add a comment to a list of issues - * * Example value: "Here is my comment" */ - public BulkChangeRequest setComment(String comment) { + public BulkChangeRequest setComment(List<String> comment) { this.comment = comment; return this; } - public String getComment() { + public List<String> getComment() { return comment; } /** - * Transition - * * Example value: "reopen" * Possible values: * <ul> @@ -111,8 +101,6 @@ public class BulkChangeRequest { } /** - * Comma-separated list of issue keys - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy,AU-TpxcA-iU5OvuD2FLz" */ @@ -126,23 +114,19 @@ public class BulkChangeRequest { } /** - * In 5.5, action plans are dropped. Has no effect. To plan the list of issues to a specific action plan (key), or unlink all the issues from an action plan - * * @deprecated since 5.5 */ @Deprecated - public BulkChangeRequest setPlan(String plan) { + public BulkChangeRequest setPlan(List<String> plan) { this.plan = plan; return this; } - public String getPlan() { + public List<String> getPlan() { return plan; } /** - * Remove tags - * * Example value: "security,java8" */ public BulkChangeRequest setRemoveTags(String removeTags) { @@ -173,8 +157,6 @@ public class BulkChangeRequest { } /** - * To change the severity of the list of issues - * * Example value: "BLOCKER" * Possible values: * <ul> @@ -185,18 +167,16 @@ public class BulkChangeRequest { * <li>"BLOCKER"</li> * </ul> */ - public BulkChangeRequest setSetSeverity(String setSeverity) { + public BulkChangeRequest setSetSeverity(List<String> setSeverity) { this.setSeverity = setSeverity; return this; } - public String getSetSeverity() { + public List<String> getSetSeverity() { return setSeverity; } /** - * To change the type of the list of issues - * * Example value: "BUG" * Possible values: * <ul> @@ -205,12 +185,12 @@ public class BulkChangeRequest { * <li>"VULNERABILITY"</li> * </ul> */ - public BulkChangeRequest setSetType(String setType) { + public BulkChangeRequest setSetType(List<String> setType) { this.setType = setType; return this; } - public String getSetType() { + public List<String> getSetType() { return setType; } } diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/ChangelogRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/ChangelogRequest.java index b70965837c8..e5fc05c1b77 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/ChangelogRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/ChangelogRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.issues; +import java.util.List; import javax.annotation.Generated; /** - * Display changelog of an issue.<br/>Requires the 'Browse' permission on the project of the specified issue. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/changelog">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class ChangelogRequest { private String issue; /** - * Issue key - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/ComponentTagsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/ComponentTagsRequest.java index 9454932bddc..d7c2201e068 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/ComponentTagsRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/ComponentTagsRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.issues; +import java.util.List; import javax.annotation.Generated; /** - * List tags for the issues under a given component (including issues on the descendants of the component) - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/component_tags">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class ComponentTagsRequest { private String ps; /** - * A component UUID - * * This is a mandatory parameter. * Example value: "7d8749e8-3070-4903-9188-bdd82933bb92" */ @@ -52,8 +49,6 @@ public class ComponentTagsRequest { } /** - * To retrieve tags on issues created after the given date (inclusive). <br>Either a date (server timezone) or datetime can be provided. - * * Example value: "2017-10-19 or 2017-10-19T13:00:00+0200" */ public ComponentTagsRequest setCreatedAfter(String createdAfter) { @@ -66,8 +61,6 @@ public class ComponentTagsRequest { } /** - * The maximum size of the list to return - * * Example value: "25" */ public ComponentTagsRequest setPs(String ps) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/DeleteCommentRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/DeleteCommentRequest.java index 36c8f409e1c..db442955896 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/DeleteCommentRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/DeleteCommentRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.issues; +import java.util.List; import javax.annotation.Generated; /** - * Delete a comment.<br/>Requires authentication and the following permission: 'Browse' on the project of the specified issue. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/delete_comment">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class DeleteCommentRequest { private String comment; /** - * Comment key - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/DoTransitionRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/DoTransitionRequest.java index a7cd1461fb4..c21add2be63 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/DoTransitionRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/DoTransitionRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.issues; +import java.util.List; import javax.annotation.Generated; /** - * Do workflow transition on an issue. Requires authentication and Browse permission on project.<br/>The transitions 'wontfix' and 'falsepositive' require the permission 'Administer Issues'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/do_transition">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class DoTransitionRequest { private String transition; /** - * Issue key - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy" */ @@ -51,8 +48,6 @@ public class DoTransitionRequest { } /** - * Transition - * * This is a mandatory parameter. * Possible values: * <ul> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/EditCommentRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/EditCommentRequest.java index 9052a612295..e24458548f7 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/EditCommentRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/EditCommentRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.issues; +import java.util.List; import javax.annotation.Generated; /** - * Edit a comment.<br/>Requires authentication and the following permission: 'Browse' on the project of the specified issue. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/edit_comment">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class EditCommentRequest { private String text; /** - * Comment key - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy" */ @@ -51,8 +48,6 @@ public class EditCommentRequest { } /** - * Comment text - * * This is a mandatory parameter. * Example value: "Won't fix because it doesn't apply to the context" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/IssuesService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/IssuesService.java index 08a21c6cc31..2ca4e8be540 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/IssuesService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/IssuesService.java @@ -31,7 +31,6 @@ import org.sonarqube.ws.Issues.ChangelogWsResponse; import org.sonarqube.ws.Issues.SearchWsResponse; /** - * Read and update issues. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -42,7 +41,6 @@ public class IssuesService extends BaseService { } /** - * Add a comment.<br/>Requires authentication and the following permission: 'Browse' on the project of the specified issue. * * This is part of the internal API. * This is a POST request. @@ -59,7 +57,6 @@ public class IssuesService extends BaseService { } /** - * Assign/Unassign an issue. Requires authentication and Browse permission on project * * This is part of the internal API. * This is a POST request. @@ -77,7 +74,6 @@ public class IssuesService extends BaseService { } /** - * Search SCM accounts which match a given query * * This is part of the internal API. * This is a GET request. @@ -94,7 +90,6 @@ public class IssuesService extends BaseService { } /** - * Bulk change on issues.<br/>Requires authentication. * * This is part of the internal API. * This is a POST request. @@ -105,20 +100,19 @@ public class IssuesService extends BaseService { return call( new PostRequest(path("bulk_change")) .setParam("add_tags", request.getAddTags()) - .setParam("assign", request.getAssign()) - .setParam("comment", request.getComment()) + .setParam("assign", request.getAssign() == null ? null : request.getAssign().stream().collect(Collectors.joining(","))) + .setParam("comment", request.getComment() == null ? null : request.getComment().stream().collect(Collectors.joining(","))) .setParam("do_transition", request.getDoTransition()) .setParam("issues", request.getIssues() == null ? null : request.getIssues().stream().collect(Collectors.joining(","))) - .setParam("plan", request.getPlan()) + .setParam("plan", request.getPlan() == null ? null : request.getPlan().stream().collect(Collectors.joining(","))) .setParam("remove_tags", request.getRemoveTags()) .setParam("sendNotifications", request.getSendNotifications()) - .setParam("set_severity", request.getSetSeverity()) - .setParam("set_type", request.getSetType()), + .setParam("set_severity", request.getSetSeverity() == null ? null : request.getSetSeverity().stream().collect(Collectors.joining(","))) + .setParam("set_type", request.getSetType() == null ? null : request.getSetType().stream().collect(Collectors.joining(","))), BulkChangeWsResponse.parser()); } /** - * Display changelog of an issue.<br/>Requires the 'Browse' permission on the project of the specified issue. * * This is part of the internal API. * This is a GET request. @@ -133,7 +127,6 @@ public class IssuesService extends BaseService { } /** - * List tags for the issues under a given component (including issues on the descendants of the component) * * This is part of the internal API. * This is a GET request. @@ -151,7 +144,6 @@ public class IssuesService extends BaseService { } /** - * Delete a comment.<br/>Requires authentication and the following permission: 'Browse' on the project of the specified issue. * * This is part of the internal API. * This is a POST request. @@ -167,7 +159,6 @@ public class IssuesService extends BaseService { } /** - * Do workflow transition on an issue. Requires authentication and Browse permission on project.<br/>The transitions 'wontfix' and 'falsepositive' require the permission 'Administer Issues'. * * This is part of the internal API. * This is a POST request. @@ -184,7 +175,6 @@ public class IssuesService extends BaseService { } /** - * Edit a comment.<br/>Requires authentication and the following permission: 'Browse' on the project of the specified issue. * * This is part of the internal API. * This is a POST request. @@ -201,7 +191,6 @@ public class IssuesService extends BaseService { } /** - * Search for issues.<br>At most one of the following parameters can be provided at the same time: componentKeys, componentUuids, components, componentRootUuids, componentRoots.<br>Requires the 'Browse' permission on the specified project(s). * * This is part of the internal API. * This is a GET request. @@ -252,7 +241,6 @@ public class IssuesService extends BaseService { } /** - * Change severity.<br/>Requires the following permissions:<ul> <li>'Authentication'</li> <li>'Browse' rights on project of the specified issue</li> <li>'Administer Issues' rights on project of the specified issue</li></ul> * * This is part of the internal API. * This is a POST request. @@ -269,7 +257,6 @@ public class IssuesService extends BaseService { } /** - * Set tags on an issue. <br/>Requires authentication and Browse permission on project * * This is part of the internal API. * This is a POST request. @@ -286,7 +273,6 @@ public class IssuesService extends BaseService { } /** - * Change type of issue, for instance from 'code smell' to 'bug'.<br/>Requires the following permissions:<ul> <li>'Authentication'</li> <li>'Browse' rights on project of the specified issue</li> <li>'Administer Issues' rights on project of the specified issue</li></ul> * * This is part of the internal API. * This is a POST request. @@ -303,7 +289,6 @@ public class IssuesService extends BaseService { } /** - * List tags matching a given query * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/SearchRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/SearchRequest.java index 3e173c152a8..f1a67e14bc4 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/SearchRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/SearchRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Search for issues.<br>At most one of the following parameters can be provided at the same time: componentKeys, componentUuids, components, componentRootUuids, componentRoots.<br>Requires the 'Browse' permission on the specified project(s). - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/search">Further information about this action online (including a response example)</a> @@ -72,8 +70,6 @@ public class SearchRequest { private List<String> types; /** - * Comma-separated list of the optional fields to be returned in response. Action plans are dropped in 5.5, it is not returned in the response. - * * Possible values: * <ul> * <li>"_all"</li> @@ -96,8 +92,6 @@ public class SearchRequest { } /** - * Ascending sort - * * Possible values: * <ul> * <li>"true"</li> @@ -116,8 +110,6 @@ public class SearchRequest { } /** - * To retrieve assigned or unassigned issues - * * Possible values: * <ul> * <li>"true"</li> @@ -136,8 +128,6 @@ public class SearchRequest { } /** - * Comma-separated list of assignee logins. The value '__me__' can be used as a placeholder for user who performs the request - * * Example value: "admin,usera,__me__" */ public SearchRequest setAssignees(List<String> assignees) { @@ -150,8 +140,6 @@ public class SearchRequest { } /** - * Comma-separated list of SCM accounts - * * Example value: "torvalds@linux-foundation.org" */ public SearchRequest setAuthors(List<String> authors) { @@ -164,8 +152,6 @@ public class SearchRequest { } /** - * Branch key - * * This is part of the internal API. * Example value: "feature/my_branch" */ @@ -179,8 +165,6 @@ public class SearchRequest { } /** - * Comma-separated list of component keys. Retrieve issues associated to a specific list of components (and all its descendants). A component can be a portfolio, project, module, directory or file. - * * Example value: "my_project" */ public SearchRequest setComponentKeys(List<String> componentKeys) { @@ -193,8 +177,6 @@ public class SearchRequest { } /** - * If used, will have the same meaning as componentUuids AND onComponentOnly=false. - * * @deprecated since 5.1 */ @Deprecated @@ -208,8 +190,6 @@ public class SearchRequest { } /** - * If used, will have the same meaning as componentKeys AND onComponentOnly=false. - * * @deprecated since 5.1 */ @Deprecated @@ -223,8 +203,6 @@ public class SearchRequest { } /** - * To retrieve issues associated to a specific list of components their sub-components (comma-separated list of component IDs). This parameter is mostly used by the Issues page, please prefer usage of the componentKeys parameter. A component can be a project, module, directory or file. - * * Example value: "584a89f2-8037-4f7b-b82c-8b45d2d63fb2" * @deprecated since 6.5 */ @@ -239,8 +217,6 @@ public class SearchRequest { } /** - * If used, will have the same meaning as componentKeys AND onComponentOnly=true. - * * @deprecated since 5.1 */ @Deprecated @@ -254,8 +230,6 @@ public class SearchRequest { } /** - * To retrieve issues created after the given date (inclusive). <br>Either a date (server timezone) or datetime can be provided. <br>If this parameter is set, createdSince must not be set - * * Example value: "2017-10-19 or 2017-10-19T13:00:00+0200" */ public SearchRequest setCreatedAfter(String createdAfter) { @@ -268,8 +242,6 @@ public class SearchRequest { } /** - * Datetime to retrieve issues created during a specific analysis - * * Example value: "2017-10-19T13:00:00+0200" */ public SearchRequest setCreatedAt(String createdAt) { @@ -282,8 +254,6 @@ public class SearchRequest { } /** - * To retrieve issues created before the given date (inclusive). <br>Either a date (server timezone) or datetime can be provided. - * * Example value: "2017-10-19 or 2017-10-19T13:00:00+0200" */ public SearchRequest setCreatedBefore(String createdBefore) { @@ -296,8 +266,6 @@ public class SearchRequest { } /** - * To retrieve issues created during a time span before the current time (exclusive). Accepted units are 'y' for year, 'm' for month, 'w' for week and 'd' for day. If this parameter is set, createdAfter must not be set - * * Example value: "1m2w (1 month 2 weeks)" */ public SearchRequest setCreatedInLast(String createdInLast) { @@ -310,8 +278,6 @@ public class SearchRequest { } /** - * To retrieve issues associated to a specific list of directories (comma-separated list of directory paths). This parameter is only meaningful when a module is selected. This parameter is mostly used by the Issues page, please prefer usage of the componentKeys parameter. - * * This is part of the internal API. * Example value: "src/main/java/org/sonar/server/" */ @@ -325,8 +291,6 @@ public class SearchRequest { } /** - * Choose the returned value for facet items, either count of issues or sum of debt.<br/>Since 5.5, 'debt' mode is deprecated and replaced by 'effort' - * * Possible values: * <ul> * <li>"count"</li> @@ -344,8 +308,6 @@ public class SearchRequest { } /** - * Comma-separated list of the facets to be computed. No facet is computed by default.<br/>Since 5.5, facet 'actionPlans' is deprecated.<br/>Since 5.5, facet 'reporters' is deprecated. - * * Possible values: * <ul> * <li>"severities"</li> @@ -377,8 +339,6 @@ public class SearchRequest { } /** - * To retrieve issues associated to a specific list of files (comma-separated list of file IDs). This parameter is mostly used by the Issues page, please prefer usage of the componentKeys parameter. - * * This is part of the internal API. * Example value: "bdd82933-3070-4903-9188-7d8749e8bb92" */ @@ -392,8 +352,6 @@ public class SearchRequest { } /** - * Comma-separated list of issue keys - * * Example value: "5bccd6e8-f525-43a2-8d76-fcb13dde79ef" */ public SearchRequest setIssues(List<String> issues) { @@ -406,8 +364,6 @@ public class SearchRequest { } /** - * Comma-separated list of languages. Available since 4.4 - * * Example value: "java,js" */ public SearchRequest setLanguages(List<String> languages) { @@ -420,8 +376,6 @@ public class SearchRequest { } /** - * To retrieve issues associated to a specific list of modules (comma-separated list of module IDs). This parameter is mostly used by the Issues page, please prefer usage of the componentKeys parameter. - * * This is part of the internal API. * Example value: "7d8749e8-3070-4903-9188-bdd82933bb92" */ @@ -435,8 +389,6 @@ public class SearchRequest { } /** - * Return only issues at a component's level, not on its descendants (modules, directories, files, etc). This parameter is only considered when componentKeys or componentUuids is set. Using the deprecated componentRoots or componentRootUuids parameters will set this parameter to false. Using the deprecated components parameter will set this parameter to true. - * * Possible values: * <ul> * <li>"true"</li> @@ -455,8 +407,6 @@ public class SearchRequest { } /** - * Organization key - * * This is part of the internal API. * Example value: "my-org" */ @@ -470,8 +420,6 @@ public class SearchRequest { } /** - * 1-based page number - * * Example value: "42" */ public SearchRequest setP(String p) { @@ -484,8 +432,6 @@ public class SearchRequest { } /** - * To retrieve issues associated to a specific list of projects (comma-separated list of project IDs). This parameter is mostly used by the Issues page, please prefer usage of the componentKeys parameter. Portfolios are not supported. If this parameter is set, 'projects' must not be set. - * * This is part of the internal API. * Example value: "7d8749e8-3070-4903-9188-bdd82933bb92" */ @@ -499,8 +445,6 @@ public class SearchRequest { } /** - * To retrieve issues associated to a specific list of projects (comma-separated list of project keys). This parameter is mostly used by the Issues page, please prefer usage of the componentKeys parameter. If this parameter is set, projectUuids must not be set. - * * This is part of the internal API. * Example value: "my_project" */ @@ -514,8 +458,6 @@ public class SearchRequest { } /** - * Page size. Must be greater than 0 and less than 500 - * * Example value: "20" */ public SearchRequest setPs(String ps) { @@ -528,8 +470,6 @@ public class SearchRequest { } /** - * Comma-separated list of resolutions - * * Example value: "FIXED,REMOVED" * Possible values: * <ul> @@ -549,8 +489,6 @@ public class SearchRequest { } /** - * To match resolved or unresolved issues - * * Possible values: * <ul> * <li>"true"</li> @@ -569,8 +507,6 @@ public class SearchRequest { } /** - * Comma-separated list of coding rule keys. Format is <repository>:<rule> - * * Example value: "squid:AvoidCycles" */ public SearchRequest setRules(List<String> rules) { @@ -583,8 +519,6 @@ public class SearchRequest { } /** - * Sort field - * * Possible values: * <ul> * <li>"CREATION_DATE"</li> @@ -606,8 +540,6 @@ public class SearchRequest { } /** - * Comma-separated list of severities - * * Example value: "BLOCKER,CRITICAL" * Possible values: * <ul> @@ -628,8 +560,6 @@ public class SearchRequest { } /** - * To retrieve issues created since the leak period.<br>If this parameter is set to a truthy value, createdAfter must not be set and one component id or key must be provided. - * * Possible values: * <ul> * <li>"true"</li> @@ -648,8 +578,6 @@ public class SearchRequest { } /** - * Comma-separated list of statuses - * * Example value: "OPEN,REOPENED" * Possible values: * <ul> @@ -670,8 +598,6 @@ public class SearchRequest { } /** - * Comma-separated list of tags. - * * Example value: "security,convention" */ public SearchRequest setTags(List<String> tags) { @@ -684,8 +610,6 @@ public class SearchRequest { } /** - * Comma-separated list of types. - * * Example value: "CODE_SMELL,BUG" * Possible values: * <ul> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/SetSeverityRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/SetSeverityRequest.java index fd41cefbd5a..b56feae510d 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/SetSeverityRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/SetSeverityRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.issues; +import java.util.List; import javax.annotation.Generated; /** - * Change severity.<br/>Requires the following permissions:<ul> <li>'Authentication'</li> <li>'Browse' rights on project of the specified issue</li> <li>'Administer Issues' rights on project of the specified issue</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/set_severity">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class SetSeverityRequest { private String severity; /** - * Issue key - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy" */ @@ -51,8 +48,6 @@ public class SetSeverityRequest { } /** - * New severity - * * This is a mandatory parameter. * Possible values: * <ul> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/SetTagsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/SetTagsRequest.java index bc8556f1423..2dc8ef256aa 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/SetTagsRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/SetTagsRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Set tags on an issue. <br/>Requires authentication and Browse permission on project - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/set_tags">Further information about this action online (including a response example)</a> @@ -37,8 +35,6 @@ public class SetTagsRequest { private List<String> tags; /** - * Issue key - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy" */ @@ -52,8 +48,6 @@ public class SetTagsRequest { } /** - * Comma-separated list of tags. All tags are removed if parameter is empty or not set. - * * Example value: "security,cwe,misra-c" */ public SetTagsRequest setTags(List<String> tags) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/SetTypeRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/SetTypeRequest.java index e6afe1e31ac..1f534b8ae2d 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/SetTypeRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/SetTypeRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.issues; +import java.util.List; import javax.annotation.Generated; /** - * Change type of issue, for instance from 'code smell' to 'bug'.<br/>Requires the following permissions:<ul> <li>'Authentication'</li> <li>'Browse' rights on project of the specified issue</li> <li>'Administer Issues' rights on project of the specified issue</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/set_type">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class SetTypeRequest { private String type; /** - * Issue key - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy" */ @@ -51,8 +48,6 @@ public class SetTypeRequest { } /** - * New type - * * This is a mandatory parameter. * Possible values: * <ul> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/TagsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/TagsRequest.java index 382f37d2bd5..e1522752ab9 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/TagsRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/TagsRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.issues; +import java.util.List; import javax.annotation.Generated; /** - * List tags matching a given query - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/issues/tags">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class TagsRequest { private String q; /** - * Organization key - * * This is part of the internal API. * Example value: "my-org" */ @@ -52,8 +49,6 @@ public class TagsRequest { } /** - * Page size. Must be greater than 0 and less than 100 - * * Example value: "20" */ public TagsRequest setPs(String ps) { @@ -66,8 +61,6 @@ public class TagsRequest { } /** - * Limit search to tags that contain the supplied string. - * * Example value: "misra" */ public TagsRequest setQ(String q) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/package-info.java index 54bcbbbe7c4..cebe352f14d 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/issues/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.issues; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/l10n/IndexRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/l10n/IndexRequest.java index a0329cf1e74..6a78bf3b93e 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/l10n/IndexRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/l10n/IndexRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.l10n; +import java.util.List; import javax.annotation.Generated; /** - * Get all localization messages for a given locale - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/l10n/index">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class IndexRequest { private String ts; /** - * BCP47 language tag, used to override the browser Accept-Language header - * * Example value: "fr-CH" */ public IndexRequest setLocale(String locale) { @@ -50,8 +47,6 @@ public class IndexRequest { } /** - * Date of the last cache update. - * * Example value: "2014-06-04T09:31:42+0000" */ public IndexRequest setTs(String ts) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/l10n/L10nService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/l10n/L10nService.java index f85e7cf7677..97aaf654372 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/l10n/L10nService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/l10n/L10nService.java @@ -19,14 +19,15 @@ */ package org.sonarqube.ws.client.l10n; +import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; import org.sonarqube.ws.client.GetRequest; +import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; /** - * Manage localization. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/l10n">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -37,7 +38,6 @@ public class L10nService extends BaseService { } /** - * Get all localization messages for a given locale * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/l10n/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/l10n/package-info.java index ee4983df47a..2b45b69cf95 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/l10n/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/l10n/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.l10n; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/languages/LanguagesService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/languages/LanguagesService.java index e529b9dac18..eff3959d81f 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/languages/LanguagesService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/languages/LanguagesService.java @@ -19,14 +19,15 @@ */ package org.sonarqube.ws.client.languages; +import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; import org.sonarqube.ws.client.GetRequest; +import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; /** - * Get the list of programming languages supported in this instance. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/languages">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -37,7 +38,6 @@ public class LanguagesService extends BaseService { } /** - * List supported programming languages * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/languages/ListRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/languages/ListRequest.java index e8d40e1638c..5dda36f7c05 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/languages/ListRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/languages/ListRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.languages; +import java.util.List; import javax.annotation.Generated; /** - * List supported programming languages - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/languages/list">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class ListRequest { private String q; /** - * The size of the list to return, 0 for all languages - * * Example value: "25" */ public ListRequest setPs(String ps) { @@ -50,8 +47,6 @@ public class ListRequest { } /** - * A pattern to match language keys/names against - * * Example value: "java" */ public ListRequest setQ(String q) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/languages/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/languages/package-info.java index 8dafd59b3ba..a7e5bae2a26 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/languages/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/languages/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.languages; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/ComponentRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/ComponentRequest.java index 7b08703dc9a..eea21c7966c 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/ComponentRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/ComponentRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Return component with specified measures. The componentId or the component parameter must be provided.<br>Requires the following permission: 'Browse' on the project of specified component. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/measures/component">Further information about this action online (including a response example)</a> @@ -42,8 +40,6 @@ public class ComponentRequest { private String metricKeys; /** - * Comma-separated list of additional fields that can be returned in the response. - * * Example value: "periods,metrics" * Possible values: * <ul> @@ -61,8 +57,6 @@ public class ComponentRequest { } /** - * Branch key - * * This is part of the internal API. * Example value: "feature/my_branch" */ @@ -76,8 +70,6 @@ public class ComponentRequest { } /** - * Component key - * * Example value: "my_project" */ public ComponentRequest setComponent(String component) { @@ -90,8 +82,6 @@ public class ComponentRequest { } /** - * Component id - * * Example value: "AU-Tpxb--iU5OvuD2FLy" * @deprecated since 6.6 */ @@ -106,8 +96,6 @@ public class ComponentRequest { } /** - * Deprecated parameter, used previously with the Developer Cockpit plugin. No measures are returned if parameter is set. - * * @deprecated since 6.4 */ @Deprecated @@ -121,8 +109,6 @@ public class ComponentRequest { } /** - * Deprecated parameter, used previously with the Developer Cockpit plugin. No measures are returned if parameter is set. - * * @deprecated since 6.4 */ @Deprecated @@ -136,8 +122,6 @@ public class ComponentRequest { } /** - * Metric keys - * * This is a mandatory parameter. * Example value: "ncloc,complexity,violations" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/ComponentTreeRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/ComponentTreeRequest.java index 24ddb21cc9e..c63da756229 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/ComponentTreeRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/ComponentTreeRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Navigate through components based on the chosen strategy with specified measures. The baseComponentId or the component parameter must be provided.<br>Requires the following permission: 'Browse' on the specified project.<br>When limiting search with the q parameter, directories are not returned. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/measures/component_tree">Further information about this action online (including a response example)</a> @@ -52,8 +50,6 @@ public class ComponentTreeRequest { private String strategy; /** - * Comma-separated list of additional fields that can be returned in the response. - * * Example value: "periods,metrics" * Possible values: * <ul> @@ -71,8 +67,6 @@ public class ComponentTreeRequest { } /** - * Ascending sort - * * Possible values: * <ul> * <li>"true"</li> @@ -91,8 +85,6 @@ public class ComponentTreeRequest { } /** - * Base component id. The search is based on this component. - * * Example value: "AU-TpxcA-iU5OvuD2FLz" * @deprecated since 6.6 */ @@ -107,8 +99,6 @@ public class ComponentTreeRequest { } /** - * Branch key - * * This is part of the internal API. * Example value: "feature/my_branch" */ @@ -122,8 +112,6 @@ public class ComponentTreeRequest { } /** - * Component key. The search is based on this component. - * * Example value: "my_project" */ public ComponentTreeRequest setComponent(String component) { @@ -136,8 +124,6 @@ public class ComponentTreeRequest { } /** - * Deprecated parameter, used previously with the Developer Cockpit plugin. No measures are returned if parameter is set. - * * @deprecated since 6.4 */ @Deprecated @@ -151,8 +137,6 @@ public class ComponentTreeRequest { } /** - * Deprecated parameter, used previously with the Developer Cockpit plugin. No measures are returned if parameter is set. - * * @deprecated since 6.4 */ @Deprecated @@ -166,8 +150,6 @@ public class ComponentTreeRequest { } /** - * Metric keys. Types DISTRIB, DATA are not allowed - * * This is a mandatory parameter. * Example value: "ncloc,complexity,violations" */ @@ -181,8 +163,6 @@ public class ComponentTreeRequest { } /** - * Sort measures by leak period or not ?. The 's' parameter must contain the 'metricPeriod' value. - * * Possible values: * <ul> * <li>"1"</li> @@ -198,8 +178,6 @@ public class ComponentTreeRequest { } /** - * Metric key to sort by. The 's' parameter must contain the 'metric' or 'metricPeriod' value. It must be part of the 'metricKeys' parameter - * * Example value: "ncloc" */ public ComponentTreeRequest setMetricSort(String metricSort) { @@ -212,8 +190,6 @@ public class ComponentTreeRequest { } /** - * Filter components. Sort must be on a metric. Possible values are: <ul><li>all: return all components</li><li>withMeasuresOnly: filter out components that do not have a measure on the sorted metric</li></ul> - * * Possible values: * <ul> * <li>"all"</li> @@ -230,8 +206,6 @@ public class ComponentTreeRequest { } /** - * 1-based page number - * * Example value: "42" */ public ComponentTreeRequest setP(String p) { @@ -244,8 +218,6 @@ public class ComponentTreeRequest { } /** - * Page size. Must be greater than 0 and less than 500 - * * Example value: "20" */ public ComponentTreeRequest setPs(String ps) { @@ -258,8 +230,6 @@ public class ComponentTreeRequest { } /** - * Limit search to: <ul><li>component names that contain the supplied string</li><li>component keys that are exactly the same as the supplied string</li></ul> - * * Example value: "FILE_NAM" */ public ComponentTreeRequest setQ(String q) { @@ -272,8 +242,6 @@ public class ComponentTreeRequest { } /** - * Comma-separated list of component qualifiers. Filter the results with the specified qualifiers. Possible values are:<ul><li>BRC - Sub-projects</li><li>DIR - Directories</li><li>FIL - Files</li><li>TRK - Projects</li><li>UTS - Test Files</li></ul> - * * Possible values: * <ul> * <li>"BRC"</li> @@ -293,8 +261,6 @@ public class ComponentTreeRequest { } /** - * Comma-separated list of sort fields - * * Example value: "name,path" * Possible values: * <ul> @@ -315,8 +281,6 @@ public class ComponentTreeRequest { } /** - * Strategy to search for base component descendants:<ul><li>children: return the children components of the base component. Grandchildren components are not returned</li><li>all: return all the descendants components of the base component. Grandchildren are returned.</li><li>leaves: return all the descendant components (files, in general) which don't have other children. They are the leaves of the component tree.</li></ul> - * * Possible values: * <ul> * <li>"all"</li> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/MeasuresService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/MeasuresService.java index 5fd6d045afb..7422d8aae2d 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/MeasuresService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/MeasuresService.java @@ -21,8 +21,10 @@ package org.sonarqube.ws.client.measures; import java.util.stream.Collectors; import javax.annotation.Generated; +import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; import org.sonarqube.ws.client.GetRequest; +import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; import org.sonarqube.ws.Measures.ComponentWsResponse; import org.sonarqube.ws.Measures.ComponentTreeWsResponse; @@ -30,7 +32,6 @@ import org.sonarqube.ws.Measures.SearchWsResponse; import org.sonarqube.ws.Measures.SearchHistoryResponse; /** - * Get components or children with specified measures. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/measures">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -41,7 +42,6 @@ public class MeasuresService extends BaseService { } /** - * Return component with specified measures. The componentId or the component parameter must be provided.<br>Requires the following permission: 'Browse' on the project of specified component. * * This is part of the internal API. * This is a GET request. @@ -62,7 +62,6 @@ public class MeasuresService extends BaseService { } /** - * Navigate through components based on the chosen strategy with specified measures. The baseComponentId or the component parameter must be provided.<br>Requires the following permission: 'Browse' on the specified project.<br>When limiting search with the q parameter, directories are not returned. * * This is part of the internal API. * This is a GET request. @@ -93,7 +92,6 @@ public class MeasuresService extends BaseService { } /** - * Search for project measures ordered by project names.<br>At most 100 projects can be provided.<br>Returns the projects with the 'Browse' permission. * * This is part of the internal API. * This is a GET request. @@ -109,7 +107,6 @@ public class MeasuresService extends BaseService { } /** - * Search measures history of a component.<br>Measures are ordered chronologically.<br>Pagination applies to the number of measures for each metric.<br>Requires the following permission: 'Browse' on the specified component * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/SearchHistoryRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/SearchHistoryRequest.java index 75968c2913b..6d7f6db55ae 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/SearchHistoryRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/SearchHistoryRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Search measures history of a component.<br>Measures are ordered chronologically.<br>Pagination applies to the number of measures for each metric.<br>Requires the following permission: 'Browse' on the specified component - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/measures/search_history">Further information about this action online (including a response example)</a> @@ -42,8 +40,6 @@ public class SearchHistoryRequest { private String to; /** - * Branch key - * * This is part of the internal API. * Example value: "feature/my_branch" */ @@ -57,8 +53,6 @@ public class SearchHistoryRequest { } /** - * Component key - * * This is a mandatory parameter. * Example value: "my_project" */ @@ -72,8 +66,6 @@ public class SearchHistoryRequest { } /** - * Filter measures created after the given date (inclusive). <br>Either a date (server timezone) or datetime can be provided - * * Example value: "2017-10-19 or 2017-10-19T13:00:00+0200" */ public SearchHistoryRequest setFrom(String from) { @@ -86,8 +78,6 @@ public class SearchHistoryRequest { } /** - * Comma-separated list of metric keys - * * This is a mandatory parameter. * Example value: "ncloc,coverage,new_violations" */ @@ -101,8 +91,6 @@ public class SearchHistoryRequest { } /** - * 1-based page number - * * Example value: "42" */ public SearchHistoryRequest setP(String p) { @@ -115,8 +103,6 @@ public class SearchHistoryRequest { } /** - * Page size. Must be greater than 0 and less than 1000 - * * Example value: "20" */ public SearchHistoryRequest setPs(String ps) { @@ -129,8 +115,6 @@ public class SearchHistoryRequest { } /** - * Filter measures created before the given date (inclusive). <br>Either a date (server timezone) or datetime can be provided - * * Example value: "2017-10-19 or 2017-10-19T13:00:00+0200" */ public SearchHistoryRequest setTo(String to) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/SearchRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/SearchRequest.java index bae1b77e66e..bd7614fb216 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/SearchRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/SearchRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Search for project measures ordered by project names.<br>At most 100 projects can be provided.<br>Returns the projects with the 'Browse' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/measures/search">Further information about this action online (including a response example)</a> @@ -37,8 +35,6 @@ public class SearchRequest { private List<String> projectKeys; /** - * Metric keys - * * This is a mandatory parameter. * Example value: "ncloc,complexity,violations" */ @@ -52,8 +48,6 @@ public class SearchRequest { } /** - * Comma-separated list of project, view or sub-view keys - * * This is a mandatory parameter. * Example value: "my_project,another_project" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/package-info.java index 9f1f8db5423..d938a4b9dbf 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/measures/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.measures; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/CreateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/CreateRequest.java index f531e324524..b0892be2d8b 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/CreateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/CreateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.metrics; +import java.util.List; import javax.annotation.Generated; /** - * Create custom metric.<br /> Requires 'Administer System' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/metrics/create">Further information about this action online (including a response example)</a> @@ -39,8 +38,6 @@ public class CreateRequest { private String type; /** - * Description - * * Example value: "Size of the team" */ public CreateRequest setDescription(String description) { @@ -53,8 +50,6 @@ public class CreateRequest { } /** - * Domain - * * Example value: "Tests" */ public CreateRequest setDomain(String domain) { @@ -67,8 +62,6 @@ public class CreateRequest { } /** - * Key - * * This is a mandatory parameter. * Example value: "team_size" */ @@ -82,8 +75,6 @@ public class CreateRequest { } /** - * Name - * * This is a mandatory parameter. * Example value: "Team Size" */ @@ -97,8 +88,6 @@ public class CreateRequest { } /** - * Metric type key - * * This is a mandatory parameter. * Example value: "INT" * Possible values: diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/DeleteRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/DeleteRequest.java index 8a6fd1b57ba..4326fcd782f 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/DeleteRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/DeleteRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.metrics; +import java.util.List; import javax.annotation.Generated; /** - * Delete metrics and associated measures. Delete only custom metrics.<br />Ids or keys must be provided. <br />Requires 'Administer System' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/metrics/delete">Further information about this action online (including a response example)</a> @@ -33,11 +32,9 @@ import javax.annotation.Generated; public class DeleteRequest { private String ids; - private String keys; + private List<String> keys; /** - * Metrics ids to delete. - * * Example value: "5, 23, 42" */ public DeleteRequest setIds(String ids) { @@ -50,16 +47,14 @@ public class DeleteRequest { } /** - * Metrics keys to delete - * * Example value: "team_size, business_value" */ - public DeleteRequest setKeys(String keys) { + public DeleteRequest setKeys(List<String> keys) { this.keys = keys; return this; } - public String getKeys() { + public List<String> getKeys() { return keys; } } diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/MetricsService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/MetricsService.java index edd4ddddceb..35844748a9f 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/MetricsService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/MetricsService.java @@ -28,7 +28,6 @@ import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; /** - * Get information on automatic metrics, and manage custom metrics. See also api/custom_measures. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/metrics">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -39,7 +38,6 @@ public class MetricsService extends BaseService { } /** - * Create custom metric.<br /> Requires 'Administer System' permission. * * This is part of the internal API. * This is a POST request. @@ -59,7 +57,6 @@ public class MetricsService extends BaseService { } /** - * Delete metrics and associated measures. Delete only custom metrics.<br />Ids or keys must be provided. <br />Requires 'Administer System' permission. * * This is part of the internal API. * This is a POST request. @@ -70,13 +67,12 @@ public class MetricsService extends BaseService { call( new PostRequest(path("delete")) .setParam("ids", request.getIds()) - .setParam("keys", request.getKeys()) + .setParam("keys", request.getKeys() == null ? null : request.getKeys().stream().collect(Collectors.joining(","))) .setMediaType(MediaTypes.JSON) ).content(); } /** - * List all custom metric domains. * * This is part of the internal API. * This is a GET request. @@ -91,7 +87,6 @@ public class MetricsService extends BaseService { } /** - * Search for metrics * * This is part of the internal API. * This is a GET request. @@ -110,7 +105,6 @@ public class MetricsService extends BaseService { } /** - * List all available metric types. * * This is part of the internal API. * This is a GET request. @@ -125,7 +119,6 @@ public class MetricsService extends BaseService { } /** - * Update a custom metric.<br /> Requires 'Administer System' permission. * * This is part of the internal API. * This is a POST request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/SearchRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/SearchRequest.java index 78de3b5affc..9c3c1b309b5 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/SearchRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/SearchRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Search for metrics - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/metrics/search">Further information about this action online (including a response example)</a> @@ -39,8 +37,6 @@ public class SearchRequest { private String ps; /** - * Comma-separated list of the fields to be returned in response. All the fields are returned by default. - * * Possible values: * <ul> * <li>"name"</li> @@ -63,8 +59,6 @@ public class SearchRequest { } /** - * Choose custom metrics following 3 cases:<ul><li>true: only custom metrics are returned</li><li>false: only non custom metrics are returned</li><li>not specified: all metrics are returned</li></ul> - * * Example value: "true" */ public SearchRequest setIsCustom(String isCustom) { @@ -77,8 +71,6 @@ public class SearchRequest { } /** - * 1-based page number - * * Example value: "42" */ public SearchRequest setP(String p) { @@ -91,8 +83,6 @@ public class SearchRequest { } /** - * Page size. Must be greater than 0 and less than 500 - * * Example value: "20" */ public SearchRequest setPs(String ps) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/UpdateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/UpdateRequest.java index 7fa7e924408..ba0cd8389f9 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/UpdateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/UpdateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.metrics; +import java.util.List; import javax.annotation.Generated; /** - * Update a custom metric.<br /> Requires 'Administer System' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/metrics/update">Further information about this action online (including a response example)</a> @@ -40,8 +39,6 @@ public class UpdateRequest { private String type; /** - * Description - * * Example value: "Size of the team" */ public UpdateRequest setDescription(String description) { @@ -54,8 +51,6 @@ public class UpdateRequest { } /** - * Domain - * * Example value: "Tests" */ public UpdateRequest setDomain(String domain) { @@ -68,8 +63,6 @@ public class UpdateRequest { } /** - * Id of the custom metric to update - * * This is a mandatory parameter. * Example value: "42" */ @@ -83,8 +76,6 @@ public class UpdateRequest { } /** - * Key - * * Example value: "team_size" */ public UpdateRequest setKey(String key) { @@ -97,8 +88,6 @@ public class UpdateRequest { } /** - * Name - * */ public UpdateRequest setName(String name) { this.name = name; @@ -110,8 +99,6 @@ public class UpdateRequest { } /** - * Metric type key - * * Example value: "INT" * Possible values: * <ul> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/package-info.java index fc0260329a7..406a5d66d6a 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/metrics/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.metrics; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/navigation/ComponentRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/navigation/ComponentRequest.java index 0aa9560a93a..865197c7c0e 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/navigation/ComponentRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/navigation/ComponentRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.navigation; +import java.util.List; import javax.annotation.Generated; /** - * Get information concerning component navigation for the current user. Requires the 'Browse' permission on the component's project. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/navigation/component">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class ComponentRequest { private String component; /** - * Branch key - * * This is part of the internal API. * Example value: "feature/my_branch" */ @@ -51,8 +48,6 @@ public class ComponentRequest { } /** - * A component key. - * * Example value: "my_project" */ public ComponentRequest setComponent(String component) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/navigation/NavigationService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/navigation/NavigationService.java index c26b4642733..43fb876cca2 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/navigation/NavigationService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/navigation/NavigationService.java @@ -19,14 +19,15 @@ */ package org.sonarqube.ws.client.navigation; +import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; import org.sonarqube.ws.client.GetRequest; +import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; /** - * Get information required to build navigation UI components * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/navigation">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -37,7 +38,6 @@ public class NavigationService extends BaseService { } /** - * Get information concerning component navigation for the current user. Requires the 'Browse' permission on the component's project. * * This is part of the internal API. * This is a GET request. @@ -54,7 +54,6 @@ public class NavigationService extends BaseService { } /** - * Get information concerning global navigation for the current user. * * This is part of the internal API. * This is a GET request. @@ -69,7 +68,6 @@ public class NavigationService extends BaseService { } /** - * Get information concerning organization navigation for the current user * * This is part of the internal API. * This is a GET request. @@ -85,7 +83,6 @@ public class NavigationService extends BaseService { } /** - * Get configuration information for the settings page:<ul> <li>List plugin-contributed pages</li> <li>Show update center (or not)</li></ul> * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/navigation/OrganizationRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/navigation/OrganizationRequest.java index 44e77279a60..19774cb1376 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/navigation/OrganizationRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/navigation/OrganizationRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.navigation; +import java.util.List; import javax.annotation.Generated; /** - * Get information concerning organization navigation for the current user - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/navigation/organization">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class OrganizationRequest { private String organization; /** - * the organization key - * * This is a mandatory parameter. * Example value: "my-org" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/navigation/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/navigation/package-info.java index c64db1d660c..59ee1f2dfd1 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/navigation/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/navigation/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.navigation; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/notifications/AddRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/notifications/AddRequest.java index 31d6f0bccbd..f782c38e15f 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/notifications/AddRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/notifications/AddRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.notifications; +import java.util.List; import javax.annotation.Generated; /** - * Add a notification for the authenticated user.<br>Requires one of the following permissions:<ul> <li>Authentication if no login is provided. If a project is provided, requires the 'Browse' permission on the specified project.</li> <li>System administration if a login is provided. If a project is provided, requires the 'Browse' permission on the specified project.</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/notifications/add">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class AddRequest { private String type; /** - * Channel through which the notification is sent. For example, notifications can be sent by email. - * * Possible values: * <ul> * <li>"EmailNotificationChannel"</li> @@ -55,8 +52,6 @@ public class AddRequest { } /** - * User login - * */ public AddRequest setLogin(String login) { this.login = login; @@ -68,8 +63,6 @@ public class AddRequest { } /** - * Project key - * * Example value: "my_project" */ public AddRequest setProject(String project) { @@ -82,8 +75,6 @@ public class AddRequest { } /** - * Notification type. Possible values are for:<ul> <li>Global notifications: CeReportTaskFailure, ChangesOnMyIssue, NewAlerts, NewFalsePositiveIssue, NewIssues, SQ-MyNewIssues</li> <li>Per project notifications: CeReportTaskFailure, ChangesOnMyIssue, NewAlerts, NewFalsePositiveIssue, NewIssues, SQ-MyNewIssues</li></ul> - * * This is a mandatory parameter. * Example value: "SQ-MyNewIssues" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/notifications/ListRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/notifications/ListRequest.java index a9d0344b995..6500957d950 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/notifications/ListRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/notifications/ListRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.notifications; +import java.util.List; import javax.annotation.Generated; /** - * List notifications of the authenticated user.<br>Requires one of the following permissions:<ul> <li>Authentication if no login is provided</li> <li>System administration if a login is provided</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/notifications/list">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class ListRequest { private String login; /** - * User login - * */ public ListRequest setLogin(String login) { this.login = login; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/notifications/NotificationsService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/notifications/NotificationsService.java index 81986d4d004..e891e9034ed 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/notifications/NotificationsService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/notifications/NotificationsService.java @@ -19,6 +19,7 @@ */ package org.sonarqube.ws.client.notifications; +import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; @@ -28,7 +29,6 @@ import org.sonarqube.ws.client.WsConnector; import org.sonarqube.ws.Notifications.ListResponse; /** - * Manage notifications of the authenticated user * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/notifications">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -39,7 +39,6 @@ public class NotificationsService extends BaseService { } /** - * Add a notification for the authenticated user.<br>Requires one of the following permissions:<ul> <li>Authentication if no login is provided. If a project is provided, requires the 'Browse' permission on the specified project.</li> <li>System administration if a login is provided. If a project is provided, requires the 'Browse' permission on the specified project.</li></ul> * * This is part of the internal API. * This is a POST request. @@ -58,7 +57,6 @@ public class NotificationsService extends BaseService { } /** - * List notifications of the authenticated user.<br>Requires one of the following permissions:<ul> <li>Authentication if no login is provided</li> <li>System administration if a login is provided</li></ul> * * This is part of the internal API. * This is a GET request. @@ -73,7 +71,6 @@ public class NotificationsService extends BaseService { } /** - * Remove a notification for the authenticated user.<br>Requires one of the following permissions:<ul> <li>Authentication if no login is provided</li> <li>System administration if a login is provided</li></ul> * * This is part of the internal API. * This is a POST request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/notifications/RemoveRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/notifications/RemoveRequest.java index a676877084c..fc191221c7d 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/notifications/RemoveRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/notifications/RemoveRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.notifications; +import java.util.List; import javax.annotation.Generated; /** - * Remove a notification for the authenticated user.<br>Requires one of the following permissions:<ul> <li>Authentication if no login is provided</li> <li>System administration if a login is provided</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/notifications/remove">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class RemoveRequest { private String type; /** - * Channel through which the notification is sent. For example, notifications can be sent by email. - * * Possible values: * <ul> * <li>"EmailNotificationChannel"</li> @@ -55,8 +52,6 @@ public class RemoveRequest { } /** - * User login - * */ public RemoveRequest setLogin(String login) { this.login = login; @@ -68,8 +63,6 @@ public class RemoveRequest { } /** - * Project key - * * Example value: "my_project" */ public RemoveRequest setProject(String project) { @@ -82,8 +75,6 @@ public class RemoveRequest { } /** - * Notification type. Possible values are for:<ul> <li>Global notifications: CeReportTaskFailure, ChangesOnMyIssue, NewAlerts, NewFalsePositiveIssue, NewIssues, SQ-MyNewIssues</li> <li>Per project notifications: CeReportTaskFailure, ChangesOnMyIssue, NewAlerts, NewFalsePositiveIssue, NewIssues, SQ-MyNewIssues</li></ul> - * * This is a mandatory parameter. * Example value: "SQ-MyNewIssues" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/notifications/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/notifications/package-info.java index 5123440ea4f..0ce1f574f66 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/notifications/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/notifications/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.notifications; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/AddMemberRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/AddMemberRequest.java index 71dee854e0f..68ffa13bfaf 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/AddMemberRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/AddMemberRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.organizations; +import java.util.List; import javax.annotation.Generated; /** - * Add a user as a member of an organization.<br>Requires 'Administer System' permission on the specified organization. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/organizations/add_member">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class AddMemberRequest { private String organization; /** - * User login - * * This is a mandatory parameter. * Example value: "ray.bradbury" */ @@ -51,8 +48,6 @@ public class AddMemberRequest { } /** - * Organization key - * * This is a mandatory parameter. * Example value: "my-org" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/CreateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/CreateRequest.java index 5d377f21c46..8c5a8559653 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/CreateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/CreateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.organizations; +import java.util.List; import javax.annotation.Generated; /** - * Create an organization.<br />Requires 'Administer System' permission unless any logged in user is allowed to create an organization (see appropriate setting). Organization support must be enabled. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/organizations/create">Further information about this action online (including a response example)</a> @@ -39,8 +38,6 @@ public class CreateRequest { private String url; /** - * URL of the organization avatar.<br/> It must be less than 256 chars long. - * * Example value: "https://www.foo.com/foo.png" */ public CreateRequest setAvatar(String avatar) { @@ -53,8 +50,6 @@ public class CreateRequest { } /** - * Description of the organization.<br/> It must be less than 256 chars long. - * * Example value: "The Foo company produces quality software for Bar." */ public CreateRequest setDescription(String description) { @@ -67,8 +62,6 @@ public class CreateRequest { } /** - * Key of the organization. <br />The key is unique to the whole SonarQube. <br/>When not specified, the key is computed from the name. <br />Otherwise, it must be between 2 and 32 chars long. All chars must be lower-case letters (a to z), digits or dash (but dash can neither be trailing nor heading) - * * Example value: "foo-company" */ public CreateRequest setKey(String key) { @@ -81,8 +74,6 @@ public class CreateRequest { } /** - * Name of the organization. <br />It must be between 2 and 64 chars longs. - * * This is a mandatory parameter. * Example value: "Foo Company" */ @@ -96,8 +87,6 @@ public class CreateRequest { } /** - * URL of the organization.<br/> It must be less than 256 chars long. - * * Example value: "https://www.foo.com" */ public CreateRequest setUrl(String url) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/DeleteRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/DeleteRequest.java index 3607e9c6092..a6becaf93bf 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/DeleteRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/DeleteRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.organizations; +import java.util.List; import javax.annotation.Generated; /** - * Delete an organization.<br/>Require 'Administer System' permission on the specified organization. Organization support must be enabled. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/organizations/delete">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class DeleteRequest { private String organization; /** - * Organization key - * * This is a mandatory parameter. * Example value: "foo-company" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/OrganizationsService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/OrganizationsService.java index 70afb5c2f2a..9c412040f6a 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/OrganizationsService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/OrganizationsService.java @@ -33,7 +33,6 @@ import org.sonarqube.ws.Organizations.SearchMembersWsResponse; import org.sonarqube.ws.Organizations.UpdateWsResponse; /** - * Manage organizations. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/organizations">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -44,7 +43,6 @@ public class OrganizationsService extends BaseService { } /** - * Add a user as a member of an organization.<br>Requires 'Administer System' permission on the specified organization. * * This is part of the internal API. * This is a POST request. @@ -60,7 +58,6 @@ public class OrganizationsService extends BaseService { } /** - * Create an organization.<br />Requires 'Administer System' permission unless any logged in user is allowed to create an organization (see appropriate setting). Organization support must be enabled. * * This is part of the internal API. * This is a POST request. @@ -79,7 +76,6 @@ public class OrganizationsService extends BaseService { } /** - * Delete an organization.<br/>Require 'Administer System' permission on the specified organization. Organization support must be enabled. * * This is part of the internal API. * This is a POST request. @@ -95,7 +91,6 @@ public class OrganizationsService extends BaseService { } /** - * Enable support of organizations.<br />'Administer System' permission is required. The logged-in user will be flagged as root and will be able to manage organizations and other root users. * * This is part of the internal API. * This is a POST request. @@ -110,7 +105,6 @@ public class OrganizationsService extends BaseService { } /** - * Remove a member from an organization.<br>Requires 'Administer System' permission on the specified organization. * * This is part of the internal API. * This is a POST request. @@ -127,7 +121,6 @@ public class OrganizationsService extends BaseService { } /** - * Search for organizations * * This is part of the internal API. * This is a GET request. @@ -144,7 +137,6 @@ public class OrganizationsService extends BaseService { } /** - * Search members of an organization * * This is part of the internal API. * This is a GET request. @@ -163,7 +155,6 @@ public class OrganizationsService extends BaseService { } /** - * List keys of the organizations for which the currently authenticated user has the System Administer permission for. * * This is part of the internal API. * This is a GET request. @@ -178,7 +169,6 @@ public class OrganizationsService extends BaseService { } /** - * Update an organization.<br/>Require 'Administer System' permission. Organization support must be enabled. * * This is part of the internal API. * This is a POST request. @@ -197,7 +187,6 @@ public class OrganizationsService extends BaseService { } /** - * Update the default visibility for new projects of the specified organization. * * This is part of the internal API. * This is a POST request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/RemoveMemberRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/RemoveMemberRequest.java index 5bb2a89013d..b9e0889f8ce 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/RemoveMemberRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/RemoveMemberRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.organizations; +import java.util.List; import javax.annotation.Generated; /** - * Remove a member from an organization.<br>Requires 'Administer System' permission on the specified organization. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/organizations/remove_member">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class RemoveMemberRequest { private String organization; /** - * User login - * * This is a mandatory parameter. * Example value: "ray.bradbury" */ @@ -51,8 +48,6 @@ public class RemoveMemberRequest { } /** - * Organization key - * * This is a mandatory parameter. * Example value: "my-org" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/SearchMembersRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/SearchMembersRequest.java index 36378eb522f..22376d848e9 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/SearchMembersRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/SearchMembersRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.organizations; +import java.util.List; import javax.annotation.Generated; /** - * Search members of an organization - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/organizations/search_members">Further information about this action online (including a response example)</a> @@ -39,8 +38,6 @@ public class SearchMembersRequest { private String selected; /** - * Organization key - * * This is part of the internal API. */ public SearchMembersRequest setOrganization(String organization) { @@ -53,8 +50,6 @@ public class SearchMembersRequest { } /** - * 1-based page number - * * Example value: "42" */ public SearchMembersRequest setP(String p) { @@ -67,8 +62,6 @@ public class SearchMembersRequest { } /** - * Page size. Must be greater than 0 and less than 500 - * * Example value: "20" */ public SearchMembersRequest setPs(String ps) { @@ -81,8 +74,6 @@ public class SearchMembersRequest { } /** - * Limit search to names or logins that contain the supplied string. - * * Example value: "orwe" */ public SearchMembersRequest setQ(String q) { @@ -95,8 +86,6 @@ public class SearchMembersRequest { } /** - * Depending on the value, show only selected items (selected=selected) or deselected items (selected=deselected). - * * This is part of the internal API. * Possible values: * <ul> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/SearchRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/SearchRequest.java index 3a0f7d0ccaa..2b613848984 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/SearchRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/SearchRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Search for organizations - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/organizations/search">Further information about this action online (including a response example)</a> @@ -59,8 +57,6 @@ public class SearchRequest { } /** - * Comma-separated list of organization keys - * * Example value: "my-org-1,foocorp" */ public SearchRequest setOrganizations(List<String> organizations) { @@ -73,8 +69,6 @@ public class SearchRequest { } /** - * 1-based page number - * * Example value: "42" */ public SearchRequest setP(String p) { @@ -87,8 +81,6 @@ public class SearchRequest { } /** - * Page size. Must be greater than 0 and less than 500 - * * Example value: "20" */ public SearchRequest setPs(String ps) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/UpdateProjectVisibilityRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/UpdateProjectVisibilityRequest.java index 6312e3b0148..8c491594992 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/UpdateProjectVisibilityRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/UpdateProjectVisibilityRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.organizations; +import java.util.List; import javax.annotation.Generated; /** - * Update the default visibility for new projects of the specified organization. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/organizations/update_project_visibility">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class UpdateProjectVisibilityRequest { private String projectVisibility; /** - * Organization key - * * This is a mandatory parameter. * Example value: "foo-company" */ @@ -51,8 +48,6 @@ public class UpdateProjectVisibilityRequest { } /** - * Default visibility for projects - * * This is a mandatory parameter. * Possible values: * <ul> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/UpdateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/UpdateRequest.java index 5a68f8ce565..bfc9d7f2412 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/UpdateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/UpdateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.organizations; +import java.util.List; import javax.annotation.Generated; /** - * Update an organization.<br/>Require 'Administer System' permission. Organization support must be enabled. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/organizations/update">Further information about this action online (including a response example)</a> @@ -39,8 +38,6 @@ public class UpdateRequest { private String url; /** - * URL of the organization avatar.<br/> It must be less than 256 chars long. - * * Example value: "https://www.foo.com/foo.png" */ public UpdateRequest setAvatar(String avatar) { @@ -53,8 +50,6 @@ public class UpdateRequest { } /** - * Description of the organization.<br/> It must be less than 256 chars long. - * * Example value: "The Foo company produces quality software for Bar." */ public UpdateRequest setDescription(String description) { @@ -67,8 +62,6 @@ public class UpdateRequest { } /** - * Organization key - * * This is a mandatory parameter. * Example value: "foo-company" */ @@ -82,8 +75,6 @@ public class UpdateRequest { } /** - * Name of the organization. <br />It must be between 2 and 64 chars longs. - * * Example value: "Foo Company" */ public UpdateRequest setName(String name) { @@ -96,8 +87,6 @@ public class UpdateRequest { } /** - * URL of the organization.<br/> It must be less than 256 chars long. - * * Example value: "https://www.foo.com" */ public UpdateRequest setUrl(String url) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/package-info.java index 73e9af0ac8e..640ac7f32bc 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/organizations/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.organizations; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/AddGroupRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/AddGroupRequest.java index 0e0f1dc7714..4057779d348 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/AddGroupRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/AddGroupRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * Add permission to a group.<br /> This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br /> The group name or group id must be provided. <br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/add_group">Further information about this action online (including a response example)</a> @@ -40,8 +39,6 @@ public class AddGroupRequest { private String projectKey; /** - * Group id - * * Example value: "42" */ public AddGroupRequest setGroupId(String groupId) { @@ -54,8 +51,6 @@ public class AddGroupRequest { } /** - * Group name or 'anyone' (case insensitive) - * * Example value: "sonar-administrators" */ public AddGroupRequest setGroupName(String groupName) { @@ -68,8 +63,6 @@ public class AddGroupRequest { } /** - * Key of organization, used when group name is set - * * This is part of the internal API. * Example value: "my-org" */ @@ -83,8 +76,6 @@ public class AddGroupRequest { } /** - * Permission<ul><li>Possible values for global permissions: admin, profileadmin, gateadmin, scan, provisioning</li><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul> - * * This is a mandatory parameter. */ public AddGroupRequest setPermission(String permission) { @@ -97,8 +88,6 @@ public class AddGroupRequest { } /** - * Project id - * * Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d" */ public AddGroupRequest setProjectId(String projectId) { @@ -111,8 +100,6 @@ public class AddGroupRequest { } /** - * Project key - * * Example value: "my_project" */ public AddGroupRequest setProjectKey(String projectKey) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/AddGroupToTemplateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/AddGroupToTemplateRequest.java index a0327360dc1..8bbe3d822f8 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/AddGroupToTemplateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/AddGroupToTemplateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * Add a group to a permission template.<br /> The group id or group name must be provided. <br />Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/add_group_to_template">Further information about this action online (including a response example)</a> @@ -40,8 +39,6 @@ public class AddGroupToTemplateRequest { private String templateName; /** - * Group id - * * Example value: "42" */ public AddGroupToTemplateRequest setGroupId(String groupId) { @@ -54,8 +51,6 @@ public class AddGroupToTemplateRequest { } /** - * Group name or 'anyone' (case insensitive) - * * Example value: "sonar-administrators" */ public AddGroupToTemplateRequest setGroupName(String groupName) { @@ -68,8 +63,6 @@ public class AddGroupToTemplateRequest { } /** - * Key of organization, used when group name is set - * * This is part of the internal API. * Example value: "my-org" */ @@ -83,8 +76,6 @@ public class AddGroupToTemplateRequest { } /** - * Permission<ul><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul> - * * This is a mandatory parameter. * Possible values: * <ul> @@ -105,8 +96,6 @@ public class AddGroupToTemplateRequest { } /** - * Template id - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public AddGroupToTemplateRequest setTemplateId(String templateId) { @@ -119,8 +108,6 @@ public class AddGroupToTemplateRequest { } /** - * Template name - * * Example value: "Default Permission Template for Projects" */ public AddGroupToTemplateRequest setTemplateName(String templateName) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/AddProjectCreatorToTemplateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/AddProjectCreatorToTemplateRequest.java index 8a73942deb5..ed384317b9a 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/AddProjectCreatorToTemplateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/AddProjectCreatorToTemplateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * Add a project creator to a permission template.<br>Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/add_project_creator_to_template">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class AddProjectCreatorToTemplateRequest { private String templateName; /** - * Key of organization, used when group name is set - * * This is part of the internal API. * Example value: "my-org" */ @@ -53,8 +50,6 @@ public class AddProjectCreatorToTemplateRequest { } /** - * Permission<ul><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul> - * * This is a mandatory parameter. * Possible values: * <ul> @@ -75,8 +70,6 @@ public class AddProjectCreatorToTemplateRequest { } /** - * Template id - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public AddProjectCreatorToTemplateRequest setTemplateId(String templateId) { @@ -89,8 +82,6 @@ public class AddProjectCreatorToTemplateRequest { } /** - * Template name - * * Example value: "Default Permission Template for Projects" */ public AddProjectCreatorToTemplateRequest setTemplateName(String templateName) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/AddUserRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/AddUserRequest.java index 34683ef98a5..e53e402574e 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/AddUserRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/AddUserRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * Add permission to a user.<br /> This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/add_user">Further information about this action online (including a response example)</a> @@ -39,8 +38,6 @@ public class AddUserRequest { private String projectKey; /** - * User login - * * This is a mandatory parameter. * Example value: "g.hopper" */ @@ -54,8 +51,6 @@ public class AddUserRequest { } /** - * Key of organization, cannot be used at the same time with projectId and projectKey - * * This is part of the internal API. * Example value: "my-org" */ @@ -69,8 +64,6 @@ public class AddUserRequest { } /** - * Permission<ul><li>Possible values for global permissions: admin, profileadmin, gateadmin, scan, provisioning</li><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul> - * * This is a mandatory parameter. */ public AddUserRequest setPermission(String permission) { @@ -83,8 +76,6 @@ public class AddUserRequest { } /** - * Project id - * * Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d" */ public AddUserRequest setProjectId(String projectId) { @@ -97,8 +88,6 @@ public class AddUserRequest { } /** - * Project key - * * Example value: "my_project" */ public AddUserRequest setProjectKey(String projectKey) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/AddUserToTemplateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/AddUserToTemplateRequest.java index 711d0785616..291e02dba67 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/AddUserToTemplateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/AddUserToTemplateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * Add a user to a permission template.<br /> Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/add_user_to_template">Further information about this action online (including a response example)</a> @@ -39,8 +38,6 @@ public class AddUserToTemplateRequest { private String templateName; /** - * User login - * * This is a mandatory parameter. * Example value: "g.hopper" */ @@ -54,8 +51,6 @@ public class AddUserToTemplateRequest { } /** - * Key of organization, used when group name is set - * * This is part of the internal API. * Example value: "my-org" */ @@ -69,8 +64,6 @@ public class AddUserToTemplateRequest { } /** - * Permission<ul><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul> - * * This is a mandatory parameter. * Possible values: * <ul> @@ -91,8 +84,6 @@ public class AddUserToTemplateRequest { } /** - * Template id - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public AddUserToTemplateRequest setTemplateId(String templateId) { @@ -105,8 +96,6 @@ public class AddUserToTemplateRequest { } /** - * Template name - * * Example value: "Default Permission Template for Projects" */ public AddUserToTemplateRequest setTemplateName(String templateName) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/ApplyTemplateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/ApplyTemplateRequest.java index 3bff1df9ae3..e283daa283e 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/ApplyTemplateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/ApplyTemplateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * Apply a permission template to one project.<br>The project id or project key must be provided.<br>The template id or name must be provided.<br>Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/apply_template">Further information about this action online (including a response example)</a> @@ -39,8 +38,6 @@ public class ApplyTemplateRequest { private String templateName; /** - * Key of organization, used when group name is set - * * This is part of the internal API. * Example value: "my-org" */ @@ -54,8 +51,6 @@ public class ApplyTemplateRequest { } /** - * Project id - * * Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d" */ public ApplyTemplateRequest setProjectId(String projectId) { @@ -68,8 +63,6 @@ public class ApplyTemplateRequest { } /** - * Project key - * * Example value: "my_project" */ public ApplyTemplateRequest setProjectKey(String projectKey) { @@ -82,8 +75,6 @@ public class ApplyTemplateRequest { } /** - * Template id - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public ApplyTemplateRequest setTemplateId(String templateId) { @@ -96,8 +87,6 @@ public class ApplyTemplateRequest { } /** - * Template name - * * Example value: "Default Permission Template for Projects" */ public ApplyTemplateRequest setTemplateName(String templateName) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/BulkApplyTemplateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/BulkApplyTemplateRequest.java index 1cf0304ee2a..9b121987238 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/BulkApplyTemplateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/BulkApplyTemplateRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Apply a permission template to several projects.<br />The template id or name must be provided.<br />Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/bulk_apply_template">Further information about this action online (including a response example)</a> @@ -44,8 +42,6 @@ public class BulkApplyTemplateRequest { private String visibility; /** - * Filter the projects for which last analysis is older than the given date (exclusive).<br> Either a date (server timezone) or datetime can be provided. - * * Example value: "2017-10-19 or 2017-10-19T13:00:00+0200" */ public BulkApplyTemplateRequest setAnalyzedBefore(String analyzedBefore) { @@ -58,8 +54,6 @@ public class BulkApplyTemplateRequest { } /** - * Filter the projects that are provisioned - * * Possible values: * <ul> * <li>"true"</li> @@ -78,8 +72,6 @@ public class BulkApplyTemplateRequest { } /** - * Key of organization, used when group name is set - * * This is part of the internal API. * Example value: "my-org" */ @@ -93,8 +85,6 @@ public class BulkApplyTemplateRequest { } /** - * Comma-separated list of project keys - * * Example value: "my_project,another_project" */ public BulkApplyTemplateRequest setProjects(List<String> projects) { @@ -107,8 +97,6 @@ public class BulkApplyTemplateRequest { } /** - * Limit search to: <ul><li>project names that contain the supplied string</li><li>project keys that are exactly the same as the supplied string</li></ul> - * * Example value: "apac" */ public BulkApplyTemplateRequest setQ(String q) { @@ -121,8 +109,6 @@ public class BulkApplyTemplateRequest { } /** - * Comma-separated list of component qualifiers. Filter the results with the specified qualifiers. Possible values are:<ul><li>TRK - Projects</li></ul> - * * Possible values: * <ul> * <li>"TRK"</li> @@ -138,8 +124,6 @@ public class BulkApplyTemplateRequest { } /** - * Template id - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public BulkApplyTemplateRequest setTemplateId(String templateId) { @@ -152,8 +136,6 @@ public class BulkApplyTemplateRequest { } /** - * Template name - * * Example value: "Default Permission Template for Projects" */ public BulkApplyTemplateRequest setTemplateName(String templateName) { @@ -166,8 +148,6 @@ public class BulkApplyTemplateRequest { } /** - * Filter the projects that should be visible to everyone (public), or only specific user/groups (private).<br/>If no visibility is specified, the default project visibility of the organization will be used. - * * This is part of the internal API. * Possible values: * <ul> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/CreateTemplateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/CreateTemplateRequest.java index 10108165727..af9979bf329 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/CreateTemplateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/CreateTemplateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * Create a permission template.<br />Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/create_template">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class CreateTemplateRequest { private String projectKeyPattern; /** - * Description - * * Example value: "Permissions for all projects related to the financial service" */ public CreateTemplateRequest setDescription(String description) { @@ -52,8 +49,6 @@ public class CreateTemplateRequest { } /** - * Name - * * This is a mandatory parameter. * Example value: "Financial Service Permissions" */ @@ -67,8 +62,6 @@ public class CreateTemplateRequest { } /** - * Key of organization, used when group name is set - * * This is part of the internal API. * Example value: "my-org" */ @@ -82,8 +75,6 @@ public class CreateTemplateRequest { } /** - * Project key pattern. Must be a valid Java regular expression - * * Example value: ".*\\.finance\\..*" */ public CreateTemplateRequest setProjectKeyPattern(String projectKeyPattern) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/DeleteTemplateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/DeleteTemplateRequest.java index 376b80659a6..211f38e00cd 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/DeleteTemplateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/DeleteTemplateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * Delete a permission template.<br />Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/delete_template">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class DeleteTemplateRequest { private String templateName; /** - * Key of organization, used when group name is set - * * This is part of the internal API. * Example value: "my-org" */ @@ -52,8 +49,6 @@ public class DeleteTemplateRequest { } /** - * Template id - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public DeleteTemplateRequest setTemplateId(String templateId) { @@ -66,8 +61,6 @@ public class DeleteTemplateRequest { } /** - * Template name - * * Example value: "Default Permission Template for Projects" */ public DeleteTemplateRequest setTemplateName(String templateName) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/GroupsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/GroupsRequest.java index cce100871e6..0e89a09046f 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/GroupsRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/GroupsRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * Lists the groups with their permissions.<br>This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br> This service defaults to all groups, but can be limited to groups with a specific permission by providing the desired permission.<br>Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/groups">Further information about this action online (including a response example)</a> @@ -41,8 +40,6 @@ public class GroupsRequest { private String q; /** - * Key of organization, used when group name is set - * * This is part of the internal API. * Example value: "my-org" */ @@ -56,8 +53,6 @@ public class GroupsRequest { } /** - * 1-based page number - * * Example value: "42" */ public GroupsRequest setP(String p) { @@ -70,8 +65,6 @@ public class GroupsRequest { } /** - * Permission<ul><li>Possible values for global permissions: admin, profileadmin, gateadmin, scan, provisioning</li><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul> - * */ public GroupsRequest setPermission(String permission) { this.permission = permission; @@ -83,8 +76,6 @@ public class GroupsRequest { } /** - * Project id - * * Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d" */ public GroupsRequest setProjectId(String projectId) { @@ -97,8 +88,6 @@ public class GroupsRequest { } /** - * Project key - * * Example value: "my_project" */ public GroupsRequest setProjectKey(String projectKey) { @@ -111,8 +100,6 @@ public class GroupsRequest { } /** - * Page size. Must be greater than 0 and less than 100 - * * Example value: "20" */ public GroupsRequest setPs(String ps) { @@ -125,8 +112,6 @@ public class GroupsRequest { } /** - * Limit search to group names that contain the supplied string. When this parameter is not set, only groups having at least one permission are returned. - * * Example value: "sonar" */ public GroupsRequest setQ(String q) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/PermissionsService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/PermissionsService.java index f06f173c020..3b76f25fa36 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/PermissionsService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/PermissionsService.java @@ -36,7 +36,6 @@ import org.sonarqube.ws.Permissions.UpdateTemplateWsResponse; import org.sonarqube.ws.Permissions.UsersWsResponse; /** - * Manage permission templates, and the granting and revoking of permissions at the global and project levels. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -47,7 +46,6 @@ public class PermissionsService extends BaseService { } /** - * Add permission to a group.<br /> This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br /> The group name or group id must be provided. <br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul> * * This is part of the internal API. * This is a POST request. @@ -68,7 +66,6 @@ public class PermissionsService extends BaseService { } /** - * Add a group to a permission template.<br /> The group id or group name must be provided. <br />Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a POST request. @@ -89,7 +86,6 @@ public class PermissionsService extends BaseService { } /** - * Add a project creator to a permission template.<br>Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a POST request. @@ -108,7 +104,6 @@ public class PermissionsService extends BaseService { } /** - * Add permission to a user.<br /> This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul> * * This is part of the internal API. * This is a POST request. @@ -128,7 +123,6 @@ public class PermissionsService extends BaseService { } /** - * Add a user to a permission template.<br /> Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a POST request. @@ -148,7 +142,6 @@ public class PermissionsService extends BaseService { } /** - * Apply a permission template to one project.<br>The project id or project key must be provided.<br>The template id or name must be provided.<br>Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a POST request. @@ -168,7 +161,6 @@ public class PermissionsService extends BaseService { } /** - * Apply a permission template to several projects.<br />The template id or name must be provided.<br />Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a POST request. @@ -192,7 +184,6 @@ public class PermissionsService extends BaseService { } /** - * Create a permission template.<br />Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a POST request. @@ -210,7 +201,6 @@ public class PermissionsService extends BaseService { } /** - * Delete a permission template.<br />Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a POST request. @@ -228,7 +218,6 @@ public class PermissionsService extends BaseService { } /** - * Lists the groups with their permissions.<br>This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br> This service defaults to all groups, but can be limited to groups with a specific permission by providing the desired permission.<br>Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul> * * This is part of the internal API. * This is a GET request. @@ -249,7 +238,6 @@ public class PermissionsService extends BaseService { } /** - * Remove a permission from a group.<br /> This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br /> The group id or group name must be provided, not both.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul> * * This is part of the internal API. * This is a POST request. @@ -270,7 +258,6 @@ public class PermissionsService extends BaseService { } /** - * Remove a group from a permission template.<br /> The group id or group name must be provided. <br />Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a POST request. @@ -291,7 +278,6 @@ public class PermissionsService extends BaseService { } /** - * Remove a project creator from a permission template.<br>Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a POST request. @@ -310,7 +296,6 @@ public class PermissionsService extends BaseService { } /** - * Remove permission from a user.<br /> This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br /> Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul> * * This is part of the internal API. * This is a POST request. @@ -330,7 +315,6 @@ public class PermissionsService extends BaseService { } /** - * Remove a user from a permission template.<br /> Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a POST request. @@ -350,7 +334,6 @@ public class PermissionsService extends BaseService { } /** - * List global permissions. <br />Requires the following permission: 'Administer System' * * This is part of the internal API. * This is a GET request. @@ -367,7 +350,6 @@ public class PermissionsService extends BaseService { } /** - * List project permissions. A project can be a technical project, a view or a developer.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul> * * This is part of the internal API. * This is a GET request. @@ -389,7 +371,6 @@ public class PermissionsService extends BaseService { } /** - * List permission templates.<br />Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a GET request. @@ -405,7 +386,6 @@ public class PermissionsService extends BaseService { } /** - * Set a permission template as default.<br />Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a POST request. @@ -424,7 +404,6 @@ public class PermissionsService extends BaseService { } /** - * Lists the groups with their permission as individual groups rather than through user affiliation on the chosen template.<br />This service defaults to all groups, but can be limited to groups with a specific permission by providing the desired permission.<br>Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a GET request. @@ -445,7 +424,6 @@ public class PermissionsService extends BaseService { } /** - * Lists the users with their permission as individual users rather than through group affiliation on the chosen template. <br />This service defaults to all users, but can be limited to users with a specific permission by providing the desired permission.<br>Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a GET request. @@ -467,7 +445,6 @@ public class PermissionsService extends BaseService { } /** - * Update a permission template.<br />Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a POST request. @@ -485,7 +462,6 @@ public class PermissionsService extends BaseService { } /** - * Lists the users with their permissions as individual users rather than through group affiliation.<br>This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br> This service defaults to all users, but can be limited to users with a specific permission by providing the desired permission.<br>Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul> * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/RemoveGroupFromTemplateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/RemoveGroupFromTemplateRequest.java index 02ef3eb41a8..645eaef5dd8 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/RemoveGroupFromTemplateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/RemoveGroupFromTemplateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * Remove a group from a permission template.<br /> The group id or group name must be provided. <br />Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/remove_group_from_template">Further information about this action online (including a response example)</a> @@ -40,8 +39,6 @@ public class RemoveGroupFromTemplateRequest { private String templateName; /** - * Group id - * * Example value: "42" */ public RemoveGroupFromTemplateRequest setGroupId(String groupId) { @@ -54,8 +51,6 @@ public class RemoveGroupFromTemplateRequest { } /** - * Group name or 'anyone' (case insensitive) - * * Example value: "sonar-administrators" */ public RemoveGroupFromTemplateRequest setGroupName(String groupName) { @@ -68,8 +63,6 @@ public class RemoveGroupFromTemplateRequest { } /** - * Key of organization, used when group name is set - * * This is part of the internal API. * Example value: "my-org" */ @@ -83,8 +76,6 @@ public class RemoveGroupFromTemplateRequest { } /** - * Permission<ul><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul> - * * This is a mandatory parameter. * Possible values: * <ul> @@ -105,8 +96,6 @@ public class RemoveGroupFromTemplateRequest { } /** - * Template id - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public RemoveGroupFromTemplateRequest setTemplateId(String templateId) { @@ -119,8 +108,6 @@ public class RemoveGroupFromTemplateRequest { } /** - * Template name - * * Example value: "Default Permission Template for Projects" */ public RemoveGroupFromTemplateRequest setTemplateName(String templateName) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/RemoveGroupRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/RemoveGroupRequest.java index 0e2f25e2749..300361d5bdd 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/RemoveGroupRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/RemoveGroupRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * Remove a permission from a group.<br /> This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br /> The group id or group name must be provided, not both.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/remove_group">Further information about this action online (including a response example)</a> @@ -40,8 +39,6 @@ public class RemoveGroupRequest { private String projectKey; /** - * Group id - * * Example value: "42" */ public RemoveGroupRequest setGroupId(String groupId) { @@ -54,8 +51,6 @@ public class RemoveGroupRequest { } /** - * Group name or 'anyone' (case insensitive) - * * Example value: "sonar-administrators" */ public RemoveGroupRequest setGroupName(String groupName) { @@ -68,8 +63,6 @@ public class RemoveGroupRequest { } /** - * Key of organization, used when group name is set - * * This is part of the internal API. * Example value: "my-org" */ @@ -83,8 +76,6 @@ public class RemoveGroupRequest { } /** - * Permission<ul><li>Possible values for global permissions: admin, profileadmin, gateadmin, scan, provisioning</li><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul> - * * This is a mandatory parameter. */ public RemoveGroupRequest setPermission(String permission) { @@ -97,8 +88,6 @@ public class RemoveGroupRequest { } /** - * Project id - * * Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d" */ public RemoveGroupRequest setProjectId(String projectId) { @@ -111,8 +100,6 @@ public class RemoveGroupRequest { } /** - * Project key - * * Example value: "my_project" */ public RemoveGroupRequest setProjectKey(String projectKey) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/RemoveProjectCreatorFromTemplateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/RemoveProjectCreatorFromTemplateRequest.java index 04a389bb762..ef031591550 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/RemoveProjectCreatorFromTemplateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/RemoveProjectCreatorFromTemplateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * Remove a project creator from a permission template.<br>Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/remove_project_creator_from_template">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class RemoveProjectCreatorFromTemplateRequest { private String templateName; /** - * Key of organization, used when group name is set - * * This is part of the internal API. * Example value: "my-org" */ @@ -53,8 +50,6 @@ public class RemoveProjectCreatorFromTemplateRequest { } /** - * Permission<ul><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul> - * * This is a mandatory parameter. * Possible values: * <ul> @@ -75,8 +70,6 @@ public class RemoveProjectCreatorFromTemplateRequest { } /** - * Template id - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public RemoveProjectCreatorFromTemplateRequest setTemplateId(String templateId) { @@ -89,8 +82,6 @@ public class RemoveProjectCreatorFromTemplateRequest { } /** - * Template name - * * Example value: "Default Permission Template for Projects" */ public RemoveProjectCreatorFromTemplateRequest setTemplateName(String templateName) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/RemoveUserFromTemplateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/RemoveUserFromTemplateRequest.java index 3fb6752d2b7..c682d7b6b0d 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/RemoveUserFromTemplateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/RemoveUserFromTemplateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * Remove a user from a permission template.<br /> Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/remove_user_from_template">Further information about this action online (including a response example)</a> @@ -39,8 +38,6 @@ public class RemoveUserFromTemplateRequest { private String templateName; /** - * User login - * * This is a mandatory parameter. * Example value: "g.hopper" */ @@ -54,8 +51,6 @@ public class RemoveUserFromTemplateRequest { } /** - * Key of organization, used when group name is set - * * This is part of the internal API. * Example value: "my-org" */ @@ -69,8 +64,6 @@ public class RemoveUserFromTemplateRequest { } /** - * Permission<ul><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul> - * * This is a mandatory parameter. * Possible values: * <ul> @@ -91,8 +84,6 @@ public class RemoveUserFromTemplateRequest { } /** - * Template id - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public RemoveUserFromTemplateRequest setTemplateId(String templateId) { @@ -105,8 +96,6 @@ public class RemoveUserFromTemplateRequest { } /** - * Template name - * * Example value: "Default Permission Template for Projects" */ public RemoveUserFromTemplateRequest setTemplateName(String templateName) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/RemoveUserRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/RemoveUserRequest.java index 3f96820b415..fc53906645c 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/RemoveUserRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/RemoveUserRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * Remove permission from a user.<br /> This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br /> Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/remove_user">Further information about this action online (including a response example)</a> @@ -39,8 +38,6 @@ public class RemoveUserRequest { private String projectKey; /** - * User login - * * This is a mandatory parameter. * Example value: "g.hopper" */ @@ -54,8 +51,6 @@ public class RemoveUserRequest { } /** - * Key of organization, used when group name is set - * * This is part of the internal API. * Example value: "my-org" */ @@ -69,8 +64,6 @@ public class RemoveUserRequest { } /** - * Permission<ul><li>Possible values for global permissions: admin, profileadmin, gateadmin, scan, provisioning</li><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul> - * * This is a mandatory parameter. */ public RemoveUserRequest setPermission(String permission) { @@ -83,8 +76,6 @@ public class RemoveUserRequest { } /** - * Project id - * * Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d" */ public RemoveUserRequest setProjectId(String projectId) { @@ -97,8 +88,6 @@ public class RemoveUserRequest { } /** - * Project key - * * Example value: "my_project" */ public RemoveUserRequest setProjectKey(String projectKey) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/SearchGlobalPermissionsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/SearchGlobalPermissionsRequest.java index 8c80f3ee37f..98b15c6984e 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/SearchGlobalPermissionsRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/SearchGlobalPermissionsRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * List global permissions. <br />Requires the following permission: 'Administer System' - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/search_global_permissions">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class SearchGlobalPermissionsRequest { private String organization; /** - * Key of organization, used when group name is set - * * This is part of the internal API. * Example value: "my-org" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/SearchProjectPermissionsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/SearchProjectPermissionsRequest.java index a7c8a41f8ba..1fe3cb701a5 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/SearchProjectPermissionsRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/SearchProjectPermissionsRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * List project permissions. A project can be a technical project, a view or a developer.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/search_project_permissions">Further information about this action online (including a response example)</a> @@ -40,8 +39,6 @@ public class SearchProjectPermissionsRequest { private String qualifier; /** - * 1-based page number - * * Example value: "42" */ public SearchProjectPermissionsRequest setP(String p) { @@ -54,8 +51,6 @@ public class SearchProjectPermissionsRequest { } /** - * Project id - * * Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d" */ public SearchProjectPermissionsRequest setProjectId(String projectId) { @@ -68,8 +63,6 @@ public class SearchProjectPermissionsRequest { } /** - * Project key - * * Example value: "my_project" */ public SearchProjectPermissionsRequest setProjectKey(String projectKey) { @@ -82,8 +75,6 @@ public class SearchProjectPermissionsRequest { } /** - * Page size. Must be greater than 0. - * * Example value: "20" */ public SearchProjectPermissionsRequest setPs(String ps) { @@ -96,8 +87,6 @@ public class SearchProjectPermissionsRequest { } /** - * Limit search to: <ul><li>project names that contain the supplied string</li><li>project keys that are exactly the same as the supplied string</li></ul> - * * Example value: "apac" */ public SearchProjectPermissionsRequest setQ(String q) { @@ -110,8 +99,6 @@ public class SearchProjectPermissionsRequest { } /** - * Project qualifier. Filter the results with the specified qualifier. Possible values are:<ul><li>TRK - Projects</li></ul> - * * Possible values: * <ul> * <li>"TRK"</li> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/SearchTemplatesRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/SearchTemplatesRequest.java index b6516a869ff..7527d34508a 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/SearchTemplatesRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/SearchTemplatesRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * List permission templates.<br />Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/search_templates">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class SearchTemplatesRequest { private String q; /** - * Key of organization, used when group name is set - * * This is part of the internal API. * Example value: "my-org" */ @@ -51,8 +48,6 @@ public class SearchTemplatesRequest { } /** - * Limit search to permission template names that contain the supplied string. - * * Example value: "defau" */ public SearchTemplatesRequest setQ(String q) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/SetDefaultTemplateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/SetDefaultTemplateRequest.java index c20a6379972..51aa56db96d 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/SetDefaultTemplateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/SetDefaultTemplateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * Set a permission template as default.<br />Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/set_default_template">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class SetDefaultTemplateRequest { private String templateName; /** - * Key of organization, used when group name is set - * * This is part of the internal API. * Example value: "my-org" */ @@ -53,8 +50,6 @@ public class SetDefaultTemplateRequest { } /** - * Project qualifier. Filter the results with the specified qualifier. Possible values are:<ul><li>TRK - Projects</li></ul> - * * Possible values: * <ul> * <li>"TRK"</li> @@ -70,8 +65,6 @@ public class SetDefaultTemplateRequest { } /** - * Template id - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public SetDefaultTemplateRequest setTemplateId(String templateId) { @@ -84,8 +77,6 @@ public class SetDefaultTemplateRequest { } /** - * Template name - * * Example value: "Default Permission Template for Projects" */ public SetDefaultTemplateRequest setTemplateName(String templateName) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/TemplateGroupsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/TemplateGroupsRequest.java index f487c178803..73b5dd30e43 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/TemplateGroupsRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/TemplateGroupsRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * Lists the groups with their permission as individual groups rather than through user affiliation on the chosen template.<br />This service defaults to all groups, but can be limited to groups with a specific permission by providing the desired permission.<br>Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/template_groups">Further information about this action online (including a response example)</a> @@ -41,8 +40,6 @@ public class TemplateGroupsRequest { private String templateName; /** - * Key of organization, used when group name is set - * * This is part of the internal API. * Example value: "my-org" */ @@ -56,8 +53,6 @@ public class TemplateGroupsRequest { } /** - * 1-based page number - * * Example value: "42" */ public TemplateGroupsRequest setP(String p) { @@ -70,8 +65,6 @@ public class TemplateGroupsRequest { } /** - * Permission<ul><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul> - * * This is a mandatory parameter. * Possible values: * <ul> @@ -92,8 +85,6 @@ public class TemplateGroupsRequest { } /** - * Page size. Must be greater than 0 and less than 100 - * * Example value: "20" */ public TemplateGroupsRequest setPs(String ps) { @@ -106,8 +97,6 @@ public class TemplateGroupsRequest { } /** - * Limit search to group names that contain the supplied string. <br/>When this parameter is not set, only group having at least one permission are returned. - * * Example value: "eri" */ public TemplateGroupsRequest setQ(String q) { @@ -120,8 +109,6 @@ public class TemplateGroupsRequest { } /** - * Template id - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public TemplateGroupsRequest setTemplateId(String templateId) { @@ -134,8 +121,6 @@ public class TemplateGroupsRequest { } /** - * Template name - * * Example value: "Default Permission Template for Projects" */ public TemplateGroupsRequest setTemplateName(String templateName) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/TemplateUsersRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/TemplateUsersRequest.java index 06b4f0dc829..ebccf117be3 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/TemplateUsersRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/TemplateUsersRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * Lists the users with their permission as individual users rather than through group affiliation on the chosen template. <br />This service defaults to all users, but can be limited to users with a specific permission by providing the desired permission.<br>Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/template_users">Further information about this action online (including a response example)</a> @@ -41,8 +40,6 @@ public class TemplateUsersRequest { private String templateName; /** - * Key of organization, used when group name is set - * * This is part of the internal API. * Example value: "my-org" */ @@ -56,8 +53,6 @@ public class TemplateUsersRequest { } /** - * 1-based page number - * * Example value: "42" */ public TemplateUsersRequest setP(String p) { @@ -70,8 +65,6 @@ public class TemplateUsersRequest { } /** - * Permission<ul><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul> - * * Possible values: * <ul> * <li>"admin"</li> @@ -91,8 +84,6 @@ public class TemplateUsersRequest { } /** - * Page size. Must be greater than 0 and less than 100 - * * Example value: "20" */ public TemplateUsersRequest setPs(String ps) { @@ -105,8 +96,6 @@ public class TemplateUsersRequest { } /** - * Limit search to user names that contain the supplied string. <br/>When this parameter is not set, only users having at least one permission are returned. - * * Example value: "eri" */ public TemplateUsersRequest setQ(String q) { @@ -119,8 +108,6 @@ public class TemplateUsersRequest { } /** - * Template id - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public TemplateUsersRequest setTemplateId(String templateId) { @@ -133,8 +120,6 @@ public class TemplateUsersRequest { } /** - * Template name - * * Example value: "Default Permission Template for Projects" */ public TemplateUsersRequest setTemplateName(String templateName) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/UpdateTemplateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/UpdateTemplateRequest.java index c24840900e8..dd1477f8112 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/UpdateTemplateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/UpdateTemplateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * Update a permission template.<br />Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/update_template">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class UpdateTemplateRequest { private String projectKeyPattern; /** - * Description - * * Example value: "Permissions for all projects related to the financial service" */ public UpdateTemplateRequest setDescription(String description) { @@ -52,8 +49,6 @@ public class UpdateTemplateRequest { } /** - * Id - * * This is a mandatory parameter. * Example value: "af8cb8cc-1e78-4c4e-8c00-ee8e814009a5" */ @@ -67,8 +62,6 @@ public class UpdateTemplateRequest { } /** - * Name - * * Example value: "Financial Service Permissions" */ public UpdateTemplateRequest setName(String name) { @@ -81,8 +74,6 @@ public class UpdateTemplateRequest { } /** - * Project key pattern. Must be a valid Java regular expression - * * Example value: ".*\\.finance\\..*" */ public UpdateTemplateRequest setProjectKeyPattern(String projectKeyPattern) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/UsersRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/UsersRequest.java index 5b3e6486c64..788279cc1a2 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/UsersRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/UsersRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.permissions; +import java.util.List; import javax.annotation.Generated; /** - * Lists the users with their permissions as individual users rather than through group affiliation.<br>This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.<br> This service defaults to all users, but can be limited to users with a specific permission by providing the desired permission.<br>Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/permissions/users">Further information about this action online (including a response example)</a> @@ -41,8 +40,6 @@ public class UsersRequest { private String q; /** - * Key of organization, used when group name is set - * * This is part of the internal API. * Example value: "my-org" */ @@ -56,8 +53,6 @@ public class UsersRequest { } /** - * 1-based page number - * * Example value: "42" */ public UsersRequest setP(String p) { @@ -70,8 +65,6 @@ public class UsersRequest { } /** - * Permission<ul><li>Possible values for global permissions: admin, profileadmin, gateadmin, scan, provisioning</li><li>Possible values for project permissions admin, codeviewer, issueadmin, scan, user</li></ul> - * */ public UsersRequest setPermission(String permission) { this.permission = permission; @@ -83,8 +76,6 @@ public class UsersRequest { } /** - * Project id - * * Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d" */ public UsersRequest setProjectId(String projectId) { @@ -97,8 +88,6 @@ public class UsersRequest { } /** - * Project key - * * Example value: "my_project" */ public UsersRequest setProjectKey(String projectKey) { @@ -111,8 +100,6 @@ public class UsersRequest { } /** - * Page size. Must be greater than 0 and less than 100 - * * Example value: "20" */ public UsersRequest setPs(String ps) { @@ -125,8 +112,6 @@ public class UsersRequest { } /** - * Limit search to user names that contain the supplied string. <br/>When this parameter is not set, only users having at least one permission are returned. - * * Example value: "eri" */ public UsersRequest setQ(String q) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/package-info.java index c2d92162d1f..52121f2b11f 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/permissions/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.permissions; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/InstallRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/InstallRequest.java index 7071deb6fdd..6cd8dfd1412 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/InstallRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/InstallRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.plugins; +import java.util.List; import javax.annotation.Generated; /** - * Installs the latest version of a plugin specified by its key.<br/>Plugin information is retrieved from Update Center.<br/>Requires user to be authenticated with Administer System permissions - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/plugins/install">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class InstallRequest { private String key; /** - * The key identifying the plugin to install - * * This is a mandatory parameter. */ public InstallRequest setKey(String key) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/InstalledRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/InstalledRequest.java index 0e488b7912a..5c7c0c6b08e 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/InstalledRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/InstalledRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Get the list of all the plugins installed on the SonarQube instance, sorted by plugin name. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/plugins/installed">Further information about this action online (including a response example)</a> @@ -36,8 +34,6 @@ public class InstalledRequest { private List<String> f; /** - * Comma-separated list of the additional fields to be returned in response. No additional field is returned by default. Possible values are:<ul><li>category - category as defined in the Update Center. A connection to the Update Center is needed</li></lu> - * * Possible values: * <ul> * <li>"category"</li> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/PluginsService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/PluginsService.java index f69d312f2dd..0ec4279aed0 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/PluginsService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/PluginsService.java @@ -28,7 +28,6 @@ import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; /** - * Manage the plugins on the server, including installing, uninstalling, and upgrading. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/plugins">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -39,7 +38,6 @@ public class PluginsService extends BaseService { } /** - * Get the list of all the plugins available for installation on the SonarQube instance, sorted by plugin name.<br/>Plugin information is retrieved from Update Center. Date and time at which Update Center was last refreshed is provided in the response.<br/>Update status values are: <ul><li>COMPATIBLE: plugin is compatible with current SonarQube instance.</li><li>INCOMPATIBLE: plugin is not compatible with current SonarQube instance.</li><li>REQUIRES_SYSTEM_UPGRADE: plugin requires SonarQube to be upgraded before being installed.</li><li>DEPS_REQUIRE_SYSTEM_UPGRADE: at least one plugin on which the plugin is dependent requires SonarQube to be upgraded.</li></ul>Require 'Administer System' permission. * * This is part of the internal API. * This is a GET request. @@ -54,7 +52,6 @@ public class PluginsService extends BaseService { } /** - * Cancels any operation pending on any plugin (install, update or uninstall)<br/>Requires user to be authenticated with Administer System permissions * * This is part of the internal API. * This is a POST request. @@ -69,7 +66,6 @@ public class PluginsService extends BaseService { } /** - * Installs the latest version of a plugin specified by its key.<br/>Plugin information is retrieved from Update Center.<br/>Requires user to be authenticated with Administer System permissions * * This is part of the internal API. * This is a POST request. @@ -85,7 +81,6 @@ public class PluginsService extends BaseService { } /** - * Get the list of all the plugins installed on the SonarQube instance, sorted by plugin name. * * This is part of the internal API. * This is a GET request. @@ -101,7 +96,6 @@ public class PluginsService extends BaseService { } /** - * Get the list of plugins which will either be installed or removed at the next startup of the SonarQube instance, sorted by plugin name.<br/>Require 'Administer System' permission. * * This is part of the internal API. * This is a GET request. @@ -116,7 +110,6 @@ public class PluginsService extends BaseService { } /** - * Uninstalls the plugin specified by its key.<br/>Requires user to be authenticated with Administer System permissions. * * This is part of the internal API. * This is a POST request. @@ -132,7 +125,6 @@ public class PluginsService extends BaseService { } /** - * Updates a plugin specified by its key to the latest version compatible with the SonarQube instance.<br/>Plugin information is retrieved from Update Center.<br/>Requires user to be authenticated with Administer System permissions * * This is part of the internal API. * This is a POST request. @@ -148,7 +140,6 @@ public class PluginsService extends BaseService { } /** - * Lists plugins installed on the SonarQube instance for which at least one newer version is available, sorted by plugin name.<br/>Each newer version is listed, ordered from the oldest to the newest, with its own update/compatibility status.<br/>Plugin information is retrieved from Update Center. Date and time at which Update Center was last refreshed is provided in the response.<br/>Update status values are: [COMPATIBLE, INCOMPATIBLE, REQUIRES_UPGRADE, DEPS_REQUIRE_UPGRADE].<br/>Require 'Administer System' permission. * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/UninstallRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/UninstallRequest.java index 0d2c1a5a947..0266a10b3da 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/UninstallRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/UninstallRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.plugins; +import java.util.List; import javax.annotation.Generated; /** - * Uninstalls the plugin specified by its key.<br/>Requires user to be authenticated with Administer System permissions. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/plugins/uninstall">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class UninstallRequest { private String key; /** - * The key identifying the plugin to uninstall - * * This is a mandatory parameter. */ public UninstallRequest setKey(String key) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/UpdateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/UpdateRequest.java index d79280307b3..50546b3595a 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/UpdateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/UpdateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.plugins; +import java.util.List; import javax.annotation.Generated; /** - * Updates a plugin specified by its key to the latest version compatible with the SonarQube instance.<br/>Plugin information is retrieved from Update Center.<br/>Requires user to be authenticated with Administer System permissions - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/plugins/update">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class UpdateRequest { private String key; /** - * The key identifying the plugin to update - * * This is a mandatory parameter. */ public UpdateRequest setKey(String key) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/package-info.java index d5fcdab6ddf..30f5a86fc48 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/plugins/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.plugins; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/profiles/ProfilesService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/profiles/ProfilesService.java index 9fba324adc2..1ae517b8914 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/profiles/ProfilesService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/profiles/ProfilesService.java @@ -28,7 +28,6 @@ import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; /** - * Removed since 6.3, please use api/qualityprofiles instead * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/profiles">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -39,7 +38,6 @@ public class ProfilesService extends BaseService { } /** - * Get a profile.<br/>The web service is removed and you're invited to use api/qualityprofiles/search instead * * This is part of the internal API. * This is a GET request. @@ -56,7 +54,6 @@ public class ProfilesService extends BaseService { } /** - * Get a list of profiles.<br/>The web service is removed and you're invited to use api/qualityprofiles/search instead * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/profiles/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/profiles/package-info.java index 1d4569b89bc..54d5b4addcf 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/profiles/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/profiles/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.profiles; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/CreateEventRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/CreateEventRequest.java index 2067c95641f..281bbb9587d 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/CreateEventRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/CreateEventRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.projectanalyses; +import java.util.List; import javax.annotation.Generated; /** - * Create a project analysis event.<br>Only event of category 'VERSION' and 'OTHER' can be created.<br>Requires one of the following permissions:<ul> <li>'Administer System'</li> <li>'Administer' rights on the specified project</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_analyses/create_event">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class CreateEventRequest { private String name; /** - * Analysis key - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy" */ @@ -52,8 +49,6 @@ public class CreateEventRequest { } /** - * Category - * * Possible values: * <ul> * <li>"VERSION"</li> @@ -70,8 +65,6 @@ public class CreateEventRequest { } /** - * Name - * * This is a mandatory parameter. * Example value: "5.6" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/DeleteEventRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/DeleteEventRequest.java index 26e730c9a2c..a76d01757ce 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/DeleteEventRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/DeleteEventRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.projectanalyses; +import java.util.List; import javax.annotation.Generated; /** - * Delete a project analysis event.<br>Only event of category 'VERSION' and 'OTHER' can be deleted.<br>Requires one of the following permissions:<ul> <li>'Administer System'</li> <li>'Administer' rights on the specified project</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_analyses/delete_event">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class DeleteEventRequest { private String event; /** - * Event key - * * This is a mandatory parameter. * Example value: "AU-TpxcA-iU5OvuD2FLz" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/DeleteRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/DeleteRequest.java index 952c2075bf6..dfb86017ded 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/DeleteRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/DeleteRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.projectanalyses; +import java.util.List; import javax.annotation.Generated; /** - * Delete a project analysis.<br>Requires one of the following permissions:<ul> <li>'Administer System'</li> <li>'Administer' rights on the project of the specified analysis</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_analyses/delete">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class DeleteRequest { private String analysis; /** - * Analysis key - * * This is a mandatory parameter. * Example value: "AU-TpxcA-iU5OvuD2FL1" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/ProjectAnalysesService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/ProjectAnalysesService.java index 2e3718dde49..a7e5442a6ab 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/ProjectAnalysesService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/ProjectAnalysesService.java @@ -19,6 +19,7 @@ */ package org.sonarqube.ws.client.projectanalyses; +import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; @@ -30,7 +31,6 @@ import org.sonarqube.ws.ProjectAnalyses.SearchResponse; import org.sonarqube.ws.ProjectAnalyses.UpdateEventResponse; /** - * Manage project analyses. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_analyses">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -41,7 +41,6 @@ public class ProjectAnalysesService extends BaseService { } /** - * Create a project analysis event.<br>Only event of category 'VERSION' and 'OTHER' can be created.<br>Requires one of the following permissions:<ul> <li>'Administer System'</li> <li>'Administer' rights on the specified project</li></ul> * * This is part of the internal API. * This is a POST request. @@ -58,7 +57,6 @@ public class ProjectAnalysesService extends BaseService { } /** - * Delete a project analysis.<br>Requires one of the following permissions:<ul> <li>'Administer System'</li> <li>'Administer' rights on the project of the specified analysis</li></ul> * * This is part of the internal API. * This is a POST request. @@ -74,7 +72,6 @@ public class ProjectAnalysesService extends BaseService { } /** - * Delete a project analysis event.<br>Only event of category 'VERSION' and 'OTHER' can be deleted.<br>Requires one of the following permissions:<ul> <li>'Administer System'</li> <li>'Administer' rights on the specified project</li></ul> * * This is part of the internal API. * This is a POST request. @@ -90,7 +87,6 @@ public class ProjectAnalysesService extends BaseService { } /** - * Search a project analyses and attached events.<br>Requires the following permission: 'Browse' on the specified project * * This is part of the internal API. * This is a GET request. @@ -111,7 +107,6 @@ public class ProjectAnalysesService extends BaseService { } /** - * Update a project analysis event.<br>Only events of category 'VERSION' and 'OTHER' can be updated.<br>Requires one of the following permissions:<ul> <li>'Administer System'</li> <li>'Administer' rights on the specified project</li></ul> * * This is part of the internal API. * This is a POST request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/SearchRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/SearchRequest.java index 5f44cc4dfe9..148fd568443 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/SearchRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/SearchRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.projectanalyses; +import java.util.List; import javax.annotation.Generated; /** - * Search a project analyses and attached events.<br>Requires the following permission: 'Browse' on the specified project - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_analyses/search">Further information about this action online (including a response example)</a> @@ -41,8 +40,6 @@ public class SearchRequest { private String to; /** - * Branch key - * * This is part of the internal API. * Example value: "feature/my_branch" */ @@ -56,8 +53,6 @@ public class SearchRequest { } /** - * Event category. Filter analyses that have at least one event of the category specified. - * * Example value: "OTHER" * Possible values: * <ul> @@ -77,8 +72,6 @@ public class SearchRequest { } /** - * Filter analyses created after the given date (inclusive). <br>Either a date (server timezone) or datetime can be provided - * * Example value: "2013-05-01" */ public SearchRequest setFrom(String from) { @@ -91,8 +84,6 @@ public class SearchRequest { } /** - * 1-based page number - * * Example value: "42" */ public SearchRequest setP(String p) { @@ -105,8 +96,6 @@ public class SearchRequest { } /** - * Project key - * * This is a mandatory parameter. * Example value: "my_project" */ @@ -120,8 +109,6 @@ public class SearchRequest { } /** - * Page size. Must be greater than 0 and less than 500 - * * Example value: "20" */ public SearchRequest setPs(String ps) { @@ -134,8 +121,6 @@ public class SearchRequest { } /** - * Filter analyses created before the given date (inclusive). <br>Either a date (server timezone) or datetime can be provided - * * Example value: "2017-10-19 or 2017-10-19T13:00:00+0200" */ public SearchRequest setTo(String to) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/UpdateEventRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/UpdateEventRequest.java index 52107933793..57a3e6109e7 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/UpdateEventRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/UpdateEventRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.projectanalyses; +import java.util.List; import javax.annotation.Generated; /** - * Update a project analysis event.<br>Only events of category 'VERSION' and 'OTHER' can be updated.<br>Requires one of the following permissions:<ul> <li>'Administer System'</li> <li>'Administer' rights on the specified project</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_analyses/update_event">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class UpdateEventRequest { private String name; /** - * Event key - * * This is a mandatory parameter. * Example value: "AU-TpxcA-iU5OvuD2FL5" */ @@ -51,8 +48,6 @@ public class UpdateEventRequest { } /** - * New name - * * Example value: "5.6" */ public UpdateEventRequest setName(String name) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/package-info.java index 81b12f75d62..e8be86aa232 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectanalyses/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.projectanalyses; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectbranches/DeleteRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectbranches/DeleteRequest.java index 6a11d73ecc4..683adab7bae 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectbranches/DeleteRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectbranches/DeleteRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.projectbranches; +import java.util.List; import javax.annotation.Generated; /** - * Delete a non-main branch of a project.<br/>Requires 'Administer' rights on the specified project. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_branches/delete">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class DeleteRequest { private String project; /** - * Name of the branch - * * This is a mandatory parameter. * Example value: "branch1" */ @@ -51,8 +48,6 @@ public class DeleteRequest { } /** - * Project key - * * This is a mandatory parameter. * Example value: "my_project" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectbranches/ListRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectbranches/ListRequest.java index d090fe3541a..63c8295b864 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectbranches/ListRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectbranches/ListRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.projectbranches; +import java.util.List; import javax.annotation.Generated; /** - * List the branches of a project.<br/>Requires 'Administer' rights on the specified project. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_branches/list">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class ListRequest { private String project; /** - * Project key - * * This is a mandatory parameter. * Example value: "my_project" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectbranches/ProjectBranchesService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectbranches/ProjectBranchesService.java index 65d7ba82530..8bfdb965952 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectbranches/ProjectBranchesService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectbranches/ProjectBranchesService.java @@ -19,6 +19,7 @@ */ package org.sonarqube.ws.client.projectbranches; +import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; @@ -28,7 +29,6 @@ import org.sonarqube.ws.client.WsConnector; import org.sonarqube.ws.ProjectBranches.ListWsResponse; /** - * Manage branch (only available when the Branch plugin is installed) * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_branches">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -39,7 +39,6 @@ public class ProjectBranchesService extends BaseService { } /** - * Delete a non-main branch of a project.<br/>Requires 'Administer' rights on the specified project. * * This is part of the internal API. * This is a POST request. @@ -56,7 +55,6 @@ public class ProjectBranchesService extends BaseService { } /** - * List the branches of a project.<br/>Requires 'Administer' rights on the specified project. * * This is part of the internal API. * This is a GET request. @@ -71,7 +69,6 @@ public class ProjectBranchesService extends BaseService { } /** - * Rename the main branch of a project.<br/>Requires 'Administer' permission on the specified project. * * This is part of the internal API. * This is a POST request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectbranches/RenameRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectbranches/RenameRequest.java index 5fcae6747cf..2cf792f50b3 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectbranches/RenameRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectbranches/RenameRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.projectbranches; +import java.util.List; import javax.annotation.Generated; /** - * Rename the main branch of a project.<br/>Requires 'Administer' permission on the specified project. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_branches/rename">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class RenameRequest { private String project; /** - * New name of the main branch - * * This is a mandatory parameter. * Example value: "branch1" */ @@ -51,8 +48,6 @@ public class RenameRequest { } /** - * Project key - * * This is a mandatory parameter. * Example value: "my_project" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectbranches/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectbranches/package-info.java index 148ff98162a..de3e3147dad 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectbranches/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectbranches/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.projectbranches; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectlinks/CreateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectlinks/CreateRequest.java index a1eb6b33e60..d99f708985c 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectlinks/CreateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectlinks/CreateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.projectlinks; +import java.util.List; import javax.annotation.Generated; /** - * Create a new project link.<br>Requires 'Administer' permission on the specified project, or global 'Administer' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_links/create">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class CreateRequest { private String url; /** - * Link name - * * This is a mandatory parameter. * Example value: "Custom" */ @@ -53,8 +50,6 @@ public class CreateRequest { } /** - * Project id - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public CreateRequest setProjectId(String projectId) { @@ -67,8 +62,6 @@ public class CreateRequest { } /** - * Project key - * * Example value: "my_project" */ public CreateRequest setProjectKey(String projectKey) { @@ -81,8 +74,6 @@ public class CreateRequest { } /** - * Link url - * * This is a mandatory parameter. * Example value: "http://example.com" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectlinks/DeleteRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectlinks/DeleteRequest.java index 84d04b7ad92..fcccffe9fb8 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectlinks/DeleteRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectlinks/DeleteRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.projectlinks; +import java.util.List; import javax.annotation.Generated; /** - * Delete existing project link.<br>Requires 'Administer' permission on the specified project, or global 'Administer' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_links/delete">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class DeleteRequest { private String id; /** - * Link id - * * This is a mandatory parameter. * Example value: "17" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectlinks/ProjectLinksService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectlinks/ProjectLinksService.java index bfb20b9ab1a..8c6e496a5f7 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectlinks/ProjectLinksService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectlinks/ProjectLinksService.java @@ -19,6 +19,7 @@ */ package org.sonarqube.ws.client.projectlinks; +import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; @@ -29,7 +30,6 @@ import org.sonarqube.ws.ProjectLinks.CreateWsResponse; import org.sonarqube.ws.ProjectLinks.SearchWsResponse; /** - * Manage projects links. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_links">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -40,7 +40,6 @@ public class ProjectLinksService extends BaseService { } /** - * Create a new project link.<br>Requires 'Administer' permission on the specified project, or global 'Administer' permission. * * This is part of the internal API. * This is a POST request. @@ -58,7 +57,6 @@ public class ProjectLinksService extends BaseService { } /** - * Delete existing project link.<br>Requires 'Administer' permission on the specified project, or global 'Administer' permission. * * This is part of the internal API. * This is a POST request. @@ -74,7 +72,6 @@ public class ProjectLinksService extends BaseService { } /** - * List links of a project.<br>The 'projectId' or 'projectKey' must be provided.<br>Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li><li>'Browse' on the specified project</li></ul> * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectlinks/SearchRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectlinks/SearchRequest.java index f86f84a91f7..a8471418fc8 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectlinks/SearchRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectlinks/SearchRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.projectlinks; +import java.util.List; import javax.annotation.Generated; /** - * List links of a project.<br>The 'projectId' or 'projectKey' must be provided.<br>Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li><li>'Browse' on the specified project</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_links/search">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class SearchRequest { private String projectKey; /** - * Project Id - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public SearchRequest setProjectId(String projectId) { @@ -50,8 +47,6 @@ public class SearchRequest { } /** - * Project Key - * * Example value: "my_project" */ public SearchRequest setProjectKey(String projectKey) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectlinks/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectlinks/package-info.java index 01d51ffb385..59365fc25ff 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projectlinks/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projectlinks/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.projectlinks; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/BulkDeleteRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/BulkDeleteRequest.java index cdd0d7e73a2..58263943100 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/BulkDeleteRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/BulkDeleteRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Delete one or several projects.<br />Requires 'Administer System' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/bulk_delete">Further information about this action online (including a response example)</a> @@ -43,8 +41,6 @@ public class BulkDeleteRequest { private String visibility; /** - * Filter the projects for which last analysis is older than the given date (exclusive).<br> Either a date (server timezone) or datetime can be provided. - * * Example value: "2017-10-19 or 2017-10-19T13:00:00+0200" */ public BulkDeleteRequest setAnalyzedBefore(String analyzedBefore) { @@ -57,8 +53,6 @@ public class BulkDeleteRequest { } /** - * Filter the projects that are provisioned - * * Possible values: * <ul> * <li>"true"</li> @@ -77,8 +71,6 @@ public class BulkDeleteRequest { } /** - * The key of the organization - * * This is part of the internal API. */ public BulkDeleteRequest setOrganization(String organization) { @@ -91,8 +83,6 @@ public class BulkDeleteRequest { } /** - * Comma-separated list of project ids - * * Example value: "AU-Tpxb--iU5OvuD2FLy,AU-TpxcA-iU5OvuD2FLz" * @deprecated since 6.4 */ @@ -107,8 +97,6 @@ public class BulkDeleteRequest { } /** - * Comma-separated list of project keys - * * Example value: "my_project,another_project" */ public BulkDeleteRequest setProjects(List<String> projects) { @@ -121,8 +109,6 @@ public class BulkDeleteRequest { } /** - * Limit to: <ul><li>component names that contain the supplied string</li><li>component keys that contain the supplied string</li></ul> - * * Example value: "sonar" */ public BulkDeleteRequest setQ(String q) { @@ -135,8 +121,6 @@ public class BulkDeleteRequest { } /** - * Comma-separated list of component qualifiers. Filter the results with the specified qualifiers - * * Possible values: * <ul> * <li>"TRK"</li> @@ -154,8 +138,6 @@ public class BulkDeleteRequest { } /** - * Filter the projects that should be visible to everyone (public), or only specific user/groups (private).<br/>If no visibility is specified, the default project visibility of the organization will be used. - * * This is part of the internal API. * Possible values: * <ul> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/BulkUpdateKeyRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/BulkUpdateKeyRequest.java index a8c6cab5645..de79970110b 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/BulkUpdateKeyRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/BulkUpdateKeyRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.projects; +import java.util.List; import javax.annotation.Generated; /** - * Bulk update a project or module key and all its sub-components keys. The bulk update allows to replace a part of the current key by another string on the current project and all its sub-modules.<br>It's possible to simulate the bulk update by setting the parameter 'dryRun' at true. No key is updated with a dry run.<br>Ex: to rename a project with key 'my_project' to 'my_new_project' and all its sub-components keys, call the WS with parameters:<ul> <li>project: my_project</li> <li>from: my_</li> <li>to: my_new_</li></ul>Either 'projectId' or 'project' must be provided.<br> Requires one of the following permissions: <ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/bulk_update_key">Further information about this action online (including a response example)</a> @@ -39,8 +38,6 @@ public class BulkUpdateKeyRequest { private String to; /** - * Simulate bulk update. No component key is updated. - * * Possible values: * <ul> * <li>"true"</li> @@ -59,8 +56,6 @@ public class BulkUpdateKeyRequest { } /** - * String to match in components keys - * * This is a mandatory parameter. * Example value: "_old" */ @@ -74,8 +69,6 @@ public class BulkUpdateKeyRequest { } /** - * Project or module key - * * Example value: "my_old_project" */ public BulkUpdateKeyRequest setProject(String project) { @@ -88,8 +81,6 @@ public class BulkUpdateKeyRequest { } /** - * Project or module ID - * * Example value: "AU-Tpxb--iU5OvuD2FLy" * @deprecated since 6.4 */ @@ -104,8 +95,6 @@ public class BulkUpdateKeyRequest { } /** - * String replacement in components keys - * * This is a mandatory parameter. * Example value: "_new" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/CreateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/CreateRequest.java index 6ba628ab9cd..70d8fee8065 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/CreateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/CreateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.projects; +import java.util.List; import javax.annotation.Generated; /** - * Create a project.<br/>Requires 'Create Projects' permission - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/create">Further information about this action online (including a response example)</a> @@ -39,8 +38,6 @@ public class CreateRequest { private String visibility; /** - * SCM Branch of the project. The key of the project will become key:branch, for instance 'SonarQube:branch-5.0' - * * Example value: "branch-5.0" */ public CreateRequest setBranch(String branch) { @@ -53,8 +50,6 @@ public class CreateRequest { } /** - * Name of the project - * * This is a mandatory parameter. * Example value: "SonarQube" */ @@ -68,8 +63,6 @@ public class CreateRequest { } /** - * The key of the organization - * * This is part of the internal API. */ public CreateRequest setOrganization(String organization) { @@ -82,8 +75,6 @@ public class CreateRequest { } /** - * Key of the project - * * This is a mandatory parameter. * Example value: "my_project" */ @@ -97,8 +88,6 @@ public class CreateRequest { } /** - * Whether the created project should be visible to everyone, or only specific user/groups.<br/>If no visibility is specified, the default project visibility of the organization will be used. - * * This is part of the internal API. * Possible values: * <ul> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/DeleteRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/DeleteRequest.java index b2472b60179..8241dd2cfe5 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/DeleteRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/DeleteRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.projects; +import java.util.List; import javax.annotation.Generated; /** - * Delete a project.<br> Requires 'Administer System' permission or 'Administer' permission on the project. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/delete">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class DeleteRequest { private String projectId; /** - * Project key - * * Example value: "my_project" */ public DeleteRequest setProject(String project) { @@ -50,8 +47,6 @@ public class DeleteRequest { } /** - * Project ID - * * Example value: "ce4c03d6-430f-40a9-b777-ad877c00aa4d" * @deprecated since 6.4 */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/GhostsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/GhostsRequest.java index 44c54ea6c10..b54e1be3bc9 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/GhostsRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/GhostsRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * List ghost projects.<br> With the current architecture, it's no more possible to have invisible ghost projects. Therefore, the web service is deprecated.<br> Requires 'Administer System' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/ghosts">Further information about this action online (including a response example)</a> @@ -40,8 +38,6 @@ public class GhostsRequest { private String q; /** - * Comma-separated list of the fields to be returned in response. All the fields are returned by default. - * * Possible values: * <ul> * <li>"name"</li> @@ -61,8 +57,6 @@ public class GhostsRequest { } /** - * Organization key - * * This is part of the internal API. */ public GhostsRequest setOrganization(String organization) { @@ -75,8 +69,6 @@ public class GhostsRequest { } /** - * 1-based page number - * * Example value: "42" */ public GhostsRequest setP(String p) { @@ -89,8 +81,6 @@ public class GhostsRequest { } /** - * Page size. Must be greater than 0 and less than 500 - * * Example value: "20" */ public GhostsRequest setPs(String ps) { @@ -103,8 +93,6 @@ public class GhostsRequest { } /** - * Limit search to names or keys that contain the supplied string. - * * Example value: "sonar" */ public GhostsRequest setQ(String q) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/IndexRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/IndexRequest.java index 29d0bf49324..1d2600facb7 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/IndexRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/IndexRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.projects; +import java.util.List; import javax.annotation.Generated; /** - * This web service is deprecated, please use api/components/search instead - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/index">Further information about this action online (including a response example)</a> @@ -42,8 +41,6 @@ public class IndexRequest { private String views; /** - * Since 6.3, this parameter has no effect - * * @deprecated since 6.3 */ @Deprecated @@ -57,8 +54,6 @@ public class IndexRequest { } /** - * Only json response format is available - * * Possible values: * <ul> * <li>"json"</li> @@ -74,8 +69,6 @@ public class IndexRequest { } /** - * Since 6.3, this parameter has no effect - * * @deprecated since 6.3 */ @Deprecated @@ -89,8 +82,6 @@ public class IndexRequest { } /** - * key or ID of the project - * * Example value: "my_project" */ public IndexRequest setProject(String project) { @@ -103,8 +94,6 @@ public class IndexRequest { } /** - * Substring of project name, case insensitive. Ignored if the parameter key is set - * * Example value: "Sonar" */ public IndexRequest setSearch(String search) { @@ -117,8 +106,6 @@ public class IndexRequest { } /** - * Load sub-projects. Ignored if the parameter key is set - * * Possible values: * <ul> * <li>"true"</li> @@ -137,8 +124,6 @@ public class IndexRequest { } /** - * Since 6.3, this parameter has no effect - * * @deprecated since 6.3 */ @Deprecated @@ -152,8 +137,6 @@ public class IndexRequest { } /** - * Since 6.3, this parameter has no effect - * * @deprecated since 6.3 */ @Deprecated diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/ProjectsService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/ProjectsService.java index 5eb04423714..83430858c67 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/ProjectsService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/ProjectsService.java @@ -32,7 +32,6 @@ import org.sonarqube.ws.Projects.SearchWsResponse; import org.sonarqube.ws.Projects.SearchMyProjectsWsResponse; /** - * Manage project existence. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -43,7 +42,6 @@ public class ProjectsService extends BaseService { } /** - * Delete one or several projects.<br />Requires 'Administer System' permission. * * This is part of the internal API. * This is a POST request. @@ -66,7 +64,6 @@ public class ProjectsService extends BaseService { } /** - * Bulk update a project or module key and all its sub-components keys. The bulk update allows to replace a part of the current key by another string on the current project and all its sub-modules.<br>It's possible to simulate the bulk update by setting the parameter 'dryRun' at true. No key is updated with a dry run.<br>Ex: to rename a project with key 'my_project' to 'my_new_project' and all its sub-components keys, call the WS with parameters:<ul> <li>project: my_project</li> <li>from: my_</li> <li>to: my_new_</li></ul>Either 'projectId' or 'project' must be provided.<br> Requires one of the following permissions: <ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul> * * This is part of the internal API. * This is a POST request. @@ -85,7 +82,6 @@ public class ProjectsService extends BaseService { } /** - * Create a project.<br/>Requires 'Create Projects' permission * * This is part of the internal API. * This is a POST request. @@ -104,7 +100,6 @@ public class ProjectsService extends BaseService { } /** - * Delete a project.<br> Requires 'Administer System' permission or 'Administer' permission on the project. * * This is part of the internal API. * This is a POST request. @@ -121,7 +116,6 @@ public class ProjectsService extends BaseService { } /** - * List ghost projects.<br> With the current architecture, it's no more possible to have invisible ghost projects. Therefore, the web service is deprecated.<br> Requires 'Administer System' permission. * * This is part of the internal API. * This is a GET request. @@ -143,7 +137,6 @@ public class ProjectsService extends BaseService { } /** - * This web service is deprecated, please use api/components/search instead * * This is part of the internal API. * This is a GET request. @@ -168,7 +161,6 @@ public class ProjectsService extends BaseService { } /** - * Get the list of provisioned projects.<br> Web service is deprecated. Use api/projects/search instead, with onProvisionedOnly=true.<br> Require 'Create Projects' permission. * * This is part of the internal API. * This is a GET request. @@ -190,7 +182,6 @@ public class ProjectsService extends BaseService { } /** - * Search for projects or views to administrate them.<br>Requires 'System Administrator' permission * * This is part of the internal API. * This is a GET request. @@ -214,7 +205,6 @@ public class ProjectsService extends BaseService { } /** - * Return list of projects for which the current user has 'Administer' permission. * * This is part of the internal API. * This is a GET request. @@ -230,7 +220,6 @@ public class ProjectsService extends BaseService { } /** - * Update a project or module key and all its sub-components keys.<br>Either 'from' or 'projectId' must be provided.<br> Requires one of the following permissions: <ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul> * * This is part of the internal API. * This is a POST request. @@ -248,7 +237,6 @@ public class ProjectsService extends BaseService { } /** - * Updates visibility of a project.<br>Requires 'Project administer' permission on the specified project * * This is part of the internal API. * This is a POST request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/ProvisionedRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/ProvisionedRequest.java index 39c2d8a254a..a9e4415fb7e 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/ProvisionedRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/ProvisionedRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Get the list of provisioned projects.<br> Web service is deprecated. Use api/projects/search instead, with onProvisionedOnly=true.<br> Require 'Create Projects' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/provisioned">Further information about this action online (including a response example)</a> @@ -40,8 +38,6 @@ public class ProvisionedRequest { private String q; /** - * Comma-separated list of the fields to be returned in response. All the fields are returned by default. - * * Possible values: * <ul> * <li>"name"</li> @@ -61,8 +57,6 @@ public class ProvisionedRequest { } /** - * The key of the organization - * * This is part of the internal API. */ public ProvisionedRequest setOrganization(String organization) { @@ -75,8 +69,6 @@ public class ProvisionedRequest { } /** - * 1-based page number - * * Example value: "42" */ public ProvisionedRequest setP(String p) { @@ -89,8 +81,6 @@ public class ProvisionedRequest { } /** - * Page size. Must be greater than 0 and less than 500 - * * Example value: "20" */ public ProvisionedRequest setPs(String ps) { @@ -103,8 +93,6 @@ public class ProvisionedRequest { } /** - * Limit search to names or keys that contain the supplied string. - * * Example value: "sonar" */ public ProvisionedRequest setQ(String q) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/SearchMyProjectsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/SearchMyProjectsRequest.java index 708b8ad6ab9..05ecc2805bc 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/SearchMyProjectsRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/SearchMyProjectsRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.projects; +import java.util.List; import javax.annotation.Generated; /** - * Return list of projects for which the current user has 'Administer' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/search_my_projects">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class SearchMyProjectsRequest { private String ps; /** - * 1-based page number - * * Example value: "42" */ public SearchMyProjectsRequest setP(String p) { @@ -50,8 +47,6 @@ public class SearchMyProjectsRequest { } /** - * Page size. Must be greater than 0 and less than 500 - * * Example value: "20" */ public SearchMyProjectsRequest setPs(String ps) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/SearchRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/SearchRequest.java index 9aee0c0c236..e1517065dc7 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/SearchRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/SearchRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Search for projects or views to administrate them.<br>Requires 'System Administrator' permission - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/search">Further information about this action online (including a response example)</a> @@ -45,8 +43,6 @@ public class SearchRequest { private String visibility; /** - * Filter the projects for which last analysis is older than the given date (exclusive).<br> Either a date (server timezone) or datetime can be provided. - * * Example value: "2017-10-19 or 2017-10-19T13:00:00+0200" */ public SearchRequest setAnalyzedBefore(String analyzedBefore) { @@ -59,8 +55,6 @@ public class SearchRequest { } /** - * Filter the projects that are provisioned - * * Possible values: * <ul> * <li>"true"</li> @@ -79,8 +73,6 @@ public class SearchRequest { } /** - * The key of the organization - * * This is part of the internal API. */ public SearchRequest setOrganization(String organization) { @@ -93,8 +85,6 @@ public class SearchRequest { } /** - * 1-based page number - * * Example value: "42" */ public SearchRequest setP(String p) { @@ -107,8 +97,6 @@ public class SearchRequest { } /** - * Comma-separated list of project ids - * * Example value: "AU-Tpxb--iU5OvuD2FLy,AU-TpxcA-iU5OvuD2FLz" * @deprecated since 6.6 */ @@ -123,8 +111,6 @@ public class SearchRequest { } /** - * Comma-separated list of project keys - * * Example value: "my_project,another_project" */ public SearchRequest setProjects(List<String> projects) { @@ -137,8 +123,6 @@ public class SearchRequest { } /** - * Page size. Must be greater than 0 and less than 500 - * * Example value: "20" */ public SearchRequest setPs(String ps) { @@ -151,8 +135,6 @@ public class SearchRequest { } /** - * Limit search to: <ul><li>component names that contain the supplied string</li><li>component keys that contain the supplied string</li></ul> - * * Example value: "sonar" */ public SearchRequest setQ(String q) { @@ -165,8 +147,6 @@ public class SearchRequest { } /** - * Comma-separated list of component qualifiers. Filter the results with the specified qualifiers - * * Possible values: * <ul> * <li>"TRK"</li> @@ -184,8 +164,6 @@ public class SearchRequest { } /** - * Filter the projects that should be visible to everyone (public), or only specific user/groups (private).<br/>If no visibility is specified, the default project visibility of the organization will be used. - * * This is part of the internal API. * Possible values: * <ul> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/UpdateKeyRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/UpdateKeyRequest.java index a32f9a91ec4..1c59e56d828 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/UpdateKeyRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/UpdateKeyRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.projects; +import java.util.List; import javax.annotation.Generated; /** - * Update a project or module key and all its sub-components keys.<br>Either 'from' or 'projectId' must be provided.<br> Requires one of the following permissions: <ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/update_key">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class UpdateKeyRequest { private String to; /** - * Project or module key - * * Example value: "my_old_project" */ public UpdateKeyRequest setFrom(String from) { @@ -51,8 +48,6 @@ public class UpdateKeyRequest { } /** - * Project or module id - * * Example value: "AU-Tpxb--iU5OvuD2FLy" * @deprecated since 6.4 */ @@ -67,8 +62,6 @@ public class UpdateKeyRequest { } /** - * New component key - * * This is a mandatory parameter. * Example value: "my_new_project" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/UpdateVisibilityRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/UpdateVisibilityRequest.java index fa1a0284878..778fa1b7669 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/UpdateVisibilityRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/UpdateVisibilityRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.projects; +import java.util.List; import javax.annotation.Generated; /** - * Updates visibility of a project.<br>Requires 'Project administer' permission on the specified project - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/projects/update_visibility">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class UpdateVisibilityRequest { private String visibility; /** - * Project key - * * This is a mandatory parameter. * Example value: "my_project" */ @@ -51,8 +48,6 @@ public class UpdateVisibilityRequest { } /** - * New visibility - * * This is a mandatory parameter. * Possible values: * <ul> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/package-info.java index 0e38452b189..a4d4032cad9 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projects/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.projects; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projecttags/ProjectTagsService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projecttags/ProjectTagsService.java index 006352b6428..f22bb736b1a 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projecttags/ProjectTagsService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projecttags/ProjectTagsService.java @@ -29,7 +29,6 @@ import org.sonarqube.ws.client.WsConnector; import org.sonarqube.ws.ProjectTags.SearchResponse; /** - * Manage project tags * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_tags">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -40,7 +39,6 @@ public class ProjectTagsService extends BaseService { } /** - * Search tags * * This is part of the internal API. * This is a GET request. @@ -56,7 +54,6 @@ public class ProjectTagsService extends BaseService { } /** - * Set tags on a project.<br>Requires the following permission: 'Administer' rights on the specified project * * This is part of the internal API. * This is a POST request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projecttags/SearchRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projecttags/SearchRequest.java index 1a28e65dca6..c0ad511a544 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projecttags/SearchRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projecttags/SearchRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.projecttags; +import java.util.List; import javax.annotation.Generated; /** - * Search tags - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_tags/search">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class SearchRequest { private String q; /** - * Page size. Must be greater than 0 and less than 100 - * * Example value: "20" */ public SearchRequest setPs(String ps) { @@ -50,8 +47,6 @@ public class SearchRequest { } /** - * Limit search to tags that contain the supplied string. - * * Example value: "off" */ public SearchRequest setQ(String q) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projecttags/SetRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projecttags/SetRequest.java index 75cc51d6acd..36cd1c3370f 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projecttags/SetRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projecttags/SetRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Set tags on a project.<br>Requires the following permission: 'Administer' rights on the specified project - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/project_tags/set">Further information about this action online (including a response example)</a> @@ -37,8 +35,6 @@ public class SetRequest { private List<String> tags; /** - * Project key - * * This is a mandatory parameter. * Example value: "my_project" */ @@ -52,8 +48,6 @@ public class SetRequest { } /** - * Comma-separated list of tags - * * This is a mandatory parameter. * Example value: "finance, offshore" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/projecttags/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/projecttags/package-info.java index f2bb28b5447..d175cc01e3e 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/projecttags/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/projecttags/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.projecttags; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/properties/IndexRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/properties/IndexRequest.java index 5293ed0be82..edb29c8ddbe 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/properties/IndexRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/properties/IndexRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.properties; +import java.util.List; import javax.annotation.Generated; /** - * This web service is deprecated, please use api/settings/values instead. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/properties/index">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class IndexRequest { private String resource; /** - * Only json response format is available - * * Possible values: * <ul> * <li>"json"</li> @@ -54,8 +51,6 @@ public class IndexRequest { } /** - * Setting key - * * Example value: "sonar.test.inclusions" */ public IndexRequest setId(String id) { @@ -68,8 +63,6 @@ public class IndexRequest { } /** - * Component key or database id - * * Example value: "my_project" */ public IndexRequest setResource(String resource) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/properties/PropertiesService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/properties/PropertiesService.java index 081c709bfed..d2a0a9275cb 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/properties/PropertiesService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/properties/PropertiesService.java @@ -19,14 +19,15 @@ */ package org.sonarqube.ws.client.properties; +import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; import org.sonarqube.ws.client.GetRequest; +import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; /** - * This web service is deprecated, please use api/settings instead. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/properties">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -37,7 +38,6 @@ public class PropertiesService extends BaseService { } /** - * This web service is deprecated, please use api/settings/values instead. * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/properties/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/properties/package-info.java index 9c38b2f7e4c..852e3e4cfb7 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/properties/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/properties/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.properties; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/CopyRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/CopyRequest.java index a3e3b0b3bc1..f995619b0ec 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/CopyRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/CopyRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualitygates; +import java.util.List; import javax.annotation.Generated; /** - * Copy a Quality Gate.<br>Requires the 'Administer Quality Gates' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/copy">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class CopyRequest { private String name; /** - * The ID of the source quality gate - * * This is a mandatory parameter. * Example value: "1" */ @@ -51,8 +48,6 @@ public class CopyRequest { } /** - * The name of the quality gate to create - * * This is a mandatory parameter. * Example value: "My Quality Gate" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/CreateConditionRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/CreateConditionRequest.java index 89b2854e628..f0bd0551e53 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/CreateConditionRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/CreateConditionRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualitygates; +import java.util.List; import javax.annotation.Generated; /** - * Add a new condition to a quality gate.<br>Requires the 'Administer Quality Gates' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/create_condition">Further information about this action online (including a response example)</a> @@ -40,8 +39,6 @@ public class CreateConditionRequest { private String warning; /** - * Condition error threshold - * * Example value: "10" */ public CreateConditionRequest setError(String error) { @@ -54,8 +51,6 @@ public class CreateConditionRequest { } /** - * ID of the quality gate - * * This is a mandatory parameter. * Example value: "1" */ @@ -69,8 +64,6 @@ public class CreateConditionRequest { } /** - * Condition metric - * * This is a mandatory parameter. * Example value: "blocker_violations" */ @@ -84,8 +77,6 @@ public class CreateConditionRequest { } /** - * Condition operator:<br/><ul><li>EQ = equals</li><li>NE = is not</li><li>LT = is lower than</li><li>GT = is greater than</li></ui> - * * Example value: "EQ" * Possible values: * <ul> @@ -105,8 +96,6 @@ public class CreateConditionRequest { } /** - * Condition period. If not set, the absolute value is considered. - * * Possible values: * <ul> * <li>"1"</li> @@ -122,8 +111,6 @@ public class CreateConditionRequest { } /** - * Condition warning threshold - * * Example value: "5" */ public CreateConditionRequest setWarning(String warning) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/CreateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/CreateRequest.java index f289e50136f..86938326d7c 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/CreateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/CreateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualitygates; +import java.util.List; import javax.annotation.Generated; /** - * Create a Quality Gate.<br>Requires the 'Administer Quality Gates' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/create">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class CreateRequest { private String name; /** - * The name of the quality gate to create - * * This is a mandatory parameter. * Example value: "My Quality Gate" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/DeleteConditionRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/DeleteConditionRequest.java index 83acf9f781e..209b77d4cc6 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/DeleteConditionRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/DeleteConditionRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualitygates; +import java.util.List; import javax.annotation.Generated; /** - * Delete a condition from a quality gate.<br>Requires the 'Administer Quality Gates' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/delete_condition">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class DeleteConditionRequest { private String id; /** - * Condition ID - * * This is a mandatory parameter. * Example value: "2" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/DeselectRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/DeselectRequest.java index d73cbc2cb26..a1565475457 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/DeselectRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/DeselectRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualitygates; +import java.util.List; import javax.annotation.Generated; /** - * Remove the association of a project from a quality gate.<br>Requires the 'Administer Quality Gates' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/deselect">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class DeselectRequest { private String projectKey; /** - * Project id - * * Example value: "AU-Tpxb--iU5OvuD2FLy" * @deprecated since 6.1 */ @@ -52,8 +49,6 @@ public class DeselectRequest { } /** - * Project key - * * Example value: "my_project" */ public DeselectRequest setProjectKey(String projectKey) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/DestroyRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/DestroyRequest.java index e3307cbffc4..9a2280e692c 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/DestroyRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/DestroyRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualitygates; +import java.util.List; import javax.annotation.Generated; /** - * Delete a Quality Gate.<br>Requires the 'Administer Quality Gates' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/destroy">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class DestroyRequest { private String id; /** - * ID of the quality gate to delete - * * This is a mandatory parameter. * Example value: "1" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/GetByProjectRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/GetByProjectRequest.java index cc370d7a13e..868d867fead 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/GetByProjectRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/GetByProjectRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualitygates; +import java.util.List; import javax.annotation.Generated; /** - * Get the quality gate of a project.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li><li>'Browse' on the specified project</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/get_by_project">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class GetByProjectRequest { private String project; /** - * Project key - * * This is a mandatory parameter. * Example value: "my_project" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/ProjectStatusRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/ProjectStatusRequest.java index f37e3215cc2..9152bdae30d 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/ProjectStatusRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/ProjectStatusRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualitygates; +import java.util.List; import javax.annotation.Generated; /** - * Get the quality gate status of a project or a Compute Engine task.<br />Either 'analysisId', 'projectId' or 'projectKey' must be provided<br />The different statuses returned are: OK, WARN, ERROR, NONE. The NONE status is returned when there is no quality gate associated with the analysis.<br />Returns an HTTP code 404 if the analysis associated with the task is not found or does not exist.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li><li>'Browse' on the specified project</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/project_status">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class ProjectStatusRequest { private String projectKey; /** - * Analysis id - * * Example value: "AU-TpxcA-iU5OvuD2FL1" */ public ProjectStatusRequest setAnalysisId(String analysisId) { @@ -51,8 +48,6 @@ public class ProjectStatusRequest { } /** - * Project id - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public ProjectStatusRequest setProjectId(String projectId) { @@ -65,8 +60,6 @@ public class ProjectStatusRequest { } /** - * Project key - * * Example value: "my_project" */ public ProjectStatusRequest setProjectKey(String projectKey) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/QualitygatesService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/QualitygatesService.java index 87627760a1b..e33ccfd16ac 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/QualitygatesService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/QualitygatesService.java @@ -19,22 +19,21 @@ */ package org.sonarqube.ws.client.qualitygates; +import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; -import org.sonarqube.ws.Qualitygates; +import org.sonarqube.ws.client.BaseService; +import org.sonarqube.ws.client.GetRequest; +import org.sonarqube.ws.client.PostRequest; +import org.sonarqube.ws.client.WsConnector; import org.sonarqube.ws.Qualitygates.AppResponse; -import org.sonarqube.ws.Qualitygates.CreateConditionResponse; import org.sonarqube.ws.Qualitygates.CreateResponse; +import org.sonarqube.ws.Qualitygates.CreateConditionResponse; import org.sonarqube.ws.Qualitygates.GetByProjectResponse; import org.sonarqube.ws.Qualitygates.ProjectStatusResponse; import org.sonarqube.ws.Qualitygates.UpdateConditionResponse; -import org.sonarqube.ws.client.BaseService; -import org.sonarqube.ws.client.GetRequest; -import org.sonarqube.ws.client.PostRequest; -import org.sonarqube.ws.client.WsConnector; /** - * Manage quality gates, including conditions and project association. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -45,7 +44,6 @@ public class QualitygatesService extends BaseService { } /** - * Get initialization items for the admin UI. For internal use * * This is part of the internal API. * This is a GET request. @@ -59,7 +57,6 @@ public class QualitygatesService extends BaseService { } /** - * Copy a Quality Gate.<br>Requires the 'Administer Quality Gates' permission. * * This is part of the internal API. * This is a POST request. @@ -76,14 +73,13 @@ public class QualitygatesService extends BaseService { } /** - * Create a Quality Gate.<br>Requires the 'Administer Quality Gates' permission. * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/create">Further information about this action online (including a response example)</a> * @since 4.3 */ - public Qualitygates.CreateResponse create(CreateRequest request) { + public CreateResponse create(CreateRequest request) { return call( new PostRequest(path("create")) .setParam("name", request.getName()), @@ -91,7 +87,6 @@ public class QualitygatesService extends BaseService { } /** - * Add a new condition to a quality gate.<br>Requires the 'Administer Quality Gates' permission. * * This is part of the internal API. * This is a POST request. @@ -111,7 +106,6 @@ public class QualitygatesService extends BaseService { } /** - * Delete a condition from a quality gate.<br>Requires the 'Administer Quality Gates' permission. * * This is part of the internal API. * This is a POST request. @@ -127,7 +121,6 @@ public class QualitygatesService extends BaseService { } /** - * Remove the association of a project from a quality gate.<br>Requires the 'Administer Quality Gates' permission. * * This is part of the internal API. * This is a POST request. @@ -144,7 +137,6 @@ public class QualitygatesService extends BaseService { } /** - * Delete a Quality Gate.<br>Requires the 'Administer Quality Gates' permission. * * This is part of the internal API. * This is a POST request. @@ -160,7 +152,6 @@ public class QualitygatesService extends BaseService { } /** - * Get the quality gate of a project.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li><li>'Browse' on the specified project</li></ul> * * This is part of the internal API. * This is a GET request. @@ -175,7 +166,6 @@ public class QualitygatesService extends BaseService { } /** - * Get a list of quality gates * * This is part of the internal API. * This is a GET request. @@ -190,7 +180,6 @@ public class QualitygatesService extends BaseService { } /** - * Get the quality gate status of a project or a Compute Engine task.<br />Either 'analysisId', 'projectId' or 'projectKey' must be provided<br />The different statuses returned are: OK, WARN, ERROR, NONE. The NONE status is returned when there is no quality gate associated with the analysis.<br />Returns an HTTP code 404 if the analysis associated with the task is not found or does not exist.<br />Requires one of the following permissions:<ul><li>'Administer System'</li><li>'Administer' rights on the specified project</li><li>'Browse' on the specified project</li></ul> * * This is part of the internal API. * This is a GET request. @@ -207,7 +196,6 @@ public class QualitygatesService extends BaseService { } /** - * Rename a Quality Gate.<br>Requires the 'Administer Quality Gates' permission. * * This is part of the internal API. * This is a POST request. @@ -224,7 +212,6 @@ public class QualitygatesService extends BaseService { } /** - * Search for projects associated (or not) to a quality gate.<br/>Only authorized projects for current user will be returned. * * This is part of the internal API. * This is a GET request. @@ -244,7 +231,6 @@ public class QualitygatesService extends BaseService { } /** - * Associate a project to a quality gate.<br>The 'projectId' or 'projectKey' must be provided.<br>Project id as a numeric value is deprecated since 6.1. Please use the id similar to 'AU-TpxcA-iU5OvuD2FLz'.<br>Requires the 'Administer Quality Gates' permission. * * This is part of the internal API. * This is a POST request. @@ -262,7 +248,6 @@ public class QualitygatesService extends BaseService { } /** - * Set a quality gate as the default quality gate.<br>Requires the 'Administer Quality Gates' permission. * * This is part of the internal API. * This is a POST request. @@ -278,7 +263,6 @@ public class QualitygatesService extends BaseService { } /** - * Display the details of a quality gate * * This is part of the internal API. * This is a GET request. @@ -295,7 +279,6 @@ public class QualitygatesService extends BaseService { } /** - * Unset a quality gate as the default quality gate.<br>Requires the 'Administer Quality Gates' permission. * * This is part of the internal API. * This is a POST request. @@ -311,7 +294,6 @@ public class QualitygatesService extends BaseService { } /** - * Update a condition attached to a quality gate.<br>Requires the 'Administer Quality Gates' permission. * * This is part of the internal API. * This is a POST request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/RenameRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/RenameRequest.java index 5893c1f8019..ae2edfa43b1 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/RenameRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/RenameRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualitygates; +import java.util.List; import javax.annotation.Generated; /** - * Rename a Quality Gate.<br>Requires the 'Administer Quality Gates' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/rename">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class RenameRequest { private String name; /** - * ID of the quality gate to rename - * * This is a mandatory parameter. * Example value: "1" */ @@ -51,8 +48,6 @@ public class RenameRequest { } /** - * New name of the quality gate - * * This is a mandatory parameter. * Example value: "My Quality Gate" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/SearchRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/SearchRequest.java index 1ffb4086282..5506b0423d5 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/SearchRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/SearchRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualitygates; +import java.util.List; import javax.annotation.Generated; /** - * Search for projects associated (or not) to a quality gate.<br/>Only authorized projects for current user will be returned. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/search">Further information about this action online (including a response example)</a> @@ -39,8 +38,6 @@ public class SearchRequest { private String selected; /** - * Quality Gate ID - * * This is a mandatory parameter. * Example value: "1" */ @@ -54,8 +51,6 @@ public class SearchRequest { } /** - * Page number - * * Example value: "2" */ public SearchRequest setPage(String page) { @@ -68,8 +63,6 @@ public class SearchRequest { } /** - * Page size - * * Example value: "10" */ public SearchRequest setPageSize(String pageSize) { @@ -82,8 +75,6 @@ public class SearchRequest { } /** - * To search for projects containing this string. If this parameter is set, "selected" is set to "all". - * * Example value: "abc" */ public SearchRequest setQuery(String query) { @@ -96,8 +87,6 @@ public class SearchRequest { } /** - * Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), or all items with their selection status (selected=all). - * * Possible values: * <ul> * <li>"all"</li> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/SelectRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/SelectRequest.java index 0e8e0ab770d..d83215d0eb4 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/SelectRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/SelectRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualitygates; +import java.util.List; import javax.annotation.Generated; /** - * Associate a project to a quality gate.<br>The 'projectId' or 'projectKey' must be provided.<br>Project id as a numeric value is deprecated since 6.1. Please use the id similar to 'AU-TpxcA-iU5OvuD2FLz'.<br>Requires the 'Administer Quality Gates' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/select">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class SelectRequest { private String projectKey; /** - * Quality gate id - * * This is a mandatory parameter. * Example value: "1" */ @@ -52,8 +49,6 @@ public class SelectRequest { } /** - * Project id. Project id as an numeric value is deprecated since 6.1 - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public SelectRequest setProjectId(String projectId) { @@ -66,8 +61,6 @@ public class SelectRequest { } /** - * Project key - * * Example value: "my_project" */ public SelectRequest setProjectKey(String projectKey) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/SetAsDefaultRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/SetAsDefaultRequest.java index 0029fa4d1c0..15cd79e71e9 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/SetAsDefaultRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/SetAsDefaultRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualitygates; +import java.util.List; import javax.annotation.Generated; /** - * Set a quality gate as the default quality gate.<br>Requires the 'Administer Quality Gates' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/set_as_default">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class SetAsDefaultRequest { private String id; /** - * ID of the quality gate to set as default - * * This is a mandatory parameter. * Example value: "1" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/ShowRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/ShowRequest.java index 340a18173c0..02902bd5617 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/ShowRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/ShowRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualitygates; +import java.util.List; import javax.annotation.Generated; /** - * Display the details of a quality gate - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/show">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class ShowRequest { private String name; /** - * ID of the quality gate. Either id or name must be set - * * Example value: "1" */ public ShowRequest setId(String id) { @@ -50,8 +47,6 @@ public class ShowRequest { } /** - * Name of the quality gate. Either id or name must be set - * * Example value: "My Quality Gate" */ public ShowRequest setName(String name) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/UnsetDefaultRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/UnsetDefaultRequest.java index 71dfd1d6c8a..7dd58bc88b7 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/UnsetDefaultRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/UnsetDefaultRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualitygates; +import java.util.List; import javax.annotation.Generated; /** - * Unset a quality gate as the default quality gate.<br>Requires the 'Administer Quality Gates' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/unset_default">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class UnsetDefaultRequest { private String id; /** - * ID of the quality gate to unset as default - * * This is a mandatory parameter. * Example value: "1" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/UpdateConditionRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/UpdateConditionRequest.java index 1245b100344..2291826d004 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/UpdateConditionRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/UpdateConditionRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualitygates; +import java.util.List; import javax.annotation.Generated; /** - * Update a condition attached to a quality gate.<br>Requires the 'Administer Quality Gates' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualitygates/update_condition">Further information about this action online (including a response example)</a> @@ -40,8 +39,6 @@ public class UpdateConditionRequest { private String warning; /** - * Condition error threshold - * * Example value: "10" */ public UpdateConditionRequest setError(String error) { @@ -54,8 +51,6 @@ public class UpdateConditionRequest { } /** - * Condition ID - * * This is a mandatory parameter. * Example value: "10" */ @@ -69,8 +64,6 @@ public class UpdateConditionRequest { } /** - * Condition metric - * * This is a mandatory parameter. * Example value: "blocker_violations" */ @@ -84,8 +77,6 @@ public class UpdateConditionRequest { } /** - * Condition operator:<br/><ul><li>EQ = equals</li><li>NE = is not</li><li>LT = is lower than</li><li>GT = is greater than</li></ui> - * * Example value: "EQ" * Possible values: * <ul> @@ -105,8 +96,6 @@ public class UpdateConditionRequest { } /** - * Condition period. If not set, the absolute value is considered. - * * Possible values: * <ul> * <li>"1"</li> @@ -122,8 +111,6 @@ public class UpdateConditionRequest { } /** - * Condition warning threshold - * * Example value: "5" */ public UpdateConditionRequest setWarning(String warning) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/package-info.java index 130a03c1334..c9befe98210 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualitygates/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.qualitygates; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ActivateRuleRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ActivateRuleRequest.java index b69c226b404..6d7898f7496 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ActivateRuleRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ActivateRuleRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Activate a rule on a Quality Profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/activate_rule">Further information about this action online (including a response example)</a> @@ -33,14 +32,12 @@ import javax.annotation.Generated; public class ActivateRuleRequest { private String key; - private String params; + private List<String> params; private String reset; private String rule; private String severity; /** - * Quality Profile key. Can be obtained through <code>api/qualityprofiles/search</code> - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy" */ @@ -54,22 +51,18 @@ public class ActivateRuleRequest { } /** - * Parameters as semi-colon list of <code>key=value</code>. Ignored if parameter reset is true. - * * Example value: "params=key1=v1;key2=v2" */ - public ActivateRuleRequest setParams(String params) { + public ActivateRuleRequest setParams(List<String> params) { this.params = params; return this; } - public String getParams() { + public List<String> getParams() { return params; } /** - * Reset severity and parameters of activated rule. Set the values defined on parent profile or from rule default values. - * * Possible values: * <ul> * <li>"true"</li> @@ -88,8 +81,6 @@ public class ActivateRuleRequest { } /** - * Rule key - * * This is a mandatory parameter. * Example value: "squid:AvoidCycles" */ @@ -103,8 +94,6 @@ public class ActivateRuleRequest { } /** - * Severity. Ignored if parameter reset is true. - * * Possible values: * <ul> * <li>"INFO"</li> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ActivateRulesRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ActivateRulesRequest.java index 32f6e1ad881..bc3aef82c2d 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ActivateRulesRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ActivateRulesRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Bulk-activate rules on one quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/activate_rules">Further information about this action online (including a response example)</a> @@ -56,8 +54,6 @@ public class ActivateRulesRequest { private List<String> types; /** - * Filter rules that are activated or deactivated on the selected Quality profile. Ignored if the parameter 'qprofile' is not set. - * * Possible values: * <ul> * <li>"true"</li> @@ -76,8 +72,6 @@ public class ActivateRulesRequest { } /** - * Comma-separated list of activation severities, i.e the severity of rules in Quality profiles. - * * Example value: "CRITICAL,BLOCKER" * Possible values: * <ul> @@ -98,8 +92,6 @@ public class ActivateRulesRequest { } /** - * Ascending sort - * * Possible values: * <ul> * <li>"true"</li> @@ -118,8 +110,6 @@ public class ActivateRulesRequest { } /** - * Filters rules added since date. Format is yyyy-MM-dd - * * Example value: "2014-06-22" */ public ActivateRulesRequest setAvailableSince(String availableSince) { @@ -132,8 +122,6 @@ public class ActivateRulesRequest { } /** - * Quality profile key to filter rules that are activated. Meant to compare easily to profile set in 'qprofile' - * * This is part of the internal API. * Example value: "AU-TpxcA-iU5OvuD2FLz" */ @@ -147,8 +135,6 @@ public class ActivateRulesRequest { } /** - * Comma-separated list of values of inheritance for a rule within a quality profile. Used only if the parameter 'activation' is set. - * * Example value: "INHERITED,OVERRIDES" * Possible values: * <ul> @@ -167,8 +153,6 @@ public class ActivateRulesRequest { } /** - * Filter template rules - * * Possible values: * <ul> * <li>"true"</li> @@ -187,8 +171,6 @@ public class ActivateRulesRequest { } /** - * Comma-separated list of languages - * * Example value: "java,js" */ public ActivateRulesRequest setLanguages(List<String> languages) { @@ -201,8 +183,6 @@ public class ActivateRulesRequest { } /** - * Organization key - * * This is part of the internal API. * Example value: "my-org" */ @@ -216,8 +196,6 @@ public class ActivateRulesRequest { } /** - * UTF-8 search query - * * Example value: "xpath" */ public ActivateRulesRequest setQ(String q) { @@ -230,8 +208,6 @@ public class ActivateRulesRequest { } /** - * Quality profile key to filter on. Used only if the parameter 'activation' is set. - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public ActivateRulesRequest setQprofile(String qprofile) { @@ -244,8 +220,6 @@ public class ActivateRulesRequest { } /** - * Comma-separated list of repositories - * * Example value: "checkstyle,findbugs" */ public ActivateRulesRequest setRepositories(List<String> repositories) { @@ -258,8 +232,6 @@ public class ActivateRulesRequest { } /** - * Key of rule to search for - * * Example value: "squid:S001" */ public ActivateRulesRequest setRuleKey(String ruleKey) { @@ -272,8 +244,6 @@ public class ActivateRulesRequest { } /** - * Sort field - * * Example value: "name" * Possible values: * <ul> @@ -293,8 +263,6 @@ public class ActivateRulesRequest { } /** - * Comma-separated list of default severities. Not the same than severity of rules in Quality profiles. - * * Example value: "CRITICAL,BLOCKER" * Possible values: * <ul> @@ -315,8 +283,6 @@ public class ActivateRulesRequest { } /** - * Comma-separated list of status codes - * * Example value: "READY" * Possible values: * <ul> @@ -336,8 +302,6 @@ public class ActivateRulesRequest { } /** - * Comma-separated list of tags. Returned rules match any of the tags (OR operator) - * * Example value: "security,java8" */ public ActivateRulesRequest setTags(List<String> tags) { @@ -350,8 +314,6 @@ public class ActivateRulesRequest { } /** - * Quality Profile key on which the rule activation is done. To retrieve a quality profile key please see <code>api/qualityprofiles/search</code> - * * This is a mandatory parameter. * Example value: "AU-TpxcA-iU5OvuD2FL0" */ @@ -365,8 +327,6 @@ public class ActivateRulesRequest { } /** - * Severity to set on the activated rules - * * Possible values: * <ul> * <li>"INFO"</li> @@ -386,8 +346,6 @@ public class ActivateRulesRequest { } /** - * Key of the template rule to filter on. Used to search for the custom rules based on this template. - * * Example value: "java:S001" */ public ActivateRulesRequest setTemplateKey(String templateKey) { @@ -400,8 +358,6 @@ public class ActivateRulesRequest { } /** - * Comma-separated list of types. Returned rules match any of the tags (OR operator) - * * Example value: "BUG" * Possible values: * <ul> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/AddGroupRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/AddGroupRequest.java index 458a5e98f1b..4cfc3b08ff9 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/AddGroupRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/AddGroupRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Allow a group to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/add_group">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class AddGroupRequest { private String qualityProfile; /** - * Group name - * * This is a mandatory parameter. * Example value: "sonar-administrators" */ @@ -53,8 +50,6 @@ public class AddGroupRequest { } /** - * Quality profile language - * * This is a mandatory parameter. */ public AddGroupRequest setLanguage(String language) { @@ -67,8 +62,6 @@ public class AddGroupRequest { } /** - * Organization key. If no organization is provided, the default organization is used. - * * This is part of the internal API. * Example value: "my-org" */ @@ -82,8 +75,6 @@ public class AddGroupRequest { } /** - * Quality Profile name - * * This is a mandatory parameter. * Example value: "Recommended quality profile" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/AddProjectRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/AddProjectRequest.java index 5c056b0e2b0..cf4c045e434 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/AddProjectRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/AddProjectRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Associate a project with a quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li> <li>Administer right on the specified project</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/add_project">Further information about this action online (including a response example)</a> @@ -40,8 +39,6 @@ public class AddProjectRequest { private String qualityProfile; /** - * Quality profile key - * * Example value: "AU-Tpxb--iU5OvuD2FLy" * @deprecated since 6.6 */ @@ -56,8 +53,6 @@ public class AddProjectRequest { } /** - * Quality profile language. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate. - * */ public AddProjectRequest setLanguage(String language) { this.language = language; @@ -69,8 +64,6 @@ public class AddProjectRequest { } /** - * Organization key. If no organization is provided, the default organization is used. - * * This is part of the internal API. * Example value: "my-org" */ @@ -84,8 +77,6 @@ public class AddProjectRequest { } /** - * Project key - * * Example value: "my_project" */ public AddProjectRequest setProject(String project) { @@ -98,8 +89,6 @@ public class AddProjectRequest { } /** - * Project ID. Either this parameter or 'project' must be set. - * * Example value: "AU-TpxcA-iU5OvuD2FL5" * @deprecated since 6.5 */ @@ -114,8 +103,6 @@ public class AddProjectRequest { } /** - * Quality profile name. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate. - * * Example value: "Sonar way" */ public AddProjectRequest setQualityProfile(String qualityProfile) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/AddUserRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/AddUserRequest.java index 3e7d4888b6c..600875c71af 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/AddUserRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/AddUserRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Allow a user to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/add_user">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class AddUserRequest { private String qualityProfile; /** - * Quality profile language - * * This is a mandatory parameter. */ public AddUserRequest setLanguage(String language) { @@ -52,8 +49,6 @@ public class AddUserRequest { } /** - * User login - * * This is a mandatory parameter. * Example value: "john.doe" */ @@ -67,8 +62,6 @@ public class AddUserRequest { } /** - * Organization key. If no organization is provided, the default organization is used. - * * This is part of the internal API. * Example value: "my-org" */ @@ -82,8 +75,6 @@ public class AddUserRequest { } /** - * Quality Profile name - * * This is a mandatory parameter. * Example value: "Recommended quality profile" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/BackupRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/BackupRequest.java index da842fd3a1c..2e7039c3756 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/BackupRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/BackupRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Backup a quality profile in XML form. The exported profile can be restored through api/qualityprofiles/restore. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/backup">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class BackupRequest { private String qualityProfile; /** - * Quality profile key - * * Example value: "AU-Tpxb--iU5OvuD2FLy" * @deprecated since 6.6 */ @@ -54,8 +51,6 @@ public class BackupRequest { } /** - * Quality profile language. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate. - * */ public BackupRequest setLanguage(String language) { this.language = language; @@ -67,8 +62,6 @@ public class BackupRequest { } /** - * Organization key. If no organization is provided, the default organization is used. - * * This is part of the internal API. * Example value: "my-org" */ @@ -82,8 +75,6 @@ public class BackupRequest { } /** - * Quality profile name. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate. - * * Example value: "Sonar way" */ public BackupRequest setQualityProfile(String qualityProfile) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ChangeParentRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ChangeParentRequest.java index 4dc39a59141..404037a9a16 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ChangeParentRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ChangeParentRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Change a quality profile's parent.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/change_parent">Further information about this action online (including a response example)</a> @@ -40,8 +39,6 @@ public class ChangeParentRequest { private String qualityProfile; /** - * Quality profile key - * * Example value: "AU-Tpxb--iU5OvuD2FLy" * @deprecated since 6.6 */ @@ -56,8 +53,6 @@ public class ChangeParentRequest { } /** - * Quality profile language. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate. - * */ public ChangeParentRequest setLanguage(String language) { this.language = language; @@ -69,8 +64,6 @@ public class ChangeParentRequest { } /** - * Organization key. If no organization is provided, the default organization is used. - * * This is part of the internal API. * Example value: "my-org" */ @@ -84,8 +77,6 @@ public class ChangeParentRequest { } /** - * New parent profile key.<br> If no profile is provided, the inheritance link with current parent profile (if any) is broken, which deactivates all rules which come from the parent and are not overridden. - * * Example value: "AU-TpxcA-iU5OvuD2FLz" * @deprecated since 6.6 */ @@ -100,8 +91,6 @@ public class ChangeParentRequest { } /** - * Quality profile name. If this parameter is set, 'parentKey' must not be set and 'language' must be set to disambiguate. - * * Example value: "Sonar way" */ public ChangeParentRequest setParentQualityProfile(String parentQualityProfile) { @@ -114,8 +103,6 @@ public class ChangeParentRequest { } /** - * Quality profile name. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate. - * * Example value: "Sonar way" */ public ChangeParentRequest setQualityProfile(String qualityProfile) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ChangelogRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ChangelogRequest.java index 0e615b74b6e..9e5843f848b 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ChangelogRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ChangelogRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Get the history of changes on a quality profile: rule activation/deactivation, change in parameters/severity. Events are ordered by date in descending order (most recent first). - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/changelog">Further information about this action online (including a response example)</a> @@ -42,8 +41,6 @@ public class ChangelogRequest { private String to; /** - * Quality profile key - * * Example value: "AU-Tpxb--iU5OvuD2FLy" * @deprecated since 6.6 */ @@ -58,8 +55,6 @@ public class ChangelogRequest { } /** - * Quality profile language. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate. - * */ public ChangelogRequest setLanguage(String language) { this.language = language; @@ -71,8 +66,6 @@ public class ChangelogRequest { } /** - * Organization key. If no organization is provided, the default organization is used. - * * This is part of the internal API. * Example value: "my-org" */ @@ -86,8 +79,6 @@ public class ChangelogRequest { } /** - * 1-based page number - * * Example value: "42" */ public ChangelogRequest setP(String p) { @@ -100,8 +91,6 @@ public class ChangelogRequest { } /** - * Page size. Must be greater than 0 and less than 500 - * * Example value: "20" */ public ChangelogRequest setPs(String ps) { @@ -114,8 +103,6 @@ public class ChangelogRequest { } /** - * Quality profile name. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate. - * * Example value: "Sonar way" */ public ChangelogRequest setQualityProfile(String qualityProfile) { @@ -128,8 +115,6 @@ public class ChangelogRequest { } /** - * Start date for the changelog. <br>Either a date (server timezone) or datetime can be provided. - * * Example value: "2017-10-19 or 2017-10-19T13:00:00+0200" */ public ChangelogRequest setSince(String since) { @@ -142,8 +127,6 @@ public class ChangelogRequest { } /** - * End date for the changelog. <br>Either a date (server timezone) or datetime can be provided. - * * Example value: "2017-10-19 or 2017-10-19T13:00:00+0200" */ public ChangelogRequest setTo(String to) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/CompareRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/CompareRequest.java index e13c2942c96..8b733cf8747 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/CompareRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/CompareRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Compare two quality profiles. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/compare">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class CompareRequest { private String rightKey; /** - * Profile key. - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy" */ @@ -51,8 +48,6 @@ public class CompareRequest { } /** - * Another profile key. - * * This is a mandatory parameter. * Example value: "AU-TpxcA-iU5OvuD2FLz" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/CopyRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/CopyRequest.java index 7a7f63b521b..79ad16a47a5 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/CopyRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/CopyRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Copy a quality profile.<br> Requires to be logged in and the 'Administer Quality Profiles' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/copy">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class CopyRequest { private String toName; /** - * Quality profile key - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy" */ @@ -51,8 +48,6 @@ public class CopyRequest { } /** - * Name for the new quality profile. - * * This is a mandatory parameter. * Example value: "My Sonar way" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/CreateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/CreateRequest.java index b3cfa60be88..ee412ac59b6 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/CreateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/CreateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Create a quality profile.<br>Requires to be logged in and the 'Administer Quality Profiles' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/create">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class CreateRequest { private String organization; /** - * Quality profile language - * * This is a mandatory parameter. * Example value: "js" */ @@ -52,8 +49,6 @@ public class CreateRequest { } /** - * Quality profile name - * * This is a mandatory parameter. * Example value: "My Sonar way" */ @@ -67,8 +62,6 @@ public class CreateRequest { } /** - * Organization key. If no organization is provided, the default organization is used. - * * This is part of the internal API. * Example value: "my-org" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/DeactivateRuleRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/DeactivateRuleRequest.java index e1b5b3e62aa..567d9bbfa8d 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/DeactivateRuleRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/DeactivateRuleRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Deactivate a rule on a quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/deactivate_rule">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class DeactivateRuleRequest { private String rule; /** - * Quality Profile key. Can be obtained through <code>api/qualityprofiles/search</code> - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy" */ @@ -51,8 +48,6 @@ public class DeactivateRuleRequest { } /** - * Rule key - * * This is a mandatory parameter. * Example value: "squid:AvoidCycles" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/DeactivateRulesRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/DeactivateRulesRequest.java index 93b63ba09a8..c63f5dcb4cd 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/DeactivateRulesRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/DeactivateRulesRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Bulk deactivate rules on Quality profiles.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/deactivate_rules">Further information about this action online (including a response example)</a> @@ -55,8 +53,6 @@ public class DeactivateRulesRequest { private List<String> types; /** - * Filter rules that are activated or deactivated on the selected Quality profile. Ignored if the parameter 'qprofile' is not set. - * * Possible values: * <ul> * <li>"true"</li> @@ -75,8 +71,6 @@ public class DeactivateRulesRequest { } /** - * Comma-separated list of activation severities, i.e the severity of rules in Quality profiles. - * * Example value: "CRITICAL,BLOCKER" * Possible values: * <ul> @@ -97,8 +91,6 @@ public class DeactivateRulesRequest { } /** - * Ascending sort - * * Possible values: * <ul> * <li>"true"</li> @@ -117,8 +109,6 @@ public class DeactivateRulesRequest { } /** - * Filters rules added since date. Format is yyyy-MM-dd - * * Example value: "2014-06-22" */ public DeactivateRulesRequest setAvailableSince(String availableSince) { @@ -131,8 +121,6 @@ public class DeactivateRulesRequest { } /** - * Quality profile key to filter rules that are activated. Meant to compare easily to profile set in 'qprofile' - * * This is part of the internal API. * Example value: "AU-TpxcA-iU5OvuD2FLz" */ @@ -146,8 +134,6 @@ public class DeactivateRulesRequest { } /** - * Comma-separated list of values of inheritance for a rule within a quality profile. Used only if the parameter 'activation' is set. - * * Example value: "INHERITED,OVERRIDES" * Possible values: * <ul> @@ -166,8 +152,6 @@ public class DeactivateRulesRequest { } /** - * Filter template rules - * * Possible values: * <ul> * <li>"true"</li> @@ -186,8 +170,6 @@ public class DeactivateRulesRequest { } /** - * Comma-separated list of languages - * * Example value: "java,js" */ public DeactivateRulesRequest setLanguages(List<String> languages) { @@ -200,8 +182,6 @@ public class DeactivateRulesRequest { } /** - * Organization key - * * This is part of the internal API. * Example value: "my-org" */ @@ -215,8 +195,6 @@ public class DeactivateRulesRequest { } /** - * UTF-8 search query - * * Example value: "xpath" */ public DeactivateRulesRequest setQ(String q) { @@ -229,8 +207,6 @@ public class DeactivateRulesRequest { } /** - * Quality profile key to filter on. Used only if the parameter 'activation' is set. - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public DeactivateRulesRequest setQprofile(String qprofile) { @@ -243,8 +219,6 @@ public class DeactivateRulesRequest { } /** - * Comma-separated list of repositories - * * Example value: "checkstyle,findbugs" */ public DeactivateRulesRequest setRepositories(List<String> repositories) { @@ -257,8 +231,6 @@ public class DeactivateRulesRequest { } /** - * Key of rule to search for - * * Example value: "squid:S001" */ public DeactivateRulesRequest setRuleKey(String ruleKey) { @@ -271,8 +243,6 @@ public class DeactivateRulesRequest { } /** - * Sort field - * * Example value: "name" * Possible values: * <ul> @@ -292,8 +262,6 @@ public class DeactivateRulesRequest { } /** - * Comma-separated list of default severities. Not the same than severity of rules in Quality profiles. - * * Example value: "CRITICAL,BLOCKER" * Possible values: * <ul> @@ -314,8 +282,6 @@ public class DeactivateRulesRequest { } /** - * Comma-separated list of status codes - * * Example value: "READY" * Possible values: * <ul> @@ -335,8 +301,6 @@ public class DeactivateRulesRequest { } /** - * Comma-separated list of tags. Returned rules match any of the tags (OR operator) - * * Example value: "security,java8" */ public DeactivateRulesRequest setTags(List<String> tags) { @@ -349,8 +313,6 @@ public class DeactivateRulesRequest { } /** - * Quality Profile key on which the rule deactivation is done. To retrieve a profile key please see <code>api/qualityprofiles/search</code> - * * This is a mandatory parameter. * Example value: "AU-TpxcA-iU5OvuD2FL1" */ @@ -364,8 +326,6 @@ public class DeactivateRulesRequest { } /** - * Key of the template rule to filter on. Used to search for the custom rules based on this template. - * * Example value: "java:S001" */ public DeactivateRulesRequest setTemplateKey(String templateKey) { @@ -378,8 +338,6 @@ public class DeactivateRulesRequest { } /** - * Comma-separated list of types. Returned rules match any of the tags (OR operator) - * * Example value: "BUG" * Possible values: * <ul> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/DeleteRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/DeleteRequest.java index 46c13d2f176..74ecf1f4df9 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/DeleteRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/DeleteRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Delete a quality profile and all its descendants. The default quality profile cannot be deleted.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/delete">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class DeleteRequest { private String qualityProfile; /** - * Quality profile key - * * Example value: "AU-Tpxb--iU5OvuD2FLy" * @deprecated since 6.6 */ @@ -54,8 +51,6 @@ public class DeleteRequest { } /** - * Quality profile language. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate. - * */ public DeleteRequest setLanguage(String language) { this.language = language; @@ -67,8 +62,6 @@ public class DeleteRequest { } /** - * Organization key. If no organization is provided, the default organization is used. - * * This is part of the internal API. * Example value: "my-org" */ @@ -82,8 +75,6 @@ public class DeleteRequest { } /** - * Quality profile name. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate. - * * Example value: "Sonar way" */ public DeleteRequest setQualityProfile(String qualityProfile) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ExportRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ExportRequest.java index 37d2b1798c1..20d571aec3f 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ExportRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ExportRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Export a quality profile. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/export">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class ExportRequest { private String qualityProfile; /** - * Quality profile key - * * Example value: "AU-Tpxb--iU5OvuD2FLy" * @deprecated since 6.6 */ @@ -54,8 +51,6 @@ public class ExportRequest { } /** - * Quality profile language. If this parameter is set, 'key' must not be set. - * * Example value: "" */ public ExportRequest setLanguage(String language) { @@ -68,8 +63,6 @@ public class ExportRequest { } /** - * Organization key. If no organization is provided, the default organization is used. - * * This is part of the internal API. * Example value: "my-org" */ @@ -83,8 +76,6 @@ public class ExportRequest { } /** - * Quality profile name to export. If left empty, the default profile for the language is exported. If this parameter is set, 'key' must not be set. - * * Example value: "My Sonar way" */ public ExportRequest setQualityProfile(String qualityProfile) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/InheritanceRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/InheritanceRequest.java index a6581177218..69a3750e7b5 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/InheritanceRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/InheritanceRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Show a quality profile's ancestors and children. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/inheritance">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class InheritanceRequest { private String qualityProfile; /** - * Quality profile key - * * Example value: "AU-Tpxb--iU5OvuD2FLy" * @deprecated since 6.6 */ @@ -54,8 +51,6 @@ public class InheritanceRequest { } /** - * Quality profile language. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate. - * */ public InheritanceRequest setLanguage(String language) { this.language = language; @@ -67,8 +62,6 @@ public class InheritanceRequest { } /** - * Organization key. If no organization is provided, the default organization is used. - * * This is part of the internal API. * Example value: "my-org" */ @@ -82,8 +75,6 @@ public class InheritanceRequest { } /** - * Quality profile name. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate. - * * Example value: "Sonar way" */ public InheritanceRequest setQualityProfile(String qualityProfile) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ProjectsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ProjectsRequest.java index a7112fba08a..38e0c2e6bdf 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ProjectsRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ProjectsRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * List projects with their association status regarding a quality profile - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/projects">Further information about this action online (including a response example)</a> @@ -39,8 +38,6 @@ public class ProjectsRequest { private String selected; /** - * Quality profile key - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy" */ @@ -54,8 +51,6 @@ public class ProjectsRequest { } /** - * 1-based page number - * * Example value: "42" */ public ProjectsRequest setP(String p) { @@ -68,8 +63,6 @@ public class ProjectsRequest { } /** - * Page size. Must be greater than 0 and less than 500 - * * Example value: "20" */ public ProjectsRequest setPs(String ps) { @@ -82,8 +75,6 @@ public class ProjectsRequest { } /** - * Limit search to projects that contain the supplied string. - * * Example value: "sonar" */ public ProjectsRequest setQ(String q) { @@ -96,8 +87,6 @@ public class ProjectsRequest { } /** - * Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), or all items with their selection status (selected=all). - * * Possible values: * <ul> * <li>"all"</li> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/QualityprofilesService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/QualityprofilesService.java index 9d362c4f070..31694161a17 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/QualityprofilesService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/QualityprofilesService.java @@ -35,7 +35,6 @@ import org.sonarqube.ws.Qualityprofiles.SearchUsersResponse; import org.sonarqube.ws.Qualityprofiles.ShowResponse; /** - * Manage quality profiles. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -46,7 +45,6 @@ public class QualityprofilesService extends BaseService { } /** - * Activate a rule on a Quality Profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> * * This is part of the internal API. * This is a POST request. @@ -57,7 +55,7 @@ public class QualityprofilesService extends BaseService { call( new PostRequest(path("activate_rule")) .setParam("key", request.getKey()) - .setParam("params", request.getParams()) + .setParam("params", request.getParams() == null ? null : request.getParams().stream().collect(Collectors.joining(","))) .setParam("reset", request.getReset()) .setParam("rule", request.getRule()) .setParam("severity", request.getSeverity()) @@ -66,7 +64,6 @@ public class QualityprofilesService extends BaseService { } /** - * Bulk-activate rules on one quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> * * This is part of the internal API. * This is a POST request. @@ -102,7 +99,6 @@ public class QualityprofilesService extends BaseService { } /** - * Allow a group to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> * * This is part of the internal API. * This is a POST request. @@ -121,7 +117,6 @@ public class QualityprofilesService extends BaseService { } /** - * Associate a project with a quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li> <li>Administer right on the specified project</li></ul> * * This is part of the internal API. * This is a POST request. @@ -142,7 +137,6 @@ public class QualityprofilesService extends BaseService { } /** - * Allow a user to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> * * This is part of the internal API. * This is a POST request. @@ -161,7 +155,6 @@ public class QualityprofilesService extends BaseService { } /** - * Backup a quality profile in XML form. The exported profile can be restored through api/qualityprofiles/restore. * * This is part of the internal API. * This is a GET request. @@ -180,7 +173,6 @@ public class QualityprofilesService extends BaseService { } /** - * Change a quality profile's parent.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> * * This is part of the internal API. * This is a POST request. @@ -201,7 +193,6 @@ public class QualityprofilesService extends BaseService { } /** - * Get the history of changes on a quality profile: rule activation/deactivation, change in parameters/severity. Events are ordered by date in descending order (most recent first). * * This is part of the internal API. * This is a GET request. @@ -224,7 +215,6 @@ public class QualityprofilesService extends BaseService { } /** - * Compare two quality profiles. * * This is part of the internal API. * This is a GET request. @@ -241,7 +231,6 @@ public class QualityprofilesService extends BaseService { } /** - * Copy a quality profile.<br> Requires to be logged in and the 'Administer Quality Profiles' permission. * * This is part of the internal API. * This is a POST request. @@ -257,7 +246,6 @@ public class QualityprofilesService extends BaseService { } /** - * Create a quality profile.<br>Requires to be logged in and the 'Administer Quality Profiles' permission. * * This is part of the internal API. * This is a POST request. @@ -274,7 +262,6 @@ public class QualityprofilesService extends BaseService { } /** - * Deactivate a rule on a quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> * * This is part of the internal API. * This is a POST request. @@ -291,7 +278,6 @@ public class QualityprofilesService extends BaseService { } /** - * Bulk deactivate rules on Quality profiles.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> * * This is part of the internal API. * This is a POST request. @@ -326,7 +312,6 @@ public class QualityprofilesService extends BaseService { } /** - * Delete a quality profile and all its descendants. The default quality profile cannot be deleted.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> * * This is part of the internal API. * This is a POST request. @@ -345,7 +330,6 @@ public class QualityprofilesService extends BaseService { } /** - * Export a quality profile. * * This is part of the internal API. * This is a GET request. @@ -364,7 +348,6 @@ public class QualityprofilesService extends BaseService { } /** - * Lists available profile export formats. * * This is part of the internal API. * This is a GET request. @@ -379,7 +362,6 @@ public class QualityprofilesService extends BaseService { } /** - * List supported importers. * * This is part of the internal API. * This is a GET request. @@ -394,7 +376,6 @@ public class QualityprofilesService extends BaseService { } /** - * Show a quality profile's ancestors and children. * * This is part of the internal API. * This is a GET request. @@ -412,7 +393,6 @@ public class QualityprofilesService extends BaseService { } /** - * List projects with their association status regarding a quality profile * * This is part of the internal API. * This is a GET request. @@ -432,7 +412,6 @@ public class QualityprofilesService extends BaseService { } /** - * Remove the ability from a group to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> * * This is part of the internal API. * This is a POST request. @@ -451,7 +430,6 @@ public class QualityprofilesService extends BaseService { } /** - * Remove a project's association with a quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li> <li>Administer right on the specified project</li></ul> * * This is part of the internal API. * This is a POST request. @@ -472,7 +450,6 @@ public class QualityprofilesService extends BaseService { } /** - * Remove the ability from a user to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> * * This is part of the internal API. * This is a POST request. @@ -491,7 +468,6 @@ public class QualityprofilesService extends BaseService { } /** - * Rename a quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> * * This is part of the internal API. * This is a POST request. @@ -508,7 +484,6 @@ public class QualityprofilesService extends BaseService { } /** - * Restore a quality profile using an XML file. The restored profile name is taken from the backup file, so if a profile with the same name and language already exists, it will be overwritten.<br> Requires to be logged in and the 'Administer Quality Profiles' permission. * * This is part of the internal API. * This is a POST request. @@ -525,7 +500,6 @@ public class QualityprofilesService extends BaseService { } /** - * This web service has no effect since 6.4. It's no more possible to restore built-in quality profiles because they are automatically updated and read only. Returns HTTP code 410. * * This is part of the internal API. * This is a POST request. @@ -542,7 +516,6 @@ public class QualityprofilesService extends BaseService { } /** - * Search quality profiles * * This is part of the internal API. * This is a GET request. @@ -561,7 +534,6 @@ public class QualityprofilesService extends BaseService { } /** - * List the groups that are allowed to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> * * This is part of the internal API. * This is a GET request. @@ -582,7 +554,6 @@ public class QualityprofilesService extends BaseService { } /** - * List the users that are allowed to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> * * This is part of the internal API. * This is a GET request. @@ -603,7 +574,6 @@ public class QualityprofilesService extends BaseService { } /** - * Select the default profile for a given language.<br> Requires to be logged in and the 'Administer Quality Profiles' permission. * * This is part of the internal API. * This is a POST request. @@ -622,7 +592,6 @@ public class QualityprofilesService extends BaseService { } /** - * Show a quality profile * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/RemoveGroupRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/RemoveGroupRequest.java index 7fa9feec42a..405866d6538 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/RemoveGroupRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/RemoveGroupRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Remove the ability from a group to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/remove_group">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class RemoveGroupRequest { private String qualityProfile; /** - * Group name - * * This is a mandatory parameter. * Example value: "sonar-administrators" */ @@ -53,8 +50,6 @@ public class RemoveGroupRequest { } /** - * Quality profile language - * * This is a mandatory parameter. */ public RemoveGroupRequest setLanguage(String language) { @@ -67,8 +62,6 @@ public class RemoveGroupRequest { } /** - * Organization key. If no organization is provided, the default organization is used. - * * This is part of the internal API. * Example value: "my-org" */ @@ -82,8 +75,6 @@ public class RemoveGroupRequest { } /** - * Quality Profile name - * * This is a mandatory parameter. * Example value: "Recommended quality profile" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/RemoveProjectRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/RemoveProjectRequest.java index a5b3dbdabe8..12bdbfffa9f 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/RemoveProjectRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/RemoveProjectRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Remove a project's association with a quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li> <li>Administer right on the specified project</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/remove_project">Further information about this action online (including a response example)</a> @@ -40,8 +39,6 @@ public class RemoveProjectRequest { private String qualityProfile; /** - * Quality profile key - * * Example value: "AU-Tpxb--iU5OvuD2FLy" * @deprecated since 6.6 */ @@ -56,8 +53,6 @@ public class RemoveProjectRequest { } /** - * Quality profile language. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate. - * */ public RemoveProjectRequest setLanguage(String language) { this.language = language; @@ -69,8 +64,6 @@ public class RemoveProjectRequest { } /** - * Organization key. If no organization is provided, the default organization is used. - * * This is part of the internal API. * Example value: "my-org" */ @@ -84,8 +77,6 @@ public class RemoveProjectRequest { } /** - * Project key - * * Example value: "my_project" */ public RemoveProjectRequest setProject(String project) { @@ -98,8 +89,6 @@ public class RemoveProjectRequest { } /** - * Project ID. Either this parameter, or 'project' must be set. - * * Example value: "AU-TpxcB-iU5OvuD2FL6" * @deprecated since 6.5 */ @@ -114,8 +103,6 @@ public class RemoveProjectRequest { } /** - * Quality profile name. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate. - * * Example value: "Sonar way" */ public RemoveProjectRequest setQualityProfile(String qualityProfile) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/RemoveUserRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/RemoveUserRequest.java index 003df6b7f21..7fa91921a78 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/RemoveUserRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/RemoveUserRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Remove the ability from a user to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/remove_user">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class RemoveUserRequest { private String qualityProfile; /** - * Quality profile language - * * This is a mandatory parameter. */ public RemoveUserRequest setLanguage(String language) { @@ -52,8 +49,6 @@ public class RemoveUserRequest { } /** - * User login - * * This is a mandatory parameter. * Example value: "john.doe" */ @@ -67,8 +62,6 @@ public class RemoveUserRequest { } /** - * Organization key. If no organization is provided, the default organization is used. - * * This is part of the internal API. * Example value: "my-org" */ @@ -82,8 +75,6 @@ public class RemoveUserRequest { } /** - * Quality Profile name - * * This is a mandatory parameter. * Example value: "Recommended quality profile" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/RenameRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/RenameRequest.java index 5907d37f146..858306dba65 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/RenameRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/RenameRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Rename a quality profile.<br> Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/rename">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class RenameRequest { private String name; /** - * Quality profile key - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy" */ @@ -51,8 +48,6 @@ public class RenameRequest { } /** - * New quality profile name - * * This is a mandatory parameter. * Example value: "My Sonar way" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/RestoreRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/RestoreRequest.java index 8a4e292ce7f..ad9711d00b3 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/RestoreRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/RestoreRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Restore a quality profile using an XML file. The restored profile name is taken from the backup file, so if a profile with the same name and language already exists, it will be overwritten.<br> Requires to be logged in and the 'Administer Quality Profiles' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/restore">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class RestoreRequest { private String organization; /** - * A profile backup file in XML format, as generated by api/qualityprofiles/backup or the former api/profiles/backup. - * * This is a mandatory parameter. */ public RestoreRequest setBackup(String backup) { @@ -50,8 +47,6 @@ public class RestoreRequest { } /** - * Organization key. If no organization is provided, the default organization is used. - * * This is part of the internal API. * Example value: "my-org" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/SearchGroupsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/SearchGroupsRequest.java index 775a0aa3d34..4d0d65e8fc9 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/SearchGroupsRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/SearchGroupsRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * List the groups that are allowed to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/search_groups">Further information about this action online (including a response example)</a> @@ -41,8 +40,6 @@ public class SearchGroupsRequest { private String selected; /** - * Quality profile language - * * This is a mandatory parameter. */ public SearchGroupsRequest setLanguage(String language) { @@ -55,8 +52,6 @@ public class SearchGroupsRequest { } /** - * Organization key. If no organization is provided, the default organization is used. - * * This is part of the internal API. * Example value: "my-org" */ @@ -70,8 +65,6 @@ public class SearchGroupsRequest { } /** - * 1-based page number - * * Example value: "42" */ public SearchGroupsRequest setP(String p) { @@ -84,8 +77,6 @@ public class SearchGroupsRequest { } /** - * Page size. Must be greater than 0. - * * Example value: "20" */ public SearchGroupsRequest setPs(String ps) { @@ -98,8 +89,6 @@ public class SearchGroupsRequest { } /** - * Limit search to group names that contain the supplied string. - * * Example value: "sonar" */ public SearchGroupsRequest setQ(String q) { @@ -112,8 +101,6 @@ public class SearchGroupsRequest { } /** - * Quality Profile name - * * This is a mandatory parameter. * Example value: "Recommended quality profile" */ @@ -127,8 +114,6 @@ public class SearchGroupsRequest { } /** - * Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), or all items with their selection status (selected=all). - * * Possible values: * <ul> * <li>"all"</li> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/SearchRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/SearchRequest.java index ddbbd5a82fc..72452c1b687 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/SearchRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/SearchRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Search quality profiles - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/search">Further information about this action online (including a response example)</a> @@ -39,8 +38,6 @@ public class SearchRequest { private String qualityProfile; /** - * If set to true, return only the quality profiles marked as default for each language - * * Possible values: * <ul> * <li>"true"</li> @@ -59,8 +56,6 @@ public class SearchRequest { } /** - * Language key. If provided, only profiles for the given language are returned. - * */ public SearchRequest setLanguage(String language) { this.language = language; @@ -72,8 +67,6 @@ public class SearchRequest { } /** - * Organization key. If no organization is provided, the default organization is used. - * * This is part of the internal API. * Example value: "my-org" */ @@ -87,8 +80,6 @@ public class SearchRequest { } /** - * Project key - * * Example value: "my_project" */ public SearchRequest setProject(String project) { @@ -101,8 +92,6 @@ public class SearchRequest { } /** - * Quality profile name - * * Example value: "SonarQube Way" */ public SearchRequest setQualityProfile(String qualityProfile) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/SearchUsersRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/SearchUsersRequest.java index 10fcabd2010..802d7491471 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/SearchUsersRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/SearchUsersRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * List the users that are allowed to edit a Quality Profile.<br>Requires one of the following permissions:<ul> <li>'Administer Quality Profiles'</li> <li>Edit right on the specified quality profile</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/search_users">Further information about this action online (including a response example)</a> @@ -41,8 +40,6 @@ public class SearchUsersRequest { private String selected; /** - * Quality profile language - * * This is a mandatory parameter. */ public SearchUsersRequest setLanguage(String language) { @@ -55,8 +52,6 @@ public class SearchUsersRequest { } /** - * Organization key. If no organization is provided, the default organization is used. - * * This is part of the internal API. * Example value: "my-org" */ @@ -70,8 +65,6 @@ public class SearchUsersRequest { } /** - * 1-based page number - * * Example value: "42" */ public SearchUsersRequest setP(String p) { @@ -84,8 +77,6 @@ public class SearchUsersRequest { } /** - * Page size. Must be greater than 0. - * * Example value: "20" */ public SearchUsersRequest setPs(String ps) { @@ -98,8 +89,6 @@ public class SearchUsersRequest { } /** - * Limit search to names or logins that contain the supplied string. - * * Example value: "freddy" */ public SearchUsersRequest setQ(String q) { @@ -112,8 +101,6 @@ public class SearchUsersRequest { } /** - * Quality Profile name - * * This is a mandatory parameter. * Example value: "Recommended quality profile" */ @@ -127,8 +114,6 @@ public class SearchUsersRequest { } /** - * Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), or all items with their selection status (selected=all). - * * Possible values: * <ul> * <li>"all"</li> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/SetDefaultRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/SetDefaultRequest.java index 485945b997a..aa0252af42b 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/SetDefaultRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/SetDefaultRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Select the default profile for a given language.<br> Requires to be logged in and the 'Administer Quality Profiles' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/set_default">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class SetDefaultRequest { private String qualityProfile; /** - * Quality profile key - * * Example value: "AU-Tpxb--iU5OvuD2FLy" * @deprecated since 6.6 */ @@ -54,8 +51,6 @@ public class SetDefaultRequest { } /** - * Quality profile language. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate. - * */ public SetDefaultRequest setLanguage(String language) { this.language = language; @@ -67,8 +62,6 @@ public class SetDefaultRequest { } /** - * Organization key. If no organization is provided, the default organization is used. - * * This is part of the internal API. * Example value: "my-org" */ @@ -82,8 +75,6 @@ public class SetDefaultRequest { } /** - * Quality profile name. If this parameter is set, 'key' must not be set and 'language' must be set to disambiguate. - * * Example value: "Sonar way" */ public SetDefaultRequest setQualityProfile(String qualityProfile) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ShowRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ShowRequest.java index 4c89a6754fe..72cc9cf9f9c 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ShowRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/ShowRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.qualityprofiles; +import java.util.List; import javax.annotation.Generated; /** - * Show a quality profile - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/qualityprofiles/show">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class ShowRequest { private String key; /** - * Add the number of missing rules from the related Sonar way profile in the response - * * This is part of the internal API. * Possible values: * <ul> @@ -57,8 +54,6 @@ public class ShowRequest { } /** - * Quality profile key - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/package-info.java index a86e3fbe31e..90fb25e0357 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/qualityprofiles/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.qualityprofiles; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/resources/ResourcesService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/resources/ResourcesService.java index 7eaa17f1aa1..588606d44ac 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/resources/ResourcesService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/resources/ResourcesService.java @@ -28,7 +28,6 @@ import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; /** - * Removed since 6.3, please use api/components and api/measures instead * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/resources">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -39,7 +38,6 @@ public class ResourcesService extends BaseService { } /** - * The web service is removed and you're invited to use the alternatives: <ul><li>if you need one component without measures: api/components/show</li><li>if you need one component with measures: api/measures/component</li><li>if you need several components without measures: api/components/tree</li><li>if you need several components with measures: api/measures/component_tree</li></ul> * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/resources/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/resources/package-info.java index 4d0c676f441..e2a7482c5be 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/resources/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/resources/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.resources; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/roots/RootsService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/roots/RootsService.java index d5efc1701bf..26f99353d49 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/roots/RootsService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/roots/RootsService.java @@ -19,6 +19,7 @@ */ package org.sonarqube.ws.client.roots; +import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; @@ -28,7 +29,6 @@ import org.sonarqube.ws.client.WsConnector; import org.sonarqube.ws.Roots.SearchResponse; /** - * Manage root users * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/roots">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -39,7 +39,6 @@ public class RootsService extends BaseService { } /** - * Search for root users.<br/>Requires to be root. * * This is part of the internal API. * This is a GET request. @@ -53,7 +52,6 @@ public class RootsService extends BaseService { } /** - * Make the specified user root.<br/>Requires to be root. * * This is part of the internal API. * This is a POST request. @@ -69,7 +67,6 @@ public class RootsService extends BaseService { } /** - * Make the specified user not root.<br/>Requires to be root. * * This is part of the internal API. * This is a POST request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/roots/SetRootRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/roots/SetRootRequest.java index a69170ae3ac..7b149b9424a 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/roots/SetRootRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/roots/SetRootRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.roots; +import java.util.List; import javax.annotation.Generated; /** - * Make the specified user root.<br/>Requires to be root. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/roots/set_root">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class SetRootRequest { private String login; /** - * A user login - * * This is a mandatory parameter. * Example value: "admin" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/roots/UnsetRootRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/roots/UnsetRootRequest.java index 580dd0bccd3..b953f8c202d 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/roots/UnsetRootRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/roots/UnsetRootRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.roots; +import java.util.List; import javax.annotation.Generated; /** - * Make the specified user not root.<br/>Requires to be root. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/roots/unset_root">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class UnsetRootRequest { private String login; /** - * A user login - * * This is a mandatory parameter. * Example value: "admin" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/roots/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/roots/package-info.java index 58675691a02..a81faa55198 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/roots/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/roots/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.roots; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/AppRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/AppRequest.java index d34a53751f2..b1a12bbfaff 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/AppRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/AppRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.rules; +import java.util.List; import javax.annotation.Generated; /** - * Get data required for rendering the page 'Coding Rules'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/rules/app">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class AppRequest { private String organization; /** - * Organization key - * * This is part of the internal API. * Example value: "my-org" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/CreateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/CreateRequest.java index 0f642e23769..6e352ed48bf 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/CreateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/CreateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.rules; +import java.util.List; import javax.annotation.Generated; /** - * Create a custom rule.<br>Requires the 'Administer Quality Profiles' permission - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/rules/create">Further information about this action online (including a response example)</a> @@ -36,7 +35,7 @@ public class CreateRequest { private String manualKey; private String markdownDescription; private String name; - private String params; + private List<String> params; private String preventReactivation; private String severity; private String status; @@ -44,8 +43,6 @@ public class CreateRequest { private String type; /** - * Key of the custom rule - * * This is a mandatory parameter. * Example value: "Todo_should_not_be_used" */ @@ -59,8 +56,6 @@ public class CreateRequest { } /** - * Manual rules are no more supported. This parameter is ignored - * * Example value: "Error_handling" * @deprecated since 5.5 */ @@ -75,8 +70,6 @@ public class CreateRequest { } /** - * Rule description - * * This is a mandatory parameter. * Example value: "Description of my custom rule" */ @@ -90,8 +83,6 @@ public class CreateRequest { } /** - * Rule name - * * This is a mandatory parameter. * Example value: "My custom rule" */ @@ -105,21 +96,17 @@ public class CreateRequest { } /** - * Parameters as semi-colon list of <key>=<value>, for example 'params=key1=v1;key2=v2' (Only for custom rule) - * */ - public CreateRequest setParams(String params) { + public CreateRequest setParams(List<String> params) { this.params = params; return this; } - public String getParams() { + public List<String> getParams() { return params; } /** - * If set to true and if the rule has been deactivated (status 'REMOVED'), a status 409 will be returned - * * Possible values: * <ul> * <li>"true"</li> @@ -138,8 +125,6 @@ public class CreateRequest { } /** - * Rule severity - * * Possible values: * <ul> * <li>"INFO"</li> @@ -159,8 +144,6 @@ public class CreateRequest { } /** - * Rule status - * * Possible values: * <ul> * <li>"BETA"</li> @@ -179,8 +162,6 @@ public class CreateRequest { } /** - * Key of the template rule in order to create a custom rule (mandatory for custom rule) - * * Example value: "java:XPath" */ public CreateRequest setTemplateKey(String templateKey) { @@ -193,8 +174,6 @@ public class CreateRequest { } /** - * Rule type - * * Possible values: * <ul> * <li>"CODE_SMELL"</li> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/DeleteRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/DeleteRequest.java index 8ab35b8a0b9..fc7ad2c892e 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/DeleteRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/DeleteRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.rules; +import java.util.List; import javax.annotation.Generated; /** - * Delete custom rule.<br/>Requires the 'Administer Quality Profiles' permission - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/rules/delete">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class DeleteRequest { private String key; /** - * Rule key - * * This is a mandatory parameter. * Example value: "squid:XPath_1402065390816" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/RepositoriesRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/RepositoriesRequest.java index 8b2e6fbe166..1beb21f8b1e 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/RepositoriesRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/RepositoriesRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.rules; +import java.util.List; import javax.annotation.Generated; /** - * List available rule repositories - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/rules/repositories">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class RepositoriesRequest { private String q; /** - * A language key; if provided, only repositories for the given language will be returned - * * Example value: "java" */ public RepositoriesRequest setLanguage(String language) { @@ -50,8 +47,6 @@ public class RepositoriesRequest { } /** - * A pattern to match repository keys/names against - * * Example value: "squid" */ public RepositoriesRequest setQ(String q) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/RulesService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/RulesService.java index b1ce42cf0cb..988e32ac816 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/RulesService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/RulesService.java @@ -33,7 +33,6 @@ import org.sonarqube.ws.Rules.ShowResponse; import org.sonarqube.ws.Rules.UpdateResponse; /** - * Get and update some details of automatic rules, and manage custom rules. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/rules">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -44,7 +43,6 @@ public class RulesService extends BaseService { } /** - * Get data required for rendering the page 'Coding Rules'. * * This is part of the internal API. * This is a GET request. @@ -60,7 +58,6 @@ public class RulesService extends BaseService { } /** - * Create a custom rule.<br>Requires the 'Administer Quality Profiles' permission * * This is part of the internal API. * This is a POST request. @@ -74,7 +71,7 @@ public class RulesService extends BaseService { .setParam("manual_key", request.getManualKey()) .setParam("markdown_description", request.getMarkdownDescription()) .setParam("name", request.getName()) - .setParam("params", request.getParams()) + .setParam("params", request.getParams() == null ? null : request.getParams().stream().collect(Collectors.joining(","))) .setParam("prevent_reactivation", request.getPreventReactivation()) .setParam("severity", request.getSeverity()) .setParam("status", request.getStatus()) @@ -84,7 +81,6 @@ public class RulesService extends BaseService { } /** - * Delete custom rule.<br/>Requires the 'Administer Quality Profiles' permission * * This is part of the internal API. * This is a POST request. @@ -100,7 +96,6 @@ public class RulesService extends BaseService { } /** - * List rules, excluding the manual rules and the rules with status REMOVED. JSON format is not supported for response. * * This is part of the internal API. * This is a GET request. @@ -114,7 +109,6 @@ public class RulesService extends BaseService { } /** - * List available rule repositories * * This is part of the internal API. * This is a GET request. @@ -131,7 +125,6 @@ public class RulesService extends BaseService { } /** - * Search for a collection of relevant rules matching a specified query.<br/>Since 5.5, following fields in the response have been deprecated :<ul><li>"effortToFixDescription" becomes "gapDescription"</li><li>"debtRemFnCoeff" becomes "remFnGapMultiplier"</li><li>"defaultDebtRemFnCoeff" becomes "defaultRemFnGapMultiplier"</li><li>"debtRemFnOffset" becomes "remFnBaseEffort"</li><li>"defaultDebtRemFnOffset" becomes "defaultRemFnBaseEffort"</li><li>"debtOverloaded" becomes "remFnOverloaded"</li></ul> * * This is part of the internal API. * This is a GET request. @@ -168,7 +161,6 @@ public class RulesService extends BaseService { } /** - * Get detailed information about a rule<br>Since 5.5, following fields in the response have been deprecated :<ul><li>"effortToFixDescription" becomes "gapDescription"</li><li>"debtRemFnCoeff" becomes "remFnGapMultiplier"</li><li>"defaultDebtRemFnCoeff" becomes "defaultRemFnGapMultiplier"</li><li>"debtRemFnOffset" becomes "remFnBaseEffort"</li><li>"defaultDebtRemFnOffset" becomes "defaultRemFnBaseEffort"</li><li>"debtOverloaded" becomes "remFnOverloaded"</li></ul> * * This is part of the internal API. * This is a GET request. @@ -185,7 +177,6 @@ public class RulesService extends BaseService { } /** - * List rule tags * * This is part of the internal API. * This is a GET request. @@ -203,7 +194,6 @@ public class RulesService extends BaseService { } /** - * Update an existing rule.<br>Requires the 'Administer Quality Profiles' permission * * This is part of the internal API. * This is a POST request. @@ -222,7 +212,7 @@ public class RulesService extends BaseService { .setParam("markdown_note", request.getMarkdownNote()) .setParam("name", request.getName()) .setParam("organization", request.getOrganization()) - .setParam("params", request.getParams()) + .setParam("params", request.getParams() == null ? null : request.getParams().stream().collect(Collectors.joining(","))) .setParam("remediation_fn_base_effort", request.getRemediationFnBaseEffort()) .setParam("remediation_fn_type", request.getRemediationFnType()) .setParam("remediation_fy_gap_multiplier", request.getRemediationFyGapMultiplier()) diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/SearchRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/SearchRequest.java index c5e39c9edf4..90ab5e1d75a 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/SearchRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/SearchRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Search for a collection of relevant rules matching a specified query.<br/>Since 5.5, following fields in the response have been deprecated :<ul><li>"effortToFixDescription" becomes "gapDescription"</li><li>"debtRemFnCoeff" becomes "remFnGapMultiplier"</li><li>"defaultDebtRemFnCoeff" becomes "defaultRemFnGapMultiplier"</li><li>"debtRemFnOffset" becomes "remFnBaseEffort"</li><li>"defaultDebtRemFnOffset" becomes "defaultRemFnBaseEffort"</li><li>"debtOverloaded" becomes "remFnOverloaded"</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/rules/search">Further information about this action online (including a response example)</a> @@ -58,8 +56,6 @@ public class SearchRequest { private List<String> types; /** - * Filter rules that are activated or deactivated on the selected Quality profile. Ignored if the parameter 'qprofile' is not set. - * * Possible values: * <ul> * <li>"true"</li> @@ -78,8 +74,6 @@ public class SearchRequest { } /** - * Comma-separated list of activation severities, i.e the severity of rules in Quality profiles. - * * Example value: "CRITICAL,BLOCKER" * Possible values: * <ul> @@ -100,8 +94,6 @@ public class SearchRequest { } /** - * Ascending sort - * * Possible values: * <ul> * <li>"true"</li> @@ -120,8 +112,6 @@ public class SearchRequest { } /** - * Filters rules added since date. Format is yyyy-MM-dd - * * Example value: "2014-06-22" */ public SearchRequest setAvailableSince(String availableSince) { @@ -134,8 +124,6 @@ public class SearchRequest { } /** - * Quality profile key to filter rules that are activated. Meant to compare easily to profile set in 'qprofile' - * * This is part of the internal API. * Example value: "AU-TpxcA-iU5OvuD2FLz" */ @@ -149,8 +137,6 @@ public class SearchRequest { } /** - * Comma-separated list of the fields to be returned in response. All the fields are returned by default, except actives.Since 5.5, following fields have been deprecated :<ul><li>"defaultDebtRemFn" becomes "defaultRemFn"</li><li>"debtRemFn" becomes "remFn"</li><li>"effortToFixDescription" becomes "gapDescription"</li><li>"debtOverloaded" becomes "remFnOverloaded"</li></ul> - * * Example value: "repo,name" * Possible values: * <ul> @@ -193,8 +179,6 @@ public class SearchRequest { } /** - * Comma-separated list of the facets to be computed. No facet is computed by default. - * * Example value: "languages,repositories" * Possible values: * <ul> @@ -218,8 +202,6 @@ public class SearchRequest { } /** - * Comma-separated list of values of inheritance for a rule within a quality profile. Used only if the parameter 'activation' is set. - * * Example value: "INHERITED,OVERRIDES" * Possible values: * <ul> @@ -238,8 +220,6 @@ public class SearchRequest { } /** - * Filter template rules - * * Possible values: * <ul> * <li>"true"</li> @@ -258,8 +238,6 @@ public class SearchRequest { } /** - * Comma-separated list of languages - * * Example value: "java,js" */ public SearchRequest setLanguages(List<String> languages) { @@ -272,8 +250,6 @@ public class SearchRequest { } /** - * Organization key - * * This is part of the internal API. * Example value: "my-org" */ @@ -287,8 +263,6 @@ public class SearchRequest { } /** - * 1-based page number - * * Example value: "42" */ public SearchRequest setP(String p) { @@ -301,8 +275,6 @@ public class SearchRequest { } /** - * Page size. Must be greater than 0 and less than 500 - * * Example value: "20" */ public SearchRequest setPs(String ps) { @@ -315,8 +287,6 @@ public class SearchRequest { } /** - * UTF-8 search query - * * Example value: "xpath" */ public SearchRequest setQ(String q) { @@ -329,8 +299,6 @@ public class SearchRequest { } /** - * Quality profile key to filter on. Used only if the parameter 'activation' is set. - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public SearchRequest setQprofile(String qprofile) { @@ -343,8 +311,6 @@ public class SearchRequest { } /** - * Comma-separated list of repositories - * * Example value: "checkstyle,findbugs" */ public SearchRequest setRepositories(List<String> repositories) { @@ -357,8 +323,6 @@ public class SearchRequest { } /** - * Key of rule to search for - * * Example value: "squid:S001" */ public SearchRequest setRuleKey(String ruleKey) { @@ -371,8 +335,6 @@ public class SearchRequest { } /** - * Sort field - * * Example value: "name" * Possible values: * <ul> @@ -392,8 +354,6 @@ public class SearchRequest { } /** - * Comma-separated list of default severities. Not the same than severity of rules in Quality profiles. - * * Example value: "CRITICAL,BLOCKER" * Possible values: * <ul> @@ -414,8 +374,6 @@ public class SearchRequest { } /** - * Comma-separated list of status codes - * * Example value: "READY" * Possible values: * <ul> @@ -435,8 +393,6 @@ public class SearchRequest { } /** - * Comma-separated list of tags. Returned rules match any of the tags (OR operator) - * * Example value: "security,java8" */ public SearchRequest setTags(List<String> tags) { @@ -449,8 +405,6 @@ public class SearchRequest { } /** - * Key of the template rule to filter on. Used to search for the custom rules based on this template. - * * Example value: "java:S001" */ public SearchRequest setTemplateKey(String templateKey) { @@ -463,8 +417,6 @@ public class SearchRequest { } /** - * Comma-separated list of types. Returned rules match any of the tags (OR operator) - * * Example value: "BUG" * Possible values: * <ul> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/ShowRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/ShowRequest.java index 83b7caddf6d..3116a164b3c 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/ShowRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/ShowRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.rules; +import java.util.List; import javax.annotation.Generated; /** - * Get detailed information about a rule<br>Since 5.5, following fields in the response have been deprecated :<ul><li>"effortToFixDescription" becomes "gapDescription"</li><li>"debtRemFnCoeff" becomes "remFnGapMultiplier"</li><li>"defaultDebtRemFnCoeff" becomes "defaultRemFnGapMultiplier"</li><li>"debtRemFnOffset" becomes "remFnBaseEffort"</li><li>"defaultDebtRemFnOffset" becomes "defaultRemFnBaseEffort"</li><li>"debtOverloaded" becomes "remFnOverloaded"</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/rules/show">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class ShowRequest { private String organization; /** - * Show rule's activations for all profiles ("active rules") - * * Possible values: * <ul> * <li>"true"</li> @@ -57,8 +54,6 @@ public class ShowRequest { } /** - * Rule key - * * This is a mandatory parameter. * Example value: "javascript:EmptyBlock" */ @@ -72,8 +67,6 @@ public class ShowRequest { } /** - * Organization key - * * This is part of the internal API. * Example value: "my-org" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/TagsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/TagsRequest.java index c2fd9469a68..fef80b807d2 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/TagsRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/TagsRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.rules; +import java.util.List; import javax.annotation.Generated; /** - * List rule tags - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/rules/tags">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class TagsRequest { private String q; /** - * Organization key - * * This is part of the internal API. * Example value: "my-org" */ @@ -52,8 +49,6 @@ public class TagsRequest { } /** - * Page size. Must be greater than 0 and less than 100 - * * Example value: "20" */ public TagsRequest setPs(String ps) { @@ -66,8 +61,6 @@ public class TagsRequest { } /** - * Limit search to tags that contain the supplied string. - * * Example value: "misra" */ public TagsRequest setQ(String q) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/UpdateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/UpdateRequest.java index 1da7042a4b4..bfdf94e1d5b 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/UpdateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/UpdateRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Update an existing rule.<br>Requires the 'Administer Quality Profiles' permission - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/rules/update">Further information about this action online (including a response example)</a> @@ -42,7 +40,7 @@ public class UpdateRequest { private String markdownNote; private String name; private String organization; - private String params; + private List<String> params; private String remediationFnBaseEffort; private String remediationFnType; private String remediationFyGapMultiplier; @@ -96,8 +94,6 @@ public class UpdateRequest { } /** - * Debt characteristics are no more supported. This parameter is ignored. - * * @deprecated since 5.5 */ @Deprecated @@ -111,8 +107,6 @@ public class UpdateRequest { } /** - * Key of the rule to update - * * This is a mandatory parameter. * Example value: "javascript:NullCheck" */ @@ -126,8 +120,6 @@ public class UpdateRequest { } /** - * Rule description (mandatory for custom rule and manual rule) - * * Example value: "Description of my custom rule" */ public UpdateRequest setMarkdownDescription(String markdownDescription) { @@ -140,8 +132,6 @@ public class UpdateRequest { } /** - * Optional note in markdown format. Use empty value to remove current note. Note is not changedif the parameter is not set. - * * Example value: "my *note*" */ public UpdateRequest setMarkdownNote(String markdownNote) { @@ -154,8 +144,6 @@ public class UpdateRequest { } /** - * Rule name (mandatory for custom rule) - * * Example value: "My custom rule" */ public UpdateRequest setName(String name) { @@ -168,8 +156,6 @@ public class UpdateRequest { } /** - * Organization key - * * This is part of the internal API. * Example value: "my-org" */ @@ -183,21 +169,17 @@ public class UpdateRequest { } /** - * Parameters as semi-colon list of <key>=<value>, for example 'params=key1=v1;key2=v2' (Only when updating a custom rule) - * */ - public UpdateRequest setParams(String params) { + public UpdateRequest setParams(List<String> params) { this.params = params; return this; } - public String getParams() { + public List<String> getParams() { return params; } /** - * Base effort of the remediation function of the rule - * * Example value: "1d" */ public UpdateRequest setRemediationFnBaseEffort(String remediationFnBaseEffort) { @@ -210,8 +192,6 @@ public class UpdateRequest { } /** - * Type of the remediation function of the rule - * * Possible values: * <ul> * <li>"LINEAR"</li> @@ -229,8 +209,6 @@ public class UpdateRequest { } /** - * Gap multiplier of the remediation function of the rule - * * Example value: "3min" */ public UpdateRequest setRemediationFyGapMultiplier(String remediationFyGapMultiplier) { @@ -243,8 +221,6 @@ public class UpdateRequest { } /** - * Rule severity (Only when updating a custom rule) - * * Possible values: * <ul> * <li>"INFO"</li> @@ -264,8 +240,6 @@ public class UpdateRequest { } /** - * Rule status (Only when updating a custom rule) - * * Possible values: * <ul> * <li>"BETA"</li> @@ -284,8 +258,6 @@ public class UpdateRequest { } /** - * Optional comma-separated list of tags to set. Use blank value to remove current tags. Tags are not changed if the parameter is not set. - * * Example value: "java8,security" */ public UpdateRequest setTags(List<String> tags) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/package-info.java index 350942a959c..b2a323b2a17 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/rules/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.rules; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/server/ServerService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/server/ServerService.java index 79d66460e8e..40e6204401a 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/server/ServerService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/server/ServerService.java @@ -28,7 +28,6 @@ import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; /** - * $webService.description.asString * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/server">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -39,7 +38,6 @@ public class ServerService extends BaseService { } /** - * Version of SonarQube in plain text * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/server/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/server/package-info.java index 8e64aaefb0f..38616829796 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/server/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/server/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.server; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/EncryptRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/EncryptRequest.java index 6777e93df8f..f5087abe684 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/EncryptRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/EncryptRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.settings; +import java.util.List; import javax.annotation.Generated; /** - * Encrypt a setting value.<br>Requires 'Administer System' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/settings/encrypt">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class EncryptRequest { private String value; /** - * Setting value to encrypt - * * This is a mandatory parameter. * Example value: "my value" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/ListDefinitionsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/ListDefinitionsRequest.java index 3b7215008be..79051501771 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/ListDefinitionsRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/ListDefinitionsRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.settings; +import java.util.List; import javax.annotation.Generated; /** - * List settings definitions.<br>Requires 'Browse' permission when a component is specified<br/> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/settings/list_definitions">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class ListDefinitionsRequest { private String component; /** - * Branch key. Only available on following settings : sonar.leak.period - * * This is part of the internal API. * Example value: "feature/my_branch" */ @@ -51,8 +48,6 @@ public class ListDefinitionsRequest { } /** - * Component key - * * Example value: "my_project" */ public ListDefinitionsRequest setComponent(String component) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/ResetRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/ResetRequest.java index 24c14703acb..1de5f62b167 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/ResetRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/ResetRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Remove a setting value.<br>Requires one of the following permissions: <ul><li>'Administer System'</li><li>'Administer' rights on the specified component</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/settings/reset">Further information about this action online (including a response example)</a> @@ -38,8 +36,6 @@ public class ResetRequest { private List<String> keys; /** - * Branch key - * * This is part of the internal API. * Example value: "feature/my_branch" */ @@ -53,8 +49,6 @@ public class ResetRequest { } /** - * Component key - * * Example value: "my_project" */ public ResetRequest setComponent(String component) { @@ -67,8 +61,6 @@ public class ResetRequest { } /** - * Comma-separated list of keys - * * This is a mandatory parameter. * Example value: "sonar.links.scm,sonar.debt.hoursInDay" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/SetRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/SetRequest.java index f230b401b07..bb00cacfa67 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/SetRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/SetRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Update a setting value.<br>Either 'value' or 'values' must be provided.<br> Requires one of the following permissions: <ul><li>'Administer System'</li><li>'Administer' rights on the specified component</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/settings/set">Further information about this action online (including a response example)</a> @@ -41,8 +39,6 @@ public class SetRequest { private List<String> values; /** - * Branch key. Only available on following settings : sonar.leak.period - * * This is part of the internal API. * Example value: "feature/my_branch" */ @@ -56,8 +52,6 @@ public class SetRequest { } /** - * Component key - * * Example value: "my_project" */ public SetRequest setComponent(String component) { @@ -70,8 +64,6 @@ public class SetRequest { } /** - * Setting field values. To set several values, the parameter must be called once for each value. - * * Example value: "fieldValues={\"firstField\":\"first value\", \"secondField\":\"second value\", \"thirdField\":\"third value\"}" */ public SetRequest setFieldValues(List<String> fieldValues) { @@ -84,8 +76,6 @@ public class SetRequest { } /** - * Setting key - * * This is a mandatory parameter. * Example value: "sonar.links.scm" */ @@ -99,8 +89,6 @@ public class SetRequest { } /** - * Setting value. To reset a value, please use the reset web service. - * * Example value: "git@github.com:SonarSource/sonarqube.git" */ public SetRequest setValue(String value) { @@ -113,8 +101,6 @@ public class SetRequest { } /** - * Setting multi value. To set several values, the parameter must be called once for each value. - * * Example value: "values=firstValue&values=secondValue&values=thirdValue" */ public SetRequest setValues(List<String> values) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/SettingsService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/SettingsService.java index 6be18837145..a353e7dfb2f 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/SettingsService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/SettingsService.java @@ -22,18 +22,17 @@ package org.sonarqube.ws.client.settings; import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; +import org.sonarqube.ws.client.BaseService; +import org.sonarqube.ws.client.GetRequest; +import org.sonarqube.ws.client.PostRequest; +import org.sonarqube.ws.client.WsConnector; import org.sonarqube.ws.Settings.CheckSecretKeyWsResponse; import org.sonarqube.ws.Settings.EncryptWsResponse; import org.sonarqube.ws.Settings.GenerateSecretKeyWsResponse; import org.sonarqube.ws.Settings.ListDefinitionsWsResponse; import org.sonarqube.ws.Settings.ValuesWsResponse; -import org.sonarqube.ws.client.BaseService; -import org.sonarqube.ws.client.GetRequest; -import org.sonarqube.ws.client.PostRequest; -import org.sonarqube.ws.client.WsConnector; /** - * Manage settings. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/settings">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -44,7 +43,6 @@ public class SettingsService extends BaseService { } /** - * Check if a secret key is available.<br>Requires the 'Administer System' permission. * * This is part of the internal API. * This is a GET request. @@ -58,7 +56,6 @@ public class SettingsService extends BaseService { } /** - * Encrypt a setting value.<br>Requires 'Administer System' permission. * * This is part of the internal API. * This is a GET request. @@ -73,7 +70,6 @@ public class SettingsService extends BaseService { } /** - * Generate a secret key.<br>Requires the 'Administer System' permission * * This is part of the internal API. * This is a GET request. @@ -87,7 +83,6 @@ public class SettingsService extends BaseService { } /** - * List settings definitions.<br>Requires 'Browse' permission when a component is specified<br/> * * This is part of the internal API. * This is a GET request. @@ -103,7 +98,6 @@ public class SettingsService extends BaseService { } /** - * Remove a setting value.<br>Requires one of the following permissions: <ul><li>'Administer System'</li><li>'Administer' rights on the specified component</li></ul> * * This is part of the internal API. * This is a POST request. @@ -121,7 +115,6 @@ public class SettingsService extends BaseService { } /** - * Update a setting value.<br>Either 'value' or 'values' must be provided.<br> Requires one of the following permissions: <ul><li>'Administer System'</li><li>'Administer' rights on the specified component</li></ul> * * This is part of the internal API. * This is a POST request. @@ -142,7 +135,6 @@ public class SettingsService extends BaseService { } /** - * List settings values.<br>If no value has been set for a setting, then the default value is returned.<br>Requires 'Browse' permission when a component is specified<br/> * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/ValuesRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/ValuesRequest.java index 3ec6fa952a5..ae508f0a37e 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/ValuesRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/ValuesRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * List settings values.<br>If no value has been set for a setting, then the default value is returned.<br>Requires 'Browse' permission when a component is specified<br/> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/settings/values">Further information about this action online (including a response example)</a> @@ -38,8 +36,6 @@ public class ValuesRequest { private List<String> keys; /** - * Branch key - * * This is part of the internal API. * Example value: "feature/my_branch" */ @@ -53,8 +49,6 @@ public class ValuesRequest { } /** - * Component key - * * Example value: "my_project" */ public ValuesRequest setComponent(String component) { @@ -67,8 +61,6 @@ public class ValuesRequest { } /** - * List of setting keys - * * Example value: "sonar.test.inclusions,sonar.dbcleaner.cleanDirectory" */ public ValuesRequest setKeys(List<String> keys) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/package-info.java index 09aad91956c..711ae204b6a 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/settings/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.settings; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/HashRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/HashRequest.java index 4055ddb3b6d..d063024404d 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/HashRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/HashRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.sources; +import java.util.List; import javax.annotation.Generated; /** - * Show line line hashes for a given file. Require See Source Code permission on file's project<br/> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/sources/hash">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class HashRequest { private String key; /** - * File key - * * This is a mandatory parameter. * Example value: "my_project:/src/foo/Bar.php" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/IndexRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/IndexRequest.java index 9c19e1ce9cc..f04b783f212 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/IndexRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/IndexRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.sources; +import java.util.List; import javax.annotation.Generated; /** - * Get source code as line number / text pairs. Require See Source Code permission on file - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/sources/index">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class IndexRequest { private String to; /** - * First line - * */ public IndexRequest setFrom(String from) { this.from = from; @@ -50,8 +47,6 @@ public class IndexRequest { } /** - * File key - * * This is a mandatory parameter. * Example value: "my_project:/src/foo/Bar.php" */ @@ -65,8 +60,6 @@ public class IndexRequest { } /** - * Last line (excluded). If not specified, all lines are returned until end of file - * */ public IndexRequest setTo(String to) { this.to = to; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/LinesRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/LinesRequest.java index e18c68e274c..792c6ba3bdd 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/LinesRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/LinesRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.sources; +import java.util.List; import javax.annotation.Generated; /** - * Show source code with line oriented info. Require See Source Code permission on file's project<br/>Each element of the result array is an object which contains:<ol><li>Line number</li><li>Content of the line</li><li>Author of the line (from SCM information)</li><li>Revision of the line (from SCM information)</li><li>Last commit date of the line (from SCM information)</li><li>Line hits from coverage</li><li>Number of conditions to cover in tests</li><li>Number of conditions covered by tests</li></ol> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/sources/lines">Further information about this action online (including a response example)</a> @@ -39,8 +38,6 @@ public class LinesRequest { private String uuid; /** - * Branch key - * * This is part of the internal API. * Example value: "feature/my_branch" */ @@ -54,8 +51,6 @@ public class LinesRequest { } /** - * First line to return. Starts from 1 - * * Example value: "10" */ public LinesRequest setFrom(String from) { @@ -68,8 +63,6 @@ public class LinesRequest { } /** - * File key. Mandatory if param 'uuid' is not set. Available since 5.2 - * * Example value: "my_project:/src/foo/Bar.php" */ public LinesRequest setKey(String key) { @@ -82,8 +75,6 @@ public class LinesRequest { } /** - * Optional last line to return (inclusive). It must be greater than or equal to parameter 'from'. If unset, then all the lines greater than or equal to 'from' are returned. - * * Example value: "20" */ public LinesRequest setTo(String to) { @@ -96,8 +87,6 @@ public class LinesRequest { } /** - * File uuid. Mandatory if param 'key' is not set - * * Example value: "f333aab4-7e3a-4d70-87e1-f4c491f05e5c" */ public LinesRequest setUuid(String uuid) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/RawRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/RawRequest.java index 384cc2d1412..3788b6206f6 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/RawRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/RawRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.sources; +import java.util.List; import javax.annotation.Generated; /** - * Get source code as raw text. Require 'See Source Code' permission on file - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/sources/raw">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class RawRequest { private String key; /** - * Branch key - * * This is part of the internal API. * Example value: "feature/my_branch" */ @@ -51,8 +48,6 @@ public class RawRequest { } /** - * File key - * * This is a mandatory parameter. * Example value: "my_project:src/foo/Bar.php" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/ScmRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/ScmRequest.java index 58bc1ddeb68..ac650b53c07 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/ScmRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/ScmRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.sources; +import java.util.List; import javax.annotation.Generated; /** - * Get SCM information of source files. Require See Source Code permission on file's project<br/>Each element of the result array is composed of:<ol><li>Line number</li><li>Author of the commit</li><li>Datetime of the commit (before 5.2 it was only the Date)</li><li>Revision of the commit (added in 5.2)</li></ol> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/sources/scm">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class ScmRequest { private String to; /** - * Group lines by SCM commit if value is false, else display commits for each line, even if two consecutive lines relate to the same commit. - * * Possible values: * <ul> * <li>"true"</li> @@ -58,8 +55,6 @@ public class ScmRequest { } /** - * First line to return. Starts at 1 - * * Example value: "10" */ public ScmRequest setFrom(String from) { @@ -72,8 +67,6 @@ public class ScmRequest { } /** - * File key - * * This is a mandatory parameter. * Example value: "my_project:/src/foo/Bar.php" */ @@ -87,8 +80,6 @@ public class ScmRequest { } /** - * Last line to return (inclusive) - * * Example value: "20" */ public ScmRequest setTo(String to) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/ShowRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/ShowRequest.java index d8f3950134d..4257dc3b798 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/ShowRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/ShowRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.sources; +import java.util.List; import javax.annotation.Generated; /** - * Get source code. Require See Source Code permission on file's project<br/>Each element of the result array is composed of:<ol><li>Line number</li><li>Content of the line</li></ol> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/sources/show">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class ShowRequest { private String to; /** - * First line to return. Starts at 1 - * * Example value: "10" */ public ShowRequest setFrom(String from) { @@ -51,8 +48,6 @@ public class ShowRequest { } /** - * File key - * * This is a mandatory parameter. * Example value: "my_project:/src/foo/Bar.php" */ @@ -66,8 +61,6 @@ public class ShowRequest { } /** - * Last line to return (inclusive) - * * Example value: "20" */ public ShowRequest setTo(String to) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/SourcesService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/SourcesService.java index d7545c9d9ee..5bca94b5e54 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/SourcesService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/SourcesService.java @@ -19,14 +19,15 @@ */ package org.sonarqube.ws.client.sources; +import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; import org.sonarqube.ws.client.GetRequest; +import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; /** - * Get details on source files. See also api/tests. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/sources">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -37,7 +38,6 @@ public class SourcesService extends BaseService { } /** - * Show line line hashes for a given file. Require See Source Code permission on file's project<br/> * * This is part of the internal API. * This is a GET request. @@ -53,7 +53,6 @@ public class SourcesService extends BaseService { } /** - * Get source code as line number / text pairs. Require See Source Code permission on file * * This is part of the internal API. * This is a GET request. @@ -71,7 +70,6 @@ public class SourcesService extends BaseService { } /** - * Show source code with line oriented info. Require See Source Code permission on file's project<br/>Each element of the result array is an object which contains:<ol><li>Line number</li><li>Content of the line</li><li>Author of the line (from SCM information)</li><li>Revision of the line (from SCM information)</li><li>Last commit date of the line (from SCM information)</li><li>Line hits from coverage</li><li>Number of conditions to cover in tests</li><li>Number of conditions covered by tests</li></ol> * * This is part of the internal API. * This is a GET request. @@ -91,7 +89,6 @@ public class SourcesService extends BaseService { } /** - * Get source code as raw text. Require 'See Source Code' permission on file * * This is part of the internal API. * This is a GET request. @@ -108,7 +105,6 @@ public class SourcesService extends BaseService { } /** - * Get SCM information of source files. Require See Source Code permission on file's project<br/>Each element of the result array is composed of:<ol><li>Line number</li><li>Author of the commit</li><li>Datetime of the commit (before 5.2 it was only the Date)</li><li>Revision of the commit (added in 5.2)</li></ol> * * This is part of the internal API. * This is a GET request. @@ -127,7 +123,6 @@ public class SourcesService extends BaseService { } /** - * Get source code. Require See Source Code permission on file's project<br/>Each element of the result array is composed of:<ol><li>Line number</li><li>Content of the line</li></ol> * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/package-info.java index 06a8b91a35a..2e79988f25d 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/sources/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.sources; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/system/ChangeLogLevelRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/system/ChangeLogLevelRequest.java index 0f7e71b9573..2d456258cdb 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/system/ChangeLogLevelRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/system/ChangeLogLevelRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.system; +import java.util.List; import javax.annotation.Generated; /** - * Temporarily changes level of logs. New level is not persistent and is lost when restarting server. Requires system administration permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/system/change_log_level">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class ChangeLogLevelRequest { private String level; /** - * The new level. Be cautious: DEBUG, and even more TRACE, may have performance impacts. - * * This is a mandatory parameter. * Possible values: * <ul> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/system/LogsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/system/LogsRequest.java index 42544c1b783..323649d565e 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/system/LogsRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/system/LogsRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.system; +import java.util.List; import javax.annotation.Generated; /** - * Get system logs in plain-text format. Requires system administration permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/system/logs">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class LogsRequest { private String process; /** - * Process to get logs from - * * Possible values: * <ul> * <li>"app"</li> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/system/SystemService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/system/SystemService.java index 6c970de9ba2..1c7e2b34c21 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/system/SystemService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/system/SystemService.java @@ -19,6 +19,7 @@ */ package org.sonarqube.ws.client.system; +import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; @@ -29,7 +30,6 @@ import org.sonarqube.ws.System.HealthResponse; import org.sonarqube.ws.System.StatusResponse; /** - * Get system details, and perform some management actions, such as restarting, and initiating a database migration (as part of a system upgrade). * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/system">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -40,7 +40,6 @@ public class SystemService extends BaseService { } /** - * Temporarily changes level of logs. New level is not persistent and is lost when restarting server. Requires system administration permission. * * This is part of the internal API. * This is a POST request. @@ -56,7 +55,6 @@ public class SystemService extends BaseService { } /** - * Display the database migration status of SonarQube.<br/>State values are:<ul><li>NO_MIGRATION: DB is up to date with current version of SonarQube.</li><li>NOT_SUPPORTED: Migration is not supported on embedded databases.</li><li>MIGRATION_RUNNING: DB migration is under go.</li><li>MIGRATION_SUCCEEDED: DB migration has run and has been successful.</li><li>MIGRATION_FAILED: DB migration has run and failed. SonarQube must be restarted in order to retry a DB migration (optionally after DB has been restored from backup).</li><li>MIGRATION_REQUIRED: DB migration is required.</li></ul> * * This is part of the internal API. * This is a GET request. @@ -71,7 +69,6 @@ public class SystemService extends BaseService { } /** - * Provide health status of SonarQube.<p>Require 'Administer System' permission or authentication with passcode</p><p> <ul> <li>GREEN: SonarQube is fully operational</li> <li>YELLOW: SonarQube is usable, but it needs attention in order to be fully operational</li> <li>RED: SonarQube is not operational</li> </ul></p> * * This is part of the internal API. * This is a GET request. @@ -85,7 +82,6 @@ public class SystemService extends BaseService { } /** - * Get detailed information about system configuration.<br/>Requires 'Administer' permissions.<br/>Since 5.5, this web service becomes internal in order to more easily update result. * * This is part of the internal API. * This is a GET request. @@ -100,7 +96,6 @@ public class SystemService extends BaseService { } /** - * Get system logs in plain-text format. Requires system administration permission. * * This is part of the internal API. * This is a GET request. @@ -116,7 +111,6 @@ public class SystemService extends BaseService { } /** - * Migrate the database to match the current version of SonarQube.<br/>Sending a POST request to this URL starts the DB migration. It is strongly advised to <strong>make a database backup</strong> before invoking this WS.<br/>State values are:<ul><li>NO_MIGRATION: DB is up to date with current version of SonarQube.</li><li>NOT_SUPPORTED: Migration is not supported on embedded databases.</li><li>MIGRATION_RUNNING: DB migration is under go.</li><li>MIGRATION_SUCCEEDED: DB migration has run and has been successful.</li><li>MIGRATION_FAILED: DB migration has run and failed. SonarQube must be restarted in order to retry a DB migration (optionally after DB has been restored from backup).</li><li>MIGRATION_REQUIRED: DB migration is required.</li></ul> * * This is part of the internal API. * This is a POST request. @@ -131,7 +125,6 @@ public class SystemService extends BaseService { } /** - * Answers "pong" as plain-text * * This is part of the internal API. * This is a GET request. @@ -146,7 +139,6 @@ public class SystemService extends BaseService { } /** - * Restart server. Require 'Administer System' permission. Perform a full restart of the Web, Search and Compute Engine Servers processes. * * This is part of the internal API. * This is a POST request. @@ -161,7 +153,6 @@ public class SystemService extends BaseService { } /** - * Get state information about SonarQube.<p>status: the running status <ul> <li>STARTING: SonarQube Web Server is up and serving some Web Services (eg. api/system/status) but initialization is still ongoing</li> <li>UP: SonarQube instance is up and running</li> <li>DOWN: SonarQube instance is up but not running because migration has failed (refer to WS /api/system/migrate_db for details) or some other reason (check logs).</li> <li>RESTARTING: SonarQube instance is still up but a restart has been requested (refer to WS /api/system/restart for details).</li> <li>DB_MIGRATION_NEEDED: database migration is required. DB migration can be started using WS /api/system/migrate_db.</li> <li>DB_MIGRATION_RUNNING: DB migration is running (refer to WS /api/system/migrate_db for details)</li> </ul></p> * * This is part of the internal API. * This is a GET request. @@ -175,7 +166,6 @@ public class SystemService extends BaseService { } /** - * Lists available upgrades for the SonarQube instance (if any) and for each one, lists incompatible plugins and plugins requiring upgrade.<br/>Plugin information is retrieved from Update Center. Date and time at which Update Center was last refreshed is provided in the response. * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/system/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/system/package-info.java index 86b11d9949b..22a637ce599 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/system/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/system/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.system; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/tests/CoveredFilesRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/tests/CoveredFilesRequest.java index 19602644ddd..121515eb21d 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/tests/CoveredFilesRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/tests/CoveredFilesRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.tests; +import java.util.List; import javax.annotation.Generated; /** - * Get the list of source files covered by a test. Require Browse permission on test file's project - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/tests/covered_files">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class CoveredFilesRequest { private String testId; /** - * 1-based page number - * * Example value: "42" */ public CoveredFilesRequest setP(String p) { @@ -51,8 +48,6 @@ public class CoveredFilesRequest { } /** - * Page size. Must be greater than 0. - * * Example value: "20" */ public CoveredFilesRequest setPs(String ps) { @@ -65,8 +60,6 @@ public class CoveredFilesRequest { } /** - * Test ID - * * This is a mandatory parameter. * Example value: "AU-Tpxb--iU5OvuD2FLy" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/tests/ListRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/tests/ListRequest.java index 80ec000656c..a058a8deba6 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/tests/ListRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/tests/ListRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.tests; +import java.util.List; import javax.annotation.Generated; /** - * Get the list of tests either in a test file or that test a given line of source code.<br /> Requires 'Browse' permission on the file's project.<br /> One (and only one) of the following combination of parameters must be provided: <ul><li>testId - get a specific test</li><li>testFileId - get the tests in a test file</li><li>testFileKey - get the tests in a test file</li><li>sourceFileId and sourceFileLineNumber - get the tests that cover a specific line of code</li><li>sourceFileKey and sourceFileLineNumber - get the tests that cover a specific line of code</li></ul> - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/tests/list">Further information about this action online (including a response example)</a> @@ -43,8 +42,6 @@ public class ListRequest { private String testId; /** - * Branch key - * * This is part of the internal API. * Example value: "feature/my_branch" */ @@ -58,8 +55,6 @@ public class ListRequest { } /** - * 1-based page number - * * Example value: "42" */ public ListRequest setP(String p) { @@ -72,8 +67,6 @@ public class ListRequest { } /** - * Page size. Must be greater than 0 and less than 500 - * * Example value: "20" */ public ListRequest setPs(String ps) { @@ -86,8 +79,6 @@ public class ListRequest { } /** - * ID of source file. Must be provided with the source file line number. - * * Example value: "AU-TpxcA-iU5OvuD2FL0" */ public ListRequest setSourceFileId(String sourceFileId) { @@ -100,8 +91,6 @@ public class ListRequest { } /** - * Key of source file. Must be provided with the source file line number. - * * Example value: "my_project:/src/foo/Bar.php" */ public ListRequest setSourceFileKey(String sourceFileKey) { @@ -114,8 +103,6 @@ public class ListRequest { } /** - * Source file line number. Must be provided with the source file ID or key. - * * Example value: "10" */ public ListRequest setSourceFileLineNumber(String sourceFileLineNumber) { @@ -128,8 +115,6 @@ public class ListRequest { } /** - * ID of test file - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public ListRequest setTestFileId(String testFileId) { @@ -142,8 +127,6 @@ public class ListRequest { } /** - * Key of test file - * * Example value: "MY_PROJECT:src/test/java/foo/BarTest.java" */ public ListRequest setTestFileKey(String testFileKey) { @@ -156,8 +139,6 @@ public class ListRequest { } /** - * ID of test - * * Example value: "AU-TpxcA-iU5OvuD2FLz" */ public ListRequest setTestId(String testId) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/tests/TestsService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/tests/TestsService.java index adcbf796e9c..4f887aeb148 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/tests/TestsService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/tests/TestsService.java @@ -19,15 +19,17 @@ */ package org.sonarqube.ws.client.tests; +import java.util.stream.Collectors; import javax.annotation.Generated; +import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; import org.sonarqube.ws.client.GetRequest; +import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; import org.sonarqube.ws.Tests.CoveredFilesResponse; import org.sonarqube.ws.Tests.ListResponse; /** - * Get details on test files. See also api/sources. Deprecated since 5.6. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/tests">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -38,7 +40,6 @@ public class TestsService extends BaseService { } /** - * Get the list of source files covered by a test. Require Browse permission on test file's project * * This is part of the internal API. * This is a GET request. @@ -57,7 +58,6 @@ public class TestsService extends BaseService { } /** - * Get the list of tests either in a test file or that test a given line of source code.<br /> Requires 'Browse' permission on the file's project.<br /> One (and only one) of the following combination of parameters must be provided: <ul><li>testId - get a specific test</li><li>testFileId - get the tests in a test file</li><li>testFileKey - get the tests in a test file</li><li>sourceFileId and sourceFileLineNumber - get the tests that cover a specific line of code</li><li>sourceFileKey and sourceFileLineNumber - get the tests that cover a specific line of code</li></ul> * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/tests/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/tests/package-info.java index 3884257898d..3a5e5f558b7 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/tests/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/tests/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.tests; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/timemachine/TimemachineService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/timemachine/TimemachineService.java index 28f2dcae33b..94cf6da7890 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/timemachine/TimemachineService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/timemachine/TimemachineService.java @@ -28,7 +28,6 @@ import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; /** - * Removed since 6.3, please use api/measures/search_history instead * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/timemachine">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -39,7 +38,6 @@ public class TimemachineService extends BaseService { } /** - * The web service is removed and you're invited to use api/measures/search_history instead * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/timemachine/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/timemachine/package-info.java index 81ff8ac0a3b..4fcbeade106 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/timemachine/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/timemachine/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.timemachine; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/updatecenter/InstalledPluginsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/updatecenter/InstalledPluginsRequest.java index c0659f4ee60..5393a1a311b 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/updatecenter/InstalledPluginsRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/updatecenter/InstalledPluginsRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.updatecenter; +import java.util.List; import javax.annotation.Generated; /** - * Get the list of all the plugins installed on the SonarQube instance - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/updatecenter/installed_plugins">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class InstalledPluginsRequest { private String format; /** - * Only json response format is available - * * Possible values: * <ul> * <li>"json"</li> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/updatecenter/UpdatecenterService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/updatecenter/UpdatecenterService.java index 3bccacf942f..8b556a40e64 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/updatecenter/UpdatecenterService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/updatecenter/UpdatecenterService.java @@ -19,6 +19,7 @@ */ package org.sonarqube.ws.client.updatecenter; +import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; @@ -27,7 +28,6 @@ import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; /** - * Get list of installed plugins * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/updatecenter">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -38,7 +38,6 @@ public class UpdatecenterService extends BaseService { } /** - * Get the list of all the plugins installed on the SonarQube instance * * This is part of the internal API. * This is a GET request. @@ -56,7 +55,6 @@ public class UpdatecenterService extends BaseService { } /** - * Upload a plugin.<br /> Requires 'Administer System' permission. * * This is part of the internal API. * This is a POST request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/updatecenter/UploadRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/updatecenter/UploadRequest.java index ee4238bc24f..431c654b33a 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/updatecenter/UploadRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/updatecenter/UploadRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.updatecenter; +import java.util.List; import javax.annotation.Generated; /** - * Upload a plugin.<br /> Requires 'Administer System' permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/updatecenter/upload">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class UploadRequest { private String file; /** - * The jar file of the plugin to install - * * This is a mandatory parameter. */ public UploadRequest setFile(String file) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/updatecenter/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/updatecenter/package-info.java index 71095e82a09..cbf0eefb741 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/updatecenter/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/updatecenter/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.updatecenter; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/AddUserRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/AddUserRequest.java index 6fb42a27830..b9256985c77 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/AddUserRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/AddUserRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.usergroups; +import java.util.List; import javax.annotation.Generated; /** - * Add a user to a group.<br />'id' or 'name' must be provided.<br />Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_groups/add_user">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class AddUserRequest { private String organization; /** - * Group id - * * Example value: "42" */ public AddUserRequest setId(String id) { @@ -52,8 +49,6 @@ public class AddUserRequest { } /** - * User login - * * Example value: "g.hopper" */ public AddUserRequest setLogin(String login) { @@ -66,8 +61,6 @@ public class AddUserRequest { } /** - * Group name - * * Example value: "sonar-administrators" */ public AddUserRequest setName(String name) { @@ -80,8 +73,6 @@ public class AddUserRequest { } /** - * Key of organization - * * This is part of the internal API. * Example value: "my-org" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/CreateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/CreateRequest.java index 92190cf7b13..f7ffe2627d9 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/CreateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/CreateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.usergroups; +import java.util.List; import javax.annotation.Generated; /** - * Create a group.<br>Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_groups/create">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class CreateRequest { private String organization; /** - * Description for the new group. A group description cannot be larger than 200 characters. - * * Example value: "Default group for new users" */ public CreateRequest setDescription(String description) { @@ -51,8 +48,6 @@ public class CreateRequest { } /** - * Name for the new group. A group name cannot be larger than 255 characters and must be unique. The value 'anyone' (whatever the case) is reserved and cannot be used. - * * This is a mandatory parameter. * Example value: "sonar-users" */ @@ -66,8 +61,6 @@ public class CreateRequest { } /** - * Key of organization. If unset then default organization is used. - * * This is part of the internal API. * Example value: "my-org" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/DeleteRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/DeleteRequest.java index a5a67ba3500..93464fc08f7 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/DeleteRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/DeleteRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.usergroups; +import java.util.List; import javax.annotation.Generated; /** - * Delete a group. The default groups cannot be deleted.<br/>'id' or 'name' must be provided.<br />Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_groups/delete">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class DeleteRequest { private String organization; /** - * Group id - * * Example value: "42" */ public DeleteRequest setId(String id) { @@ -51,8 +48,6 @@ public class DeleteRequest { } /** - * Group name - * * Example value: "sonar-administrators" */ public DeleteRequest setName(String name) { @@ -65,8 +60,6 @@ public class DeleteRequest { } /** - * Key of organization - * * This is part of the internal API. * Example value: "my-org" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/RemoveUserRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/RemoveUserRequest.java index 46e710598fe..37185ce7767 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/RemoveUserRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/RemoveUserRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.usergroups; +import java.util.List; import javax.annotation.Generated; /** - * Remove a user from a group.<br />'id' or 'name' must be provided.<br>Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_groups/remove_user">Further information about this action online (including a response example)</a> @@ -38,8 +37,6 @@ public class RemoveUserRequest { private String organization; /** - * Group id - * * Example value: "42" */ public RemoveUserRequest setId(String id) { @@ -52,8 +49,6 @@ public class RemoveUserRequest { } /** - * User login - * * Example value: "g.hopper" */ public RemoveUserRequest setLogin(String login) { @@ -66,8 +61,6 @@ public class RemoveUserRequest { } /** - * Group name - * * Example value: "sonar-administrators" */ public RemoveUserRequest setName(String name) { @@ -80,8 +73,6 @@ public class RemoveUserRequest { } /** - * Key of organization - * * This is part of the internal API. * Example value: "my-org" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/SearchRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/SearchRequest.java index 92844e21d1b..93c85682383 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/SearchRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/SearchRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Search for user groups.<br>Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_groups/search">Further information about this action online (including a response example)</a> @@ -40,8 +38,6 @@ public class SearchRequest { private String q; /** - * Comma-separated list of the fields to be returned in response. All the fields are returned by default. - * * Possible values: * <ul> * <li>"name"</li> @@ -59,8 +55,6 @@ public class SearchRequest { } /** - * Key of organization. If not set then groups are searched in default organization. - * * This is part of the internal API. * Example value: "my-org" */ @@ -74,8 +68,6 @@ public class SearchRequest { } /** - * 1-based page number - * * Example value: "42" */ public SearchRequest setP(String p) { @@ -88,8 +80,6 @@ public class SearchRequest { } /** - * Page size. Must be greater than 0 and less than 500 - * * Example value: "20" */ public SearchRequest setPs(String ps) { @@ -102,8 +92,6 @@ public class SearchRequest { } /** - * Limit search to names that contain the supplied string. - * * Example value: "sonar-users" */ public SearchRequest setQ(String q) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/UpdateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/UpdateRequest.java index c07e0dffd76..6fc408acb8c 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/UpdateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/UpdateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.usergroups; +import java.util.List; import javax.annotation.Generated; /** - * Update a group.<br>Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_groups/update">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class UpdateRequest { private String name; /** - * New optional description for the group. A group description cannot be larger than 200 characters. If value is not defined, then description is not changed. - * * Example value: "Default group for new users" */ public UpdateRequest setDescription(String description) { @@ -51,8 +48,6 @@ public class UpdateRequest { } /** - * Identifier of the group. - * * This is a mandatory parameter. * Example value: "42" */ @@ -66,8 +61,6 @@ public class UpdateRequest { } /** - * New optional name for the group. A group name cannot be larger than 255 characters and must be unique. Value 'anyone' (whatever the case) is reserved and cannot be used. If value is empty or not defined, then name is not changed. - * * Example value: "my-group" */ public UpdateRequest setName(String name) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/UserGroupsService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/UserGroupsService.java index 2401737e0f1..a886127e9b6 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/UserGroupsService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/UserGroupsService.java @@ -31,7 +31,6 @@ import org.sonarqube.ws.UserGroups.SearchWsResponse; import org.sonarqube.ws.UserGroups.UpdateWsResponse; /** - * Manage user groups. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_groups">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -42,7 +41,6 @@ public class UserGroupsService extends BaseService { } /** - * Add a user to a group.<br />'id' or 'name' must be provided.<br />Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a POST request. @@ -61,7 +59,6 @@ public class UserGroupsService extends BaseService { } /** - * Create a group.<br>Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a POST request. @@ -78,7 +75,6 @@ public class UserGroupsService extends BaseService { } /** - * Delete a group. The default groups cannot be deleted.<br/>'id' or 'name' must be provided.<br />Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a POST request. @@ -96,7 +92,6 @@ public class UserGroupsService extends BaseService { } /** - * Remove a user from a group.<br />'id' or 'name' must be provided.<br>Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a POST request. @@ -115,7 +110,6 @@ public class UserGroupsService extends BaseService { } /** - * Search for user groups.<br>Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a GET request. @@ -134,7 +128,6 @@ public class UserGroupsService extends BaseService { } /** - * Update a group.<br>Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a POST request. @@ -151,7 +144,6 @@ public class UserGroupsService extends BaseService { } /** - * Search for users with membership information with respect to a group.<br>Requires the following permission: 'Administer System'. * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/UsersRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/UsersRequest.java index 940e1899ac3..3620d27b98c 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/UsersRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/UsersRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.usergroups; +import java.util.List; import javax.annotation.Generated; /** - * Search for users with membership information with respect to a group.<br>Requires the following permission: 'Administer System'. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_groups/users">Further information about this action online (including a response example)</a> @@ -41,8 +40,6 @@ public class UsersRequest { private String selected; /** - * Group id - * * Example value: "42" */ public UsersRequest setId(String id) { @@ -55,8 +52,6 @@ public class UsersRequest { } /** - * Group name - * * Example value: "sonar-administrators" */ public UsersRequest setName(String name) { @@ -69,8 +64,6 @@ public class UsersRequest { } /** - * Key of organization - * * This is part of the internal API. * Example value: "my-org" */ @@ -84,8 +77,6 @@ public class UsersRequest { } /** - * 1-based page number - * * Example value: "42" */ public UsersRequest setP(String p) { @@ -98,8 +89,6 @@ public class UsersRequest { } /** - * Page size. Must be greater than 0. - * * Example value: "20" */ public UsersRequest setPs(String ps) { @@ -112,8 +101,6 @@ public class UsersRequest { } /** - * Limit search to names or logins that contain the supplied string. - * * Example value: "freddy" */ public UsersRequest setQ(String q) { @@ -126,8 +113,6 @@ public class UsersRequest { } /** - * Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), or all items with their selection status (selected=all). - * * Possible values: * <ul> * <li>"all"</li> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/package-info.java index fd91b8c99ac..183ec2b5d1e 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/usergroups/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.usergroups; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/userproperties/UserPropertiesService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/userproperties/UserPropertiesService.java index e8685b5b00c..b66b2d14094 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/userproperties/UserPropertiesService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/userproperties/UserPropertiesService.java @@ -28,7 +28,6 @@ import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; /** - * Removed since 6.3, please use api/favorites and api/notifications instead * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_properties">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -39,7 +38,6 @@ public class UserPropertiesService extends BaseService { } /** - * This web service is removed * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/userproperties/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/userproperties/package-info.java index 2e6ccc12bce..c233153e320 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/userproperties/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/userproperties/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.userproperties; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/users/ChangePasswordRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/users/ChangePasswordRequest.java index 42d42e08d89..fe370e42bff 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/users/ChangePasswordRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/users/ChangePasswordRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.users; +import java.util.List; import javax.annotation.Generated; /** - * Update a user's password. Authenticated users can change their own password, provided that the account is not linked to an external authentication system. Administer System permission is required to change another user's password. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/users/change_password">Further information about this action online (including a response example)</a> @@ -37,8 +36,6 @@ public class ChangePasswordRequest { private String previousPassword; /** - * User login - * * This is a mandatory parameter. * Example value: "myuser" */ @@ -52,8 +49,6 @@ public class ChangePasswordRequest { } /** - * New password - * * This is a mandatory parameter. * Example value: "mypassword" */ @@ -67,8 +62,6 @@ public class ChangePasswordRequest { } /** - * Previous password. Required when changing one's own password. - * * Example value: "oldpassword" */ public ChangePasswordRequest setPreviousPassword(String previousPassword) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/users/CreateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/users/CreateRequest.java index 39517cb7f51..7852c6846c8 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/users/CreateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/users/CreateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.users; +import java.util.List; import javax.annotation.Generated; /** - * Create a user.<br/>If a deactivated user account exists with the given login, it will be reactivated.<br/>Requires Administer System permission - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/users/create">Further information about this action online (including a response example)</a> @@ -41,8 +40,6 @@ public class CreateRequest { private String scmAccounts; /** - * User email - * * Example value: "myname@email.com" */ public CreateRequest setEmail(String email) { @@ -55,8 +52,6 @@ public class CreateRequest { } /** - * Specify if the user should be authenticated from SonarQube server or from an external authentication system. Password should not be set when local is set to false. - * * Possible values: * <ul> * <li>"true"</li> @@ -75,8 +70,6 @@ public class CreateRequest { } /** - * User login - * * This is a mandatory parameter. * Example value: "myuser" */ @@ -90,8 +83,6 @@ public class CreateRequest { } /** - * User name - * * This is a mandatory parameter. * Example value: "My Name" */ @@ -105,8 +96,6 @@ public class CreateRequest { } /** - * User password. Only mandatory when creating local user, otherwise it should not be set - * * Example value: "mypassword" */ public CreateRequest setPassword(String password) { @@ -119,8 +108,6 @@ public class CreateRequest { } /** - * SCM accounts. To set several values, the parameter must be called once for each value. - * * Example value: "scmAccount=firstValue&scmAccount=secondValue&scmAccount=thirdValue" */ public CreateRequest setScmAccount(String scmAccount) { @@ -133,8 +120,6 @@ public class CreateRequest { } /** - * This parameter is deprecated, please use 'scmAccount' instead - * * Example value: "myscmaccount1,myscmaccount2" * @deprecated since 6.1 */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/users/DeactivateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/users/DeactivateRequest.java index 5e83fd9dd67..cf8906d82ce 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/users/DeactivateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/users/DeactivateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.users; +import java.util.List; import javax.annotation.Generated; /** - * Deactivate a user. Requires Administer System permission - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/users/deactivate">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class DeactivateRequest { private String login; /** - * User login - * * This is a mandatory parameter. * Example value: "myuser" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/users/GroupsRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/users/GroupsRequest.java index 7fbb7f99a1f..8db1e4e3133 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/users/GroupsRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/users/GroupsRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.users; +import java.util.List; import javax.annotation.Generated; /** - * Lists the groups a user belongs to. <br/>Requires Administer System permission. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/users/groups">Further information about this action online (including a response example)</a> @@ -40,8 +39,6 @@ public class GroupsRequest { private String selected; /** - * A user login - * * This is a mandatory parameter. * Example value: "admin" */ @@ -55,8 +52,6 @@ public class GroupsRequest { } /** - * Organization key - * * This is part of the internal API. * Example value: "my-org" */ @@ -70,8 +65,6 @@ public class GroupsRequest { } /** - * 1-based page number - * * Example value: "42" */ public GroupsRequest setP(String p) { @@ -84,8 +77,6 @@ public class GroupsRequest { } /** - * Page size. Must be greater than 0. - * * Example value: "20" */ public GroupsRequest setPs(String ps) { @@ -98,8 +89,6 @@ public class GroupsRequest { } /** - * Limit search to group names that contain the supplied string. - * * Example value: "users" */ public GroupsRequest setQ(String q) { @@ -112,8 +101,6 @@ public class GroupsRequest { } /** - * Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), or all items with their selection status (selected=all). - * * Possible values: * <ul> * <li>"all"</li> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/users/SearchRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/users/SearchRequest.java index f7095f9c962..f7b7967d1bc 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/users/SearchRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/users/SearchRequest.java @@ -23,8 +23,6 @@ import java.util.List; import javax.annotation.Generated; /** - * Get a list of active users. <br/>Administer System permission is required to show the 'groups' field.<br/>When accessed anonymously, only logins and names are returned. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/users/search">Further information about this action online (including a response example)</a> @@ -39,8 +37,6 @@ public class SearchRequest { private String q; /** - * Comma-separated list of the fields to be returned in response. All the fields are returned by default. - * * Possible values: * <ul> * <li>"name"</li> @@ -66,8 +62,6 @@ public class SearchRequest { } /** - * 1-based page number - * * Example value: "42" */ public SearchRequest setP(String p) { @@ -80,8 +74,6 @@ public class SearchRequest { } /** - * Page size. Must be greater than 0 and less than 500 - * * Example value: "20" */ public SearchRequest setPs(String ps) { @@ -94,8 +86,6 @@ public class SearchRequest { } /** - * Filter on login or name. - * */ public SearchRequest setQ(String q) { this.q = q; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/users/UpdateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/users/UpdateRequest.java index 6c720f186d6..672f3c89be7 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/users/UpdateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/users/UpdateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.users; +import java.util.List; import javax.annotation.Generated; /** - * Update a user. If a deactivated user account exists with the given login, it will be reactivated. Requires Administer System permission - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/users/update">Further information about this action online (including a response example)</a> @@ -39,8 +38,6 @@ public class UpdateRequest { private String scmAccounts; /** - * User email - * * Example value: "myname@email.com" */ public UpdateRequest setEmail(String email) { @@ -53,8 +50,6 @@ public class UpdateRequest { } /** - * User login - * * This is a mandatory parameter. * Example value: "myuser" */ @@ -68,8 +63,6 @@ public class UpdateRequest { } /** - * User name - * * Example value: "My Name" */ public UpdateRequest setName(String name) { @@ -82,8 +75,6 @@ public class UpdateRequest { } /** - * SCM accounts. To set several values, the parameter must be called once for each value. - * * Example value: "scmAccount=firstValue&scmAccount=secondValue&scmAccount=thirdValue" */ public UpdateRequest setScmAccount(String scmAccount) { @@ -96,8 +87,6 @@ public class UpdateRequest { } /** - * This parameter is deprecated, please use 'scmAccount' instead - * * Example value: "myscmaccount1,myscmaccount2" * @deprecated since 6.1 */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/users/UsersService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/users/UsersService.java index 5170936a7e1..f456762369b 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/users/UsersService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/users/UsersService.java @@ -33,7 +33,6 @@ import org.sonarqube.ws.Users.IdentityProvidersWsResponse; import org.sonarqube.ws.Users.SearchWsResponse; /** - * Manage users. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/users">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -44,7 +43,6 @@ public class UsersService extends BaseService { } /** - * Update a user's password. Authenticated users can change their own password, provided that the account is not linked to an external authentication system. Administer System permission is required to change another user's password. * * This is part of the internal API. * This is a POST request. @@ -62,7 +60,6 @@ public class UsersService extends BaseService { } /** - * Create a user.<br/>If a deactivated user account exists with the given login, it will be reactivated.<br/>Requires Administer System permission * * This is part of the internal API. * This is a POST request. @@ -83,7 +80,6 @@ public class UsersService extends BaseService { } /** - * Get the details of the current authenticated user. * * This is part of the internal API. * This is a GET request. @@ -97,7 +93,6 @@ public class UsersService extends BaseService { } /** - * Deactivate a user. Requires Administer System permission * * This is part of the internal API. * This is a POST request. @@ -113,7 +108,6 @@ public class UsersService extends BaseService { } /** - * Lists the groups a user belongs to. <br/>Requires Administer System permission. * * This is part of the internal API. * This is a GET request. @@ -133,7 +127,6 @@ public class UsersService extends BaseService { } /** - * List the external identity providers * * This is part of the internal API. * This is a GET request. @@ -147,7 +140,6 @@ public class UsersService extends BaseService { } /** - * Get a list of active users. <br/>Administer System permission is required to show the 'groups' field.<br/>When accessed anonymously, only logins and names are returned. * * This is part of the internal API. * This is a GET request. @@ -165,7 +157,6 @@ public class UsersService extends BaseService { } /** - * Stores that the user has skipped the onboarding tutorial and does not want to see it after future logins.<br/>Requires authentication. * * This is part of the internal API. * This is a POST request. @@ -180,7 +171,6 @@ public class UsersService extends BaseService { } /** - * Update a user. If a deactivated user account exists with the given login, it will be reactivated. Requires Administer System permission * * This is part of the internal API. * This is a POST request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/users/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/users/package-info.java index 8076ca836b0..90f68b1a6d2 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/users/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/users/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.users; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/usertokens/GenerateRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/usertokens/GenerateRequest.java index 14b713942dd..e0a7d9c77cc 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/usertokens/GenerateRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/usertokens/GenerateRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.usertokens; +import java.util.List; import javax.annotation.Generated; /** - * Generate a user access token. <br />Please keep your tokens secret. They enable to authenticate and analyze projects.<br />If the login is set, it requires administration permissions. Otherwise, a token is generated for the authenticated user. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_tokens/generate">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class GenerateRequest { private String name; /** - * User login. If not set, the token is generated for the authenticated user. - * * Example value: "g.hopper" */ public GenerateRequest setLogin(String login) { @@ -50,8 +47,6 @@ public class GenerateRequest { } /** - * Token name - * * This is a mandatory parameter. * Example value: "Project scan on Travis" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/usertokens/RevokeRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/usertokens/RevokeRequest.java index 90700dc20fa..1d05d9a41f8 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/usertokens/RevokeRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/usertokens/RevokeRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.usertokens; +import java.util.List; import javax.annotation.Generated; /** - * Revoke a user access token. <br/>If the login is set, it requires administration permissions. Otherwise, a token is generated for the authenticated user. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_tokens/revoke">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class RevokeRequest { private String name; /** - * User login - * * Example value: "g.hopper" */ public RevokeRequest setLogin(String login) { @@ -50,8 +47,6 @@ public class RevokeRequest { } /** - * Token name - * * This is a mandatory parameter. * Example value: "Project scan on Travis" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/usertokens/SearchRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/usertokens/SearchRequest.java index 0cae81bc664..a2f72792ee7 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/usertokens/SearchRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/usertokens/SearchRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.usertokens; +import java.util.List; import javax.annotation.Generated; /** - * List the access tokens of a user.<br>The login must exist and active.<br>If the login is set, it requires administration permissions. Otherwise, a token is generated for the authenticated user. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_tokens/search">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class SearchRequest { private String login; /** - * User login - * * Example value: "g.hopper" */ public SearchRequest setLogin(String login) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/usertokens/UserTokensService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/usertokens/UserTokensService.java index 30e6e7ea690..b2b16b4b450 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/usertokens/UserTokensService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/usertokens/UserTokensService.java @@ -19,6 +19,7 @@ */ package org.sonarqube.ws.client.usertokens; +import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; @@ -29,7 +30,6 @@ import org.sonarqube.ws.UserTokens.GenerateWsResponse; import org.sonarqube.ws.UserTokens.SearchWsResponse; /** - * List, create, and delete a user's access tokens. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/user_tokens">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -40,7 +40,6 @@ public class UserTokensService extends BaseService { } /** - * Generate a user access token. <br />Please keep your tokens secret. They enable to authenticate and analyze projects.<br />If the login is set, it requires administration permissions. Otherwise, a token is generated for the authenticated user. * * This is part of the internal API. * This is a POST request. @@ -56,7 +55,6 @@ public class UserTokensService extends BaseService { } /** - * Revoke a user access token. <br/>If the login is set, it requires administration permissions. Otherwise, a token is generated for the authenticated user. * * This is part of the internal API. * This is a POST request. @@ -73,7 +71,6 @@ public class UserTokensService extends BaseService { } /** - * List the access tokens of a user.<br>The login must exist and active.<br>If the login is set, it requires administration permissions. Otherwise, a token is generated for the authenticated user. * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/usertokens/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/usertokens/package-info.java index cca27eb2dec..a4da3935553 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/usertokens/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/usertokens/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.usertokens; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/webhooks/DeliveriesRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/webhooks/DeliveriesRequest.java index d47604c0657..b352c8b6cac 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/webhooks/DeliveriesRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/webhooks/DeliveriesRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.webhooks; +import java.util.List; import javax.annotation.Generated; /** - * Get the recent deliveries for a specified project or Compute Engine task.<br/>Require 'Administer' permission on the related project.<br/>Note that additional information are returned by api/webhooks/delivery. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/webhooks/deliveries">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class DeliveriesRequest { private String componentKey; /** - * Id of the Compute Engine task - * * Example value: "AU-Tpxb--iU5OvuD2FLy" */ public DeliveriesRequest setCeTaskId(String ceTaskId) { @@ -50,8 +47,6 @@ public class DeliveriesRequest { } /** - * Key of the project - * * Example value: "my-project" */ public DeliveriesRequest setComponentKey(String componentKey) { diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/webhooks/DeliveryRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/webhooks/DeliveryRequest.java index 32af1fef83a..b187f8b380b 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/webhooks/DeliveryRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/webhooks/DeliveryRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.webhooks; +import java.util.List; import javax.annotation.Generated; /** - * Get a webhook delivery by its id.<br/>Require 'Administer System' permission.<br/>Note that additional information are returned by api/webhooks/delivery. - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/webhooks/delivery">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class DeliveryRequest { private String deliveryId; /** - * Id of delivery - * * This is a mandatory parameter. * Example value: "AU-TpxcA-iU5OvuD2FL3" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/webhooks/WebhooksService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/webhooks/WebhooksService.java index 36112100f59..d7f85c397a1 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/webhooks/WebhooksService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/webhooks/WebhooksService.java @@ -19,15 +19,17 @@ */ package org.sonarqube.ws.client.webhooks; +import java.util.stream.Collectors; import javax.annotation.Generated; +import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; import org.sonarqube.ws.client.GetRequest; +import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; import org.sonarqube.ws.Webhooks.DeliveriesWsResponse; import org.sonarqube.ws.Webhooks.DeliveryWsResponse; /** - * Webhooks allow to notify external services when a project analysis is done * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/webhooks">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -38,7 +40,6 @@ public class WebhooksService extends BaseService { } /** - * Get the recent deliveries for a specified project or Compute Engine task.<br/>Require 'Administer' permission on the related project.<br/>Note that additional information are returned by api/webhooks/delivery. * * This is part of the internal API. * This is a GET request. @@ -54,7 +55,6 @@ public class WebhooksService extends BaseService { } /** - * Get a webhook delivery by its id.<br/>Require 'Administer System' permission.<br/>Note that additional information are returned by api/webhooks/delivery. * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/webhooks/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/webhooks/package-info.java index adb8d2d7fe8..b68256caca6 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/webhooks/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/webhooks/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.webhooks; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/webservices/ListRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/webservices/ListRequest.java index 4505ab69093..cb873dd7e53 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/webservices/ListRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/webservices/ListRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.webservices; +import java.util.List; import javax.annotation.Generated; /** - * List web services - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/webservices/list">Further information about this action online (including a response example)</a> @@ -35,8 +34,6 @@ public class ListRequest { private String includeInternals; /** - * Include web services that are implemented for internal use only. Their forward-compatibility is not assured - * * Possible values: * <ul> * <li>"true"</li> diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/webservices/ResponseExampleRequest.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/webservices/ResponseExampleRequest.java index 79657974c31..ecb6145538f 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/webservices/ResponseExampleRequest.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/webservices/ResponseExampleRequest.java @@ -19,11 +19,10 @@ */ package org.sonarqube.ws.client.webservices; +import java.util.List; import javax.annotation.Generated; /** - * Display web service response example - * * This is part of the internal API. * This is a POST request. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/webservices/response_example">Further information about this action online (including a response example)</a> @@ -36,8 +35,6 @@ public class ResponseExampleRequest { private String controller; /** - * Action of the web service - * * This is a mandatory parameter. * Example value: "search" */ @@ -51,8 +48,6 @@ public class ResponseExampleRequest { } /** - * Controller of the web service - * * This is a mandatory parameter. * Example value: "api/issues" */ diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/webservices/WebservicesService.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/webservices/WebservicesService.java index 14912772103..6b5a12184a6 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/webservices/WebservicesService.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/webservices/WebservicesService.java @@ -19,14 +19,15 @@ */ package org.sonarqube.ws.client.webservices; +import java.util.stream.Collectors; import javax.annotation.Generated; import org.sonarqube.ws.MediaTypes; import org.sonarqube.ws.client.BaseService; import org.sonarqube.ws.client.GetRequest; +import org.sonarqube.ws.client.PostRequest; import org.sonarqube.ws.client.WsConnector; /** - * Get information on the web api supported on this instance. * @see <a href="https://next.sonarqube.com/sonarqube/web_api/api/webservices">Further information about this web service online</a> */ @Generated("sonar-ws-generator") @@ -37,7 +38,6 @@ public class WebservicesService extends BaseService { } /** - * List web services * * This is part of the internal API. * This is a GET request. @@ -53,7 +53,6 @@ public class WebservicesService extends BaseService { } /** - * Display web service response example * * This is part of the internal API. * This is a GET request. diff --git a/sonar-ws/src/main/java/org/sonarqube/ws/client/webservices/package-info.java b/sonar-ws/src/main/java/org/sonarqube/ws/client/webservices/package-info.java index d8ec8cbb9d7..0c26ae14541 100644 --- a/sonar-ws/src/main/java/org/sonarqube/ws/client/webservices/package-info.java +++ b/sonar-ws/src/main/java/org/sonarqube/ws/client/webservices/package-info.java @@ -18,7 +18,9 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ @ParametersAreNonnullByDefault +@Generated("sonar-ws-generator") package org.sonarqube.ws.client.webservices; import javax.annotation.ParametersAreNonnullByDefault; +import javax.annotation.Generated; |