.setHandler(this); action.createFieldsParam(POSSIBLE_FIELDS) .setDescription("Comma-separated list of the fields to be returned in response") .setSince("6.4");
@Override public void define(WebService.NewController controller) { WebService.NewAction action = controller.createAction("installed") .setDescription("Get the list of all the plugins installed on the SonarQube instance, sorted by plugin name.") .setSince("5.2") .setChangelog( new Change("6.6", "The 'filename' field is added"), new Change("6.6", "The 'fileHash' field is added"), new Change("6.6", "The 'sonarLintSupported' field is added"), new Change("6.6", "The 'updatedAt' field is added"), new Change("7.0", "The fields 'compressedHash' and 'compressedFilename' are added")) .setHandler(this) .setResponseExample(Resources.getResource(this.getClass(), "example-installed_plugins.json")); action.createFieldsParam(singleton("category")) .setDescription(format("Comma-separated list of the additional fields to be returned in response. No additional field is returned by default. Possible values are:" + "<ul>" + "<li>%s - category as defined in the Update Center. A connection to the Update Center is needed</li>" + "</lu>", FIELD_CATEGORY)) .setSince("5.6"); }
@Override public void define(WebService.NewController controller) { WebService.NewAction action = controller.createAction("search") .setDescription("Get a list of active users. <br/>" + "Administer System permission is required to show the 'groups' field.<br/>" + "Field 'tokensCount' is only accessible to System Administrator and logged in user.<br/>" + "When accessed anonymously, only logins and names are returned.") .setSince("3.6") .setChangelog( new Change("7.4", "External identity is only returned to system administrators"), new Change("6.4", "Paging response fields moved to a Paging object"), new Change("6.4", "Avatar has been added to the response"), new Change("6.4", "Email is only returned when user has Administer System permission")) .setHandler(this) .setResponseExample(getClass().getResource("search-example.json")); action.createFieldsParam(UserJsonWriter.FIELDS) .setDeprecatedSince("5.4"); action.addPagingParams(50, MAX_LIMIT); action.createParam(TEXT_QUERY) .setMinimumLength(2) .setDescription("Filter on login, name and email"); }
.setHandler(this); action.createFieldsParam(POSSIBLE_FIELDS) .setDescription("Comma-separated list of the fields to be returned in response") .setSince("6.4");
@Override public void define(WebService.NewController controller) { WebService.NewAction action = controller.createAction("installed") .setDescription("Get the list of all the plugins installed on the SonarQube instance, sorted by plugin name.") .setSince("5.2") .setChangelog( new Change("6.6", "The 'filename' field is added"), new Change("6.6", "The 'fileHash' field is added"), new Change("6.6", "The 'sonarLintSupported' field is added"), new Change("6.6", "The 'updatedAt' field is added"), new Change("7.0", "The fields 'compressedHash' and 'compressedFilename' are added")) .setHandler(this) .setResponseExample(Resources.getResource(this.getClass(), "example-installed_plugins.json")); action.createFieldsParam(singleton("category")) .setDescription(format("Comma-separated list of the additional fields to be returned in response. No additional field is returned by default. Possible values are:" + "<ul>" + "<li>%s - category as defined in the Update Center. A connection to the Update Center is needed</li>" + "</lu>", FIELD_CATEGORY)) .setSince("5.6"); }
@Override public void define(WebService.NewController controller) { WebService.NewAction action = controller.createAction("search") .setDescription("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.") .setSince("3.6") .setChangelog( new Change("6.4", "Paging response fields moved to a Paging object"), new Change("6.4", "Avatar has been added to the response"), new Change("6.4", "Email is only returned when user has Administer System permission")) .setHandler(this) .setResponseExample(getClass().getResource("search-example.json")); action.createFieldsParam(UserJsonWriter.FIELDS) .setDeprecatedSince("5.4"); action.addPagingParams(50, MAX_LIMIT); action.createParam(TEXT_QUERY) .setMinimumLength(2) .setDescription("Filter on login, name and email"); }
/** * Creates the parameter {@link org.sonar.api.server.ws.WebService.Param#FIELDS}, which is * used to restrict the number of fields returned in JSON response. */ public NewAction addFieldsParam(Collection<?> possibleValues) { createFieldsParam(possibleValues); return this; }
/** * Creates the parameter {@link org.sonar.api.server.ws.WebService.Param#FIELDS}, which is * used to restrict the number of fields returned in JSON response. */ public NewAction addFieldsParam(Collection<?> possibleValues) { createFieldsParam(possibleValues); return this; }