@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")); }
@Override public void define(WebService.NewController context) { WebService.NewAction action = context.createAction(ACTION_SEARCH) .setDescription("Search for the authenticated user favorites.<br>" + "Requires authentication.") .setSince("6.3") .setResponseExample(getClass().getResource("search-example.json")) .setHandler(this); action.addPagingParams(100, MAX_PAGE_SIZE); }
@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(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(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("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 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) { 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); }
@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); }
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)); } }
@Test public void post_action_without_response_example() { WebService ws = context -> { NewController newController = context.createController("api/rule"); newDefaultAction(newController, "list").setPost(true).setResponseExample(null); newController.done(); }; ws.define(context); assertThat(logTester.logs(LoggerLevel.WARN)) .doesNotContain("The response example is not set on action api/rule/list"); }
@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()); }