/** * Add 'selected=(selected|deselected|all)' for select-list oriented WS. */ public NewAction addSelectionModeParam() { createParam(Param.SELECTED) .setDescription("Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), " + "or all items with their selection status (selected=all).") .setDefaultValue(SelectionMode.SELECTED.value()) .setPossibleValues(SelectionMode.possibleValues()); return 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); }
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"); }
public NewParam createPageParam() { return createParam(Param.PAGE) .setDescription(PAGE_PARAM_DESCRIPTION) .setExampleValue("42") .setDeprecatedKey("pageIndex", "5.2") .setDefaultValue("1"); }
@Test public void param_with_maximum_value() { ((WebService) context -> { NewController newController = context.createController("api/custom_measures"); NewAction create = newDefaultAction(newController, "create"); create.createParam("numeric_value") .setMaximumValue(10); newController.done(); }).define(context); WebService.Action action = context.controller("api/custom_measures").action("create"); assertThat(action.param("numeric_value").maximumValue()).isEqualTo(10); }
static void addProjectParam(NewAction action) { action .createParam(PARAM_PROJECT) .setDescription("Project key") .setExampleValue(KEY_PROJECT_EXAMPLE_001) .setRequired(true); }
@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); }
public static void createGroupNameParameter(WebService.NewAction action) { action.createParam(PARAM_GROUP_NAME) .setDescription("Group name or 'anyone' (case insensitive)") .setExampleValue("sonar-administrators"); }
public WebService.NewParam createPermissionParameter(WebService.NewAction action) { return action.createParam(PARAM_PERMISSION) .setDescription(permissionParamDescription) .setRequired(true); }
private static void deprecateDeveloperParameter(NewAction action, String key) { action.createParam(key) .setDeprecatedSince("6.4") .setDescription("Deprecated parameter, used previously with the Developer Cockpit plugin. No measures are returned if parameter is set."); } }
@Override public void define(WebService.NewController context) { context.createAction("fake") .setHandler(this); }
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"); }
static void addPullRequestParam(NewAction action) { action .createParam(PARAM_PULL_REQUEST) .setDescription("Pull request id") .setExampleValue("1543") .setRequired(true); }
@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 static void createProjectKeyParameter(WebService.NewAction action) { action.createParam(PARAM_PROJECT_KEY) .setDescription("Project key") .setExampleValue(KEY_PROJECT_EXAMPLE_001); }
@Override public void define(WebService.NewController context) { context.createAction(actionKey).setHandler(this); } };
static void addBranchParam(NewAction action) { action .createParam(PARAM_BRANCH) .setDescription("Name of the branch") .setExampleValue("branch1") .setRequired(true); }
@Override public void define(WebService.NewController controller) { controller.createAction(LOGOUT_ACTION) .setDescription("Logout a user.") .setSince("6.3") .setPost(true) .setHandler(ServletFilterHandler.INSTANCE); }
public static void createTemplateProjectKeyPatternParameter(WebService.NewAction action) { action.createParam(PARAM_PROJECT_KEY_PATTERN) .setDescription("Project key pattern. Must be a valid Java regular expression") .setExampleValue(".*\\.finance\\..*"); }
private static void defineGroupIdWsParameter(WebService.NewAction action) { action.createParam(PARAM_GROUP_ID) .setDescription("Group id") .setExampleValue("42"); }