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("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"); }
@Override public void define(WebService.NewController context) { WebService.NewAction action = context.createAction(ACTION) .setPost(true) .setDescription("Create an organization.<br />" + "Requires 'Administer System' permission unless any logged in user is allowed to create an organization (see appropriate setting). Organization support must be enabled.") .setResponseExample(getClass().getResource("create-example.json")) .setInternal(true) .setSince("6.2") .setChangelog( new Change("7.4", "Maximal number of character of name and key is 300 characters"), new Change("7.2", "Minimal number of character of name and key is one character")) .setHandler(this); action.createParam(PARAM_KEY) .setRequired(false) .setMinimumLength(KEY_MIN_LENGTH) .setMaximumLength(KEY_MAX_LENGTH) .setDescription("Key of the organization. <br />" + "The key is unique to the whole SonarQube. <br/>" + "When not specified, the key is computed from the name. <br />" + "All chars must be lower-case letters (a to z), digits or dash (but dash can neither be trailing nor heading)") .setExampleValue("foo-company"); action.createParam(PARAM_INSTALLATION_ID) .setRequired(false) .setInternal(true) .setDescription("Installation ID of the GitHub/Bitbucket application") .setExampleValue("387133"); wsSupport.addOrganizationDetailsParams(action, true); }
@Override public void define(NewController controller) { NewAction action = controller.createAction("create") .setDescription("Create a group.<br>" + "Requires the following permission: 'Administer System'.") .setHandler(this) .setPost(true) .setResponseExample(getClass().getResource("create-example.json")) .setSince("5.2"); action.createParam(PARAM_ORGANIZATION_KEY) .setDescription("Key of organization. If unset then default organization is used.") .setExampleValue("my-org") .setSince("6.2") .setInternal(true); action.createParam(PARAM_GROUP_NAME) .setRequired(true) .setMaximumLength(GROUP_NAME_MAX_LENGTH) .setDescription(format("Name for the new group. A group name cannot be larger than %d characters and must be unique. " + "The value 'anyone' (whatever the case) is reserved and cannot be used.", GROUP_NAME_MAX_LENGTH)) .setExampleValue("sonar-users"); action.createParam(PARAM_GROUP_DESCRIPTION) .setMaximumLength(DESCRIPTION_MAX_LENGTH) .setDescription(format("Description for the new group. A group description cannot be larger than %d characters.", DESCRIPTION_MAX_LENGTH)) .setExampleValue("Default group for new users"); }
@Override public void define(NewController context) { NewAction action = context.createAction("groups") .setDescription("Lists the groups a user belongs to. <br/>" + "Requires Administer System permission.") .setHandler(this) .setResponseExample(getClass().getResource("groups-example.json")) .addSelectionModeParam() .addSearchQuery("users", "group names") .addPagingParams(25) .setChangelog(new Change("6.4", "Paging response fields moved to a Paging object"), new Change("6.4", "'default' response field has been added")) .setSince("5.2"); action.createParam(PARAM_LOGIN) .setDescription("A user login") .setExampleValue("admin") .setRequired(true); action.createParam(PARAM_ORGANIZATION) .setDescription("Organization key") .setExampleValue("my-org") .setInternal(true) .setSince("6.4"); }
@Override public void define(WebService.NewController controller) { NewAction action = controller.createAction("authors") .setSince("5.1") .setDescription("Search SCM accounts which match a given query.<br/>" + "Requires authentication.") .setResponseExample(Resources.getResource(this.getClass(), "authors-example.json")) .setChangelog(new Change("7.4", "The maximum size of 'ps' is set to 100")) .setHandler(this); action.createSearchQuery("luke", "authors"); action.createPageSize(10, 100); action.createParam(PARAM_ORGANIZATION) .setDescription("Organization key") .setRequired(false) .setInternal(true) .setExampleValue("my-org") .setSince("7.4"); action.createParam(PARAM_PROJECT) .setDescription("Project key") .setRequired(false) .setExampleValue(KEY_PROJECT_EXAMPLE_001) .setSince("7.4"); }
@Override public void define(WebService.NewController context) { WebService.NewAction action = context.createAction("search_members") .setDescription("Search members of an organization.<br/>" + "Require organization membership.") .setResponseExample(getClass().getResource("search_members-example.json")) .setSince("6.4") .setInternal(true) .setChangelog(new Change("7.3", "This action now requires organization membership")) .setHandler(this); action.createSearchQuery("orwe", "names", "logins") .setMinimumLength(2); action.addPagingParams(50, MAX_LIMIT); action.createParam(Param.SELECTED) .setDescription("Depending on the value, show only selected items (selected=selected) or deselected items (selected=deselected).") .setInternal(true) .setDefaultValue(SELECTED.value()) .setPossibleValues(SELECTED.value(), SelectionMode.DESELECTED.value()); action.createParam(PARAM_ORGANIZATION) .setDescription("Organization key") .setInternal(true) .setRequired(false); }
@Override public void define(WebService.NewController controller) { NewAction action = controller.createAction("tags") .setHandler(this) .setSince("5.1") .setDescription("List tags matching a given query") .setResponseExample(Resources.getResource(getClass(), "tags-example.json")) .setChangelog(new Change("7.4", "Result doesn't include rules tags anymore")); 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"); action.createParam(PARAM_PROJECT) .setDescription("Project key") .setRequired(false) .setExampleValue(KEY_PROJECT_EXAMPLE_001) .setSince("7.4"); }
@Override public void define(WebService.NewController controller) { WebService.NewAction action = controller.createAction("raw") .setDescription("Get source code as raw text. Require 'See Source Code' permission on file") .setSince("5.0") .setResponseExample(Resources.getResource(getClass(), "example-raw.txt")) .setHandler(this); action .createParam(PARAM_KEY) .setRequired(true) .setDescription("File key") .setExampleValue("my_project:src/foo/Bar.php"); action .createParam(PARAM_BRANCH) .setDescription("Branch key") .setInternal(true) .setExampleValue(KEY_BRANCH_EXAMPLE_001); action .createParam(PARAM_PULL_REQUEST) .setDescription("Pull request id") .setInternal(true) .setExampleValue(KEY_PULL_REQUEST_EXAMPLE_001); }
@Override public void define(WebService.NewController context) { WebService.NewAction action = context.createAction(ACTION); action.setChangelog(new Change("6.4", "The 'uuid' field is deprecated in the response")); action .setDescription("List ghost projects.<br> " + "With the current architecture, it's no more possible to have invisible ghost projects. Therefore, the web service is deprecated.<br> " + "Requires 'Administer System' permission.") .setResponseExample(Resources.getResource(getClass(), "ghosts-example.json")) .setSince("5.2") .setDeprecatedSince("6.6") .addPagingParams(100, MAX_LIMIT) .addFieldsParam(POSSIBLE_FIELDS) .addSearchQuery("sonar", "names", "keys") .setHandler(this); action.createParam(PARAM_ORGANIZATION) .setDescription("Organization key") .setRequired(false) .setInternal(true) .setSince("6.3"); }
@Override public void define(NewController context) { WebService.NewAction action = context.createAction("search") .setDescription("Search for user groups.<br>" + "Requires the following permission: 'Administer System'.") .setHandler(this) .setResponseExample(getClass().getResource("search-example.json")) .setSince("5.2") .addFieldsParam(ALL_FIELDS) .addPagingParams(100, MAX_LIMIT) .addSearchQuery("sonar-users", "names") .setChangelog(new Change("6.4", "Paging response fields moved to a Paging object"), new Change("6.4", "'default' response field has been added")); action.createParam(PARAM_ORGANIZATION_KEY) .setDescription("Key of organization. If not set then groups are searched in default organization.") .setExampleValue("my-org") .setSince("6.2") .setInternal(true); }
@Override public void define(WebService.NewController controller) { NewAction show = controller.createAction(ACTION_SHOW) .setDescription("Show a quality profile") .setSince("6.5") .setResponseExample(getClass().getResource("show-example.json")) .setInternal(true) .setHandler(this); show.createParam(PARAM_KEY) .setDescription("Quality profile key") .setExampleValue(UUID_EXAMPLE_01) .setDeprecatedKey("profile", "6.6") .setRequired(true); show.createParam(PARAM_COMPARE_TO_SONAR_WAY) .setDescription("Add the number of missing rules from the related Sonar way profile in the response") .setInternal(true) .setDefaultValue("false") .setBooleanPossibleValues(); }
@Override public void define(WebService.NewController controller) { WebService.NewAction action = controller.createAction(LIST_ACTION) .setDescription("Search for global webhooks or project webhooks. Webhooks are ordered by name.<br>" + "Requires 'Administer' permission on the specified project, or global 'Administer' permission.") .setSince("7.1") .setResponseExample(Resources.getResource(this.getClass(), "example-webhooks-search.json")) .setHandler(this); action.createParam(ORGANIZATION_KEY_PARAM) .setDescription("Organization key. If no organization is provided, the default organization is used.") .setInternal(true) .setRequired(false) .setExampleValue(KEY_ORG_EXAMPLE_001); action.createParam(PROJECT_KEY_PARAM) .setDescription("Project key") .setRequired(false) .setExampleValue(KEY_PROJECT_EXAMPLE_001); }
@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"); }
public static NewParam createOrganizationParam(NewAction action) { return action .createParam(PARAM_ORGANIZATION) .setDescription("Organization key. If no organization is provided, the default organization is used.") .setRequired(false) .setInternal(true) .setExampleValue("my-org"); }
void addOrganizationParam(WebService.NewAction action) { action.createParam(PARAM_ORGANIZATION) .setDescription("The key of the organization") .setRequired(false) .setInternal(true) .setSince("6.3"); }
public static WebService.NewParam createOrganizationParameter(WebService.NewAction action) { return action.createParam(PARAM_ORGANIZATION) .setDescription("Key of organization, used when group name is set") .setExampleValue("my-org") .setInternal(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"); }
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"); }