@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); }
.setDeprecatedSince("5.5") .setDeprecatedKey("pageIndex", "5.4"); action.createPageSize(100, MAX_PAGE_SIZE);
@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"); }
.setDeprecatedSince("5.5") .setDeprecatedKey("pageIndex", "5.4"); action.createPageSize(100, MAX_PAGE_SIZE);
@Override public void define(NewController controller) { NewAction action = controller.createAction("projects") .setSince("5.2") .setHandler(this) .setDescription("List projects with their association status regarding a quality profile") .setResponseExample(getClass().getResource("projects-example.json")); action.setChangelog( new Change("7.2", "'more' response field is deprecated"), new Change("6.5", "'id' response field is deprecated"), new Change("6.0", "'uuid' response field is deprecated and replaced by 'id'"), new Change("6.0", "'key' response field has been added to return the project key")); action.createParam(PARAM_KEY) .setDescription("Quality profile key") .setRequired(true) .setExampleValue(UUID_EXAMPLE_01); action.addSelectionModeParam(); action.createSearchQuery("sonar", "projects") .setDeprecatedKey("query", "6.5"); action.createPageParam() .setDeprecatedKey("page", "6.5"); action.createPageSize(100, MAX_PAGE_SIZE); }
@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(), "example-tags.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 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")); 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("search") .setDescription("Search tags") .setSince("6.4") .setResponseExample(getClass().getResource("search-example.json")) .setHandler(this); action.addSearchQuery("off", "tags"); action.createPageSize(10, 100); }
/** * Add predefined parameters related to pagination of results with a maximum page size. * Note the maximum is a documentation only feature. It does not check anything. */ public NewAction addPagingParams(int defaultPageSize, int maxPageSize) { createPageParam(); createPageSize(defaultPageSize, maxPageSize); return this; }
@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(NewController controller) { NewAction action = controller.createAction("projects") .setSince("5.2") .setHandler(this) .setDescription("List projects with their association status regarding a quality profile") .setResponseExample(getClass().getResource("projects-example.json")); action.setChangelog( new Change("7.2", "'more' response field is deprecated"), new Change("6.5", "'id' response field is deprecated"), new Change("6.0", "'uuid' response field is deprecated and replaced by 'id'"), new Change("6.0", "'key' response field has been added to return the project key")); action.createParam(PARAM_KEY) .setDescription("Quality profile key") .setRequired(true) .setExampleValue(UUID_EXAMPLE_01); action.addSelectionModeParam(); action.createSearchQuery("sonar", "projects") .setDeprecatedKey("query", "6.5"); action.createPageParam() .setDeprecatedKey("page", "6.5"); action.createPageSize(100, MAX_PAGE_SIZE); }
@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"); }
/** * Add predefined parameters related to pagination of results with a maximum page size. * Note the maximum is a documentation only feature. It does not check anything. */ public NewAction addPagingParams(int defaultPageSize, int maxPageSize) { createPageParam(); createPageSize(defaultPageSize, maxPageSize); return this; }