@Override public void define(WebService.NewController context) { WebService.NewAction action = context.createAction("search_templates") .setDescription("List permission templates.<br />" + "Requires the following permission: 'Administer System'.") .setResponseExample(getClass().getResource("search_templates-example.json")) .setSince("5.2") .addSearchQuery("defau", "permission template names") .setHandler(this); WsParameters.createOrganizationParameter(action).setSince("6.2"); }
@Override public void define(final Context context) { NewController controller = context .createController("api/webservices") .setSince("4.2") .setDescription("Get information on the web api supported on this instance."); actions.forEach(action -> { action.define(controller); action.setContext(context); }); controller.done(); } }
/** * Create a new controller. * <br> * Structure of request URL is <code>http://<server>/<controller path>/<action path>?<parameters></code>. * * @param path the controller path must not start or end with "/". It is recommended to start with "api/" * and to use lower-case format with underscores, for example "api/coding_rules". Usual actions * are "search", "list", "show", "create" and "delete". * the plural form is recommended - ex: api/projects */ public NewController createController(String path) { return new NewController(this, path); }
@Override public void define(WebService.NewController context) { WebService.NewAction action = context.createAction("set_default_template") .setDescription("Set a permission template as default.<br />" + "Requires the following permission: 'Administer System'.") .setPost(true) .setSince("5.2") .setHandler(this); WsParameters.createTemplateParameters(action); createDefaultTemplateQualifierParameter(action, newQualifierParameterContext(i18n, resourceTypes)) .setDefaultValue(Qualifiers.PROJECT); }
@Override public void define(Context context) { NewController controller = context.createController("api/favourites") .setDescription("Removed since 6.3, please use api/favorites instead") .setSince("2.6"); controller.createAction("index") .setDescription("The web service is removed and you're invited to use api/favorites instead") .setSince("2.6") .setDeprecatedSince("6.3") .setHandler(RemovedWebServiceHandler.INSTANCE) .setResponseExample(RemovedWebServiceHandler.INSTANCE.getResponseExample()); controller.done(); }
@Override public void define(WebService.NewController controller) { NewAction action = controller.createAction("backup") .setSince("5.2") .setDescription("Backup a quality profile in XML form. The exported profile can be restored through api/qualityprofiles/restore.") .setResponseExample(getClass().getResource("backup-example.xml")) .setHandler(this); QProfileReference.defineParams(action, languages); QProfileWsSupport.createOrganizationParam(action).setSince("6.4"); }
@Override public void define(WebService.NewController controller) { controller.createAction("restart") .setDescription("Restart server. Require 'Administer System' permission. Perform a full restart of the Web, Search and Compute Engine Servers processes.") .setSince("4.3") .setPost(true) .setHandler(this); }
@Override public void define(NewController context) { NewAction inheritance = context.createAction("inheritance") .setSince("5.2") .setDescription("Show a quality profile's ancestors and children.") .setHandler(this) .setResponseExample(getClass().getResource("inheritance-example.json")); createOrganizationParam(inheritance) .setSince("6.4"); QProfileReference.defineParams(inheritance, languages); }
private static void defineListAction(NewController controller) { controller.createAction("list") .setDescription("Get a list of profiles.<br/>" + "The web service is removed and you're invited to use api/qualityprofiles/search instead") .setSince("3.3") .setDeprecatedSince("5.2") .setHandler(RemovedWebServiceHandler.INSTANCE) .setResponseExample(RemovedWebServiceHandler.INSTANCE.getResponseExample()); } }
@Override public void define(WebService.NewController context) { WebService.NewAction action = context.createAction("upload") .setDescription("Upload a plugin.<br /> Requires 'Administer System' permission.") .setSince("6.0") .setPost(true) .setInternal(true) .setHandler(this); action.createParam(PARAM_FILE) .setDescription("The jar file of the plugin to install") .setRequired(true); }
@Override public void define(WebService.NewController context) { WebService.NewAction action = context.createAction("search") .setDescription("Search tags") .setSince("6.4") .setResponseExample(getClass().getResource("search-example.json")) .setHandler(this); action.addSearchQuery("off", "tags"); action.createPageSize(10, 100); }
@Override public void define(WebService.NewController controller) { controller.createAction("pending") .setDescription("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.") .setSince("5.2") .setHandler(this) .setResponseExample(getResource(this.getClass(), "example-pending_plugins.json")); }
@Override public void define(WebService.NewController context) { WebService.NewAction action = context.createAction("delete_template") .setDescription("Delete a permission template.<br />" + "Requires the following permission: 'Administer System'.") .setSince("5.2") .setPost(true) .setHandler(this); WsParameters.createTemplateParameters(action); }
@Override public void define(WebService.NewController context) { WebService.NewAction action = context.createAction("remove_project_creator_from_template") .setDescription("Remove a project creator from a permission template.<br>" + "Requires the following permission: 'Administer System'.") .setSince("6.0") .setPost(true) .setHandler(this); createTemplateParameters(action); wsParameters.createProjectPermissionParameter(action); }
@Override public void define(WebService.NewController controller) { NewAction setDefault = controller.createAction(ACTION_SET_DEFAULT) .setSince("5.2") .setDescription("Select the default profile for a given language.<br> " + "Requires to be logged in and the 'Administer Quality Profiles' permission.") .setPost(true) .setHandler(this); QProfileWsSupport.createOrganizationParam(setDefault).setSince("6.4"); QProfileReference.defineParams(setDefault, languages); }
@Override public void define(WebService.NewController controller) { controller.createAction("ping") .setDescription("Answers \"pong\" as plain-text") .setSince("6.3") .setResponseExample(getClass().getResource("ping-example.txt")) .setHandler(this); }
@Override public void define(WebService.NewController context) { context.createAction("types") .setDescription("List all available metric types.") .setResponseExample(getClass().getResource("example-types.json")) .setSince("5.2") .setHandler(this); }
@Override public void define(WebService.NewController context) { context.createAction("identity_providers") .setDescription("List the external identity providers") .setResponseExample(getClass().getResource("identity_providers-example.json")) .setSince("5.5") .setInternal(true) .setHandler(this); }
@Override public void define(WebService.NewController controller) { WebService.NewAction action = controller.createAction("fake") .setHandler(this); defineGenericRuleSearchParameters(action); }
@Override public void define(WebService.NewController controller) { controller.createAction("search") .setInternal(true) .setPost(false) .setDescription("Search for root users.<br/>" + "Requires to be root.") .setSince("6.2") .setResponseExample(getClass().getResource("search-example.json")) .setHandler(this); }