diff options
| author | Guillaume Jambet <guillaume.jambet@sonarsource.com> | 2018-02-15 17:14:59 +0100 |
|---|---|---|
| committer | Guillaume Jambet <guillaume.jambet@gmail.com> | 2018-03-01 15:21:05 +0100 |
| commit | 74745908c3dd0c19cdde5e5a44fb9bb43c451d9b (patch) | |
| tree | d597bd30061cc0ced0b43db3f9f49293207ea231 /sonar-plugin-api | |
| parent | d535686f89484af334723467ed820a685fba4fb0 (diff) | |
| download | sonarqube-74745908c3dd0c19cdde5e5a44fb9bb43c451d9b.tar.gz sonarqube-74745908c3dd0c19cdde5e5a44fb9bb43c451d9b.zip | |
SONAR-10346 Add latest deliveries information to webhooks search ws.
Diffstat (limited to 'sonar-plugin-api')
| -rw-r--r-- | sonar-plugin-api/src/main/java/org/sonar/api/server/ws/WebService.java | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/server/ws/WebService.java b/sonar-plugin-api/src/main/java/org/sonar/api/server/ws/WebService.java index cdd5d5b25f4..90d3e237a54 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/server/ws/WebService.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/server/ws/WebService.java @@ -244,6 +244,7 @@ public interface WebService extends Definable<WebService.Context> { class NewAction { private final String key; + private static final String PAGE_PARAM_DESCRIPTION = "1-based page number"; private String deprecatedKey; private String description; private String since; @@ -353,7 +354,7 @@ public interface WebService extends Definable<WebService.Context> { */ public NewAction addPagingParams(int defaultPageSize) { createParam(Param.PAGE) - .setDescription("1-based page number") + .setDescription(PAGE_PARAM_DESCRIPTION) .setExampleValue("42") .setDeprecatedKey("pageIndex", "5.2") .setDefaultValue("1"); @@ -378,7 +379,7 @@ public interface WebService extends Definable<WebService.Context> { public NewParam createPageParam() { return createParam(Param.PAGE) - .setDescription("1-based page number") + .setDescription(PAGE_PARAM_DESCRIPTION) .setExampleValue("42") .setDeprecatedKey("pageIndex", "5.2") .setDefaultValue("1"); @@ -395,11 +396,11 @@ public interface WebService extends Definable<WebService.Context> { /** * 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. + * @since 7.1 */ public NewAction addPagingParamsSince(int defaultPageSize, int maxPageSize, String version) { createParam(Param.PAGE) - .setDescription("1-based page number") + .setDescription(PAGE_PARAM_DESCRIPTION) .setExampleValue("42") .setDefaultValue("1") .setSince(version); |