WebService.NewParam addPullRequestParam(WebService.NewAction action) { return action.createParam(PARAM_PULL_REQUEST) .setDescription("Pull request. Only available on following settings : %s", SettingsWs.SETTING_ON_BRANCHES.stream().collect(COMMA_JOINER)) .setExampleValue(KEY_PULL_REQUEST_EXAMPLE_001) .setInternal(true) .setSince("7.1"); } }
WebService.NewParam addBranchParam(WebService.NewAction action) { return action.createParam(PARAM_BRANCH) .setDescription("Branch key. Only available on following settings : %s", SettingsWs.SETTING_ON_BRANCHES.stream().collect(COMMA_JOINER)) .setExampleValue(KEY_BRANCH_EXAMPLE_001) .setInternal(true) .setSince("6.6"); }
@Override public void define(WebService.NewController controller) { WebService.NewAction action = controller.createAction("logs") .setDescription("Get system logs in plain-text format. Requires system administration permission.") .setResponseExample(getClass().getResource("logs-example.log")) .setSince("5.2") .setHandler(this); action .createParam(PROCESS_PROPERTY) .setPossibleValues(stream(ProcessId.values()) .map(ProcessId::getKey) .sorted() .collect(MoreCollectors.toList(ProcessId.values().length))) .setDefaultValue(ProcessId.APP.getKey()) .setSince("6.2") .setDescription("Process to get logs from"); }
@Override public void define(WebService.NewController controller) { NewAction action = controller .createAction("tags") .setDescription("List rule tags") .setSince("4.4") .setHandler(this) .setResponseExample(Resources.getResource(getClass(), "tags-example.json")); action.createSearchQuery("misra", "tags"); action.createPageSize(10, 100); action.createParam(PARAM_ORGANIZATION) .setDescription("Organization key") .setRequired(false) .setInternal(true) .setExampleValue("my-org") .setSince("6.4"); }
@Override public void define(WebService.NewController context) { WebService.NewAction action = context.createAction("create_template") .setDescription("Create a permission template.<br />" + "Requires the following permission: 'Administer System'.") .setResponseExample(getClass().getResource("create_template-example.json")) .setSince("5.2") .setPost(true) .setHandler(this); action.createParam(PARAM_NAME) .setRequired(true) .setDescription("Name") .setExampleValue("Financial Service Permissions"); WsParameters.createTemplateProjectKeyPatternParameter(action); WsParameters.createTemplateDescriptionParameter(action); WsParameters.createOrganizationParameter(action).setSince("6.2"); }
@Override public void define(NewController controller) { NewAction action = controller.createAction("delete") .setDescription("Delete a quality profile and all its descendants. The default quality profile cannot be deleted.<br> " + "Requires one of the following permissions:" + "<ul>" + " <li>'Administer Quality Profiles'</li>" + " <li>Edit right on the specified quality profile</li>" + "</ul>") .setSince("5.2") .setPost(true) .setHandler(this); QProfileReference.defineParams(action, languages); createOrganizationParam(action) .setSince("6.4"); }
@Override public void define(WebService.NewController context) { WebService.NewAction action = context.createAction(ACTION_LIST) .setDescription("List notifications of the authenticated user.<br>" + "Requires one of the following permissions:" + "<ul>" + " <li>Authentication if no login is provided</li>" + " <li>System administration if a login is provided</li>" + "</ul>") .setSince("6.3") .setResponseExample(getClass().getResource("list-example.json")) .setHandler(this); action.createParam(PARAM_LOGIN) .setDescription("User login") .setSince("6.4"); }
@Override public void define(WebService.NewController controller) { WebService.NewAction action = controller.createAction("restore") .setSince("5.2") .setDescription("Restore a quality profile using an XML file. The restored profile name is taken from the backup file, " + "so if a profile with the same name and language already exists, it will be overwritten.<br> " + "Requires to be logged in and the 'Administer Quality Profiles' permission.") .setPost(true) .setHandler(this); action.createParam(PARAM_BACKUP) .setDescription("A profile backup file in XML format, as generated by api/qualityprofiles/backup " + "or the former api/profiles/backup.") .setRequired(true); QProfileWsSupport.createOrganizationParam(action).setSince("6.4"); }
@Override public void define(WebService.NewController controller) { WebService.NewAction action = controller.createAction("set_root") .setInternal(true) .setPost(true) .setDescription("Make the specified user root.<br/>" + "Requires to be root.") .setSince("6.2") .setHandler(this); action.createParam(PARAM_LOGIN) .setDescription("A user login") .setExampleValue("admin") .setRequired(true) .setSince("6.2"); }
@Override public void define(WebService.NewController controller) { WebService.NewAction action = controller.createAction("unset_root") .setInternal(true) .setPost(true) .setDescription("Make the specified user not root.<br/>" + "Requires to be root.") .setSince("6.2") .setHandler(this); action.createParam(PARAM_LOGIN) .setDescription("A user login") .setExampleValue("admin") .setRequired(true) .setSince("6.2"); }
@Override public void define(WebService.NewController controller) { WebService.NewAction action = controller.createAction("app") .setDescription("Get data required for rendering the page 'Coding Rules'.") .setResponseExample(getClass().getResource("app-example.json")) .setSince("4.5") .setInternal(true) .setHandler(this); action.createParam(PARAM_ORGANIZATION) .setDescription("Organization key") .setRequired(false) .setInternal(true) .setSince("6.4") .setExampleValue("my-org"); }
WebService.NewParam createOrganizationParam(NewAction action) { return action .createParam(PARAM_ORGANIZATION) .setDescription("Organization key. If no organization is provided, the default organization is used.") .setSince("7.0") .setRequired(false) .setInternal(false) .setExampleValue("my-org"); }
@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"); }
void addOrganizationParam(WebService.NewAction action) { action.createParam(PARAM_ORGANIZATION) .setDescription("The key of the organization") .setRequired(false) .setInternal(true) .setSince("6.3"); }
@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); }
@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); }
static void defineIsExternalParam(WebService.NewAction action) { action .createParam(PARAM_INCLUDE_EXTERNAL) .setDescription("Include external engine rules in the results") .setDefaultValue(false) .setBooleanPossibleValues() .setSince("7.2"); }
@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"); }
private static void defineGroupNameWsParameter(WebService.NewAction action) { action.createParam(PARAM_ORGANIZATION_KEY) .setDescription("Key of organization") .setExampleValue("my-org") .setInternal(true) .setSince("6.2"); action.createParam(PARAM_GROUP_NAME) .setDescription("Group name") .setExampleValue("sonar-administrators"); }