@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) { 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) { 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 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); }
@Override public void define(WebService.NewController controller) { controller .createAction("list") .setDescription("List rules, excluding the manual rules and the rules with status REMOVED. JSON format is not supported for response.") .setSince("5.2") .setInternal(true) .setResponseExample(getClass().getResource("list-example.txt")) .setHandler(this); }
@Override public void define(WebService.NewController context) { context.createAction(ACTION) .setPost(true) .setDescription("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.") .setInternal(true) .setPost(true) .setSince("6.3") .setChangelog(new Change("6.4", "Create default 'Members' group")) .setHandler(this); }
@Override public void define(WebService.NewController controller) { controller.createAction("cancel_all") .setDescription("Cancels all pending tasks. Requires system administration permission. In-progress tasks are not canceled.") .setInternal(true) .setPost(true) .setSince("5.2") .setHandler(this); }
@Override public void define(WebService.NewController controller) { controller.createAction("pause") .setDescription("Requests 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); }
public void define(WebService.NewController controller) { controller .createAction("is_queue_empty") .setDescription("Check if the queue of Compute Engine is empty") .setResponseExample(getClass().getResource("is_queue_empty-example.txt")) .setSince("5.1") .setInternal(true) .setHandler(this); }
@Override public void define(NewController context) { context.createAction("global") .setDescription("Get information concerning global navigation for the current user.") .setHandler(this) .setInternal(true) .setResponseExample(getClass().getResource("global-example.json")) .setSince("5.2"); }
@Override public void define(WebService.NewController controller) { controller.createAction("info") .setDescription("Gets information about Compute Engine. Requires the system administration permission or " + "system passcode (see " + SystemPasscodeImpl.PASSCODE_CONF_PROPERTY + " in sonar.properties).") .setSince("7.2") .setInternal(true) .setHandler(this) .setResponseExample(getClass().getResource("info-example.json")); }
@Override public void define(WebService.NewController context) { context.createAction("index") .setInternal(true) .setSince("4.4") .setDescription("List the JAR files to be downloaded by scanners") .setHandler(this) .setResponseExample(getClass().getResource("index-example.txt")); }
@Override public void define(NewController context) { context.createAction(ACTION_CURRENT) .setDescription("Get the details of the current authenticated user.") .setSince("5.2") .setInternal(true) .setHandler(this) .setResponseExample(getClass().getResource("current-example.json")) .setChangelog( new Change("6.5", "showOnboardingTutorial is now returned in the response"), new Change("7.1", "'parameter' is replaced by 'component' and 'organization' in the response")); }
@Test public void ws_is_internal_if_all_actions_are_internal() { ((WebService) context -> { NewController newController = context.createController("api/rule"); newDefaultAction(newController, "create").setInternal(true); newDefaultAction(newController, "update").setInternal(true); newController.done(); }).define(context); assertThat(context.controller("api/rule").isInternal()).isTrue(); }
@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 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("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 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); }