@Override public void define(NewController context) { context.createAction("exporters") .setDescription("Lists available profile export formats.") .setHandler(this) .setResponseExample(getClass().getResource("exporters-example.json")) .setSince("5.2"); }
@Override public void define(WebService.NewController context) { context.createAction("domains") .setDescription("List all custom metric domains.") .setSince("5.2") .setResponseExample(getClass().getResource("example-domains.json")) .setHandler(this); }
@Override public void define(WebService.NewController controller) { controller.createAction("upgrades") .setDescription("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.") .setSince("5.2") .setHandler(this) .setResponseExample(Resources.getResource(this.getClass(), "example-upgrades_plugins.json")); }
private static void defineIndexAction(NewController controller) { controller.createAction("index") .setDescription("The web service is removed and you're invited to use api/measures/search_history instead") .setSince("2.10") .setDeprecatedSince("6.3") .setHandler(RemovedWebServiceHandler.INSTANCE) .setResponseExample(RemovedWebServiceHandler.INSTANCE.getResponseExample()); }
@Override public void define(WebService.NewController controller) { controller.createAction(ACTION_WORKER_COUNT) .setDescription("Return number of Compute Engine workers.<br/>" + "Requires the system administration permission") .setResponseExample(getClass().getResource("worker_count-example.json")) .setSince("6.5") .setInternal(true) .setHandler(this); }
@Override public void define(WebService.NewController context) { context.createAction("generate_secret_key") .setDescription("Generate a secret key.<br>" + "Requires the 'Administer System' permission") .setSince("6.1") .setInternal(true) .setResponseExample(getClass().getResource("generate_secret_key-example.json")) .setHandler(this); }
@Override public void define(WebService.NewController context) { WebService.NewAction action = context.createAction(ACTION) .setDescription("List global permissions. <br />" + "Requires the following permission: 'Administer System'") .setResponseExample(getClass().getResource("search_global_permissions-example.json")) .setSince("5.2") .setDeprecatedSince("6.5") .setHandler(this); WsParameters.createOrganizationParameter(action).setSince("6.2"); }
@Override public void define(WebService.NewController context) { WebService.NewAction action = context.createAction("search_my_projects") .setDescription("Return list of projects for which the current user has 'Administer' permission. Maximum 1'000 projects are returned.") .setResponseExample(getClass().getResource("search_my_projects-example.json")) .addPagingParams(100, MAX_SIZE) .setSince("6.0") .setInternal(true) .setHandler(this); action.setChangelog(new Change("6.4", "The 'id' field is deprecated in the response")); }
@Override public void define(WebService.NewController context) { context .createAction("dummy") .setDescription("Dummy Description") .setPost(true) .setSince("5.3") .setHandler(this); }
@Override public void define(Context context) { NewController controller = context.createController("api/server"); controller.createAction("version") .setDescription("Version of SonarQube in plain text") .setSince("2.10") .setResponseExample(Resources.getResource(this.getClass(), "example-server-version.txt")) .setHandler(this); controller.done(); }
@Override public void define(WebService.NewController controller) { controller.createAction("cancel_all") .setPost(true) .setSince("5.2") .setDescription("Cancels any operation pending on any plugin (install, update or uninstall)" + "<br/>" + "Requires user to be authenticated with Administer System permissions") .setHandler(this); }
@Override public void define(NewController context) { WebService.NewAction action = context.createAction("delete") .setDescription(format("Delete a group. The default groups cannot be deleted.<br/>" + "'%s' or '%s' must be provided.<br />" + "Requires the following permission: 'Administer System'.", PARAM_GROUP_ID, PARAM_GROUP_NAME)) .setHandler(this) .setSince("5.2") .setPost(true); defineGroupWsParameters(action); }
@Override public void define(WebService.NewController controller) { controller.createAction("task_types") .setDescription("List available task types") .setResponseExample(getClass().getResource("task_types-example.json")) .setSince("5.5") .setInternal(true) .setHandler(this); }
@Override public void define(WebService.NewController context) { WebService.NewAction action = context.createAction(ACTION_LIST) .setSince("6.6") .setDescription("List the branches of a project.<br/>" + "Requires 'Browse' or 'Execute analysis' rights on the specified project.") .setResponseExample(Resources.getResource(getClass(), "list-example.json")) .setChangelog(new Change("7.2", "Application can be used on this web service")) .setHandler(this); addProjectParam(action); }
@Override public void define(WebService.NewController context) { context.createAction("check_secret_key") .setDescription("Check if a secret key is available.<br>" + "Requires the 'Administer System' permission.") .setSince("6.1") .setInternal(true) .setResponseExample(getClass().getResource("check_secret_key-example.json")) .setHandler(this); }
@Override public void define(WebService.NewController controller) { controller.createAction("resume") .setDescription("Resumes pause of Compute Engine workers. Requires the system administration permission or " + "system passcode (see " + SystemPasscodeImpl.PASSCODE_CONF_PROPERTY + " in sonar.properties).") .setSince("7.2") .setInternal(true) .setHandler(this) .setPost(true); }
private NewAction newDefaultAction(NewController controller, String actionKey) { return controller.createAction(actionKey) .setDescription("default description") .setSince("5.3") .setResponseExample(getClass().getResource("WebServiceTest/response-example.txt")) .setHandler(mock(RequestHandler.class)); } }
@Override public void define(WebService.NewController context) { context.createAction(ACTION_SKIP_ONBOARDING_TUTORIAL) .setPost(true) .setInternal(true) .setDescription("Stores that the user has skipped the onboarding tutorial and does not want to see it after future logins.<br/>" + "Requires authentication.") .setSince("6.5") .setHandler(this); }
@Override public void define(WebService.NewController controller) { controller.createAction("marketplace") .setSince("7.2") .setPost(false) .setDescription("Provide data to prefill license request forms: the server ID and the total number of lines of code.") .setResponseExample(getClass().getResource("marketplace-example.json")) .setInternal(true) .setHandler(this); }
private static void defineIndexAction(NewController controller) { controller.createAction("index") .setDescription("This web service is removed") .setSince("2.6") .setDeprecatedSince("6.3") .setHandler(RemovedWebServiceHandler.INSTANCE) .setResponseExample(RemovedWebServiceHandler.INSTANCE.getResponseExample()); }