From 5aeeedbda63c17fefc7bba99dbf8c718c7bbbd17 Mon Sep 17 00:00:00 2001
From: Teryk Bellahsene <teryk.bellahsene@sonarsource.com>
Date: Mon, 7 Dec 2015 15:03:34 +0100
Subject: SONAR-6820 WS api/rules/search has a page size limit of 500

---
 .../main/java/org/sonar/api/server/ws/WebService.java  | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

(limited to 'sonar-plugin-api')

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 6141bed8d8f..c75c80daded 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
@@ -363,6 +363,24 @@ public interface WebService extends Definable<WebService.Context> {
       return this;
     }
 
+    /**
+     * Add predefined parameters related to pagination of results.
+     */
+    public NewAction addPagingParams(int defaultPageSize, int maxSize) {
+      createParam(Param.PAGE)
+        .setDescription("1-based page number")
+        .setExampleValue("42")
+        .setDeprecatedKey("pageIndex")
+        .setDefaultValue("1");
+
+      createParam(Param.PAGE_SIZE)
+        .setDescription("Page size. Must be greater than 0 and less than " + maxSize)
+        .setExampleValue("20")
+        .setDeprecatedKey("pageSize")
+        .setDefaultValue(String.valueOf(defaultPageSize));
+      return this;
+    }
+
     /**
      * Creates the parameter {@link org.sonar.api.server.ws.WebService.Param#FIELDS}, which is
      * used to restrict the number of fields returned in JSON response.
-- 
cgit v1.2.3