Bug 19278: Add RESTdefaultPageSize syspref
authorTomas Cohen Arazi <tomascohen@theke.io>
Fri, 8 Sep 2017 15:18:21 +0000 (12:18 -0300)
committerJonathan Druart <jonathan.druart@bugs.koha-community.org>
Mon, 11 Dec 2017 20:46:59 +0000 (17:46 -0300)
Signed-off-by: Lari Taskula <lari.taskula@jns.fi>
Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
installer/data/mysql/atomicupdate/bug_19196_pagination_plugin.perl [new file with mode: 0644]
installer/data/mysql/sysprefs.sql
koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/web_services.pref

diff --git a/installer/data/mysql/atomicupdate/bug_19196_pagination_plugin.perl b/installer/data/mysql/atomicupdate/bug_19196_pagination_plugin.perl
new file mode 100644 (file)
index 0000000..57beb2d
--- /dev/null
@@ -0,0 +1,11 @@
+$DBversion = 'XXX';
+if( CheckVersion( $DBversion ) ) {
+    $dbh->do(q{
+        INSERT IGNORE INTO systempreferences ( `variable`, `value`, `options`, `explanation`, `type` )
+        VALUES
+            ('RESTdefaultPageSize','20','','Set the default number of results returned by the REST API endpoints','Integer')
+    });
+
+    SetVersion( $DBversion );
+    print "Upgrade to $DBversion done (Bug 19278: Add a configurable default page size for REST endpoints)\n";
+}
index e54e2ae..23cefb8 100644 (file)
@@ -459,6 +459,7 @@ INSERT INTO systempreferences ( `variable`, `value`, `options`, `explanation`, `
 ('ReservesControlBranch','PatronLibrary','ItemHomeLibrary|PatronLibrary','Branch checked for members reservations rights','Choice'),
 ('ReservesMaxPickUpDelay','7','','Define the Maximum delay to pick up an item on hold','Integer'),
 ('ReservesNeedReturns','1','','If ON, a hold placed on an item available in this library must be checked-in, otherwise, a hold on a specific item, that is in the library & available is considered available','YesNo'),
+('RESTdefaultPageSize','20','','Default page size for endpoints listing objects','Integer'),
 ('RestrictedPageLocalIPs','',NULL,'Beginning of IP addresses considered as local (comma separated ex: "127.0.0,127.0.2")','Free'),
 ('RestrictedPageContent','',NULL,'HTML content of the restricted page','TextArea'),
 ('RestrictedPageTitle','',NULL,'Title of the restricted page (breadcrumb and header)','Free'),
index b52fdc6..82f7501 100644 (file)
@@ -1,4 +1,10 @@
 Web services:
+    REST API:
+        -
+            - "Set the default number of results returned by the REST API endpoints to"
+            - pref: "RESTdefaultPageSize"
+              class: integer
+            - "per page"
     OAI-PMH:
         -
             - pref: OAI-PMH