Add REST API pagination settings

Add settings to allow changing the default and the maximum
REST API page size.

Signed-off-by: Roberto Rosario <[email protected]>

HISTORY.rst

@@ -1,3 +1,8 @@
+4.0.18 (2021-XX-XX)
+===================
+- Add settings to allow changing the default and the maximums
+  REST API page size.
+
 4.0.17 (2021-10-18)
 ===================
 - Backport workaround for swagger-spec-validator dependency

mayan/apps/rest_api/literals.py

@@ -1,5 +1,7 @@
 API_VERSION = '4'
-DEFAULT_MAX_PAGE_SIZE = 100
-DEFAULT_PAGE_SIZE = 10
+
 DEFAULT_PAGE_SIZE_QUERY_PARAMETER = 'page_size'
 DEFAULT_REST_API_DISABLE_LINKS = False
+DEFAULT_REST_API_MAXIMUM_PAGE_SIZE = 100
+DEFAULT_REST_API_PAGE_SIZE = 10
+

mayan/apps/rest_api/pagination.py

@@ -1,12 +1,10 @@
 from rest_framework import pagination
 
-from .literals import (
-    DEFAULT_MAX_PAGE_SIZE, DEFAULT_PAGE_SIZE,
-    DEFAULT_PAGE_SIZE_QUERY_PARAMETER
-)
+from .literals import DEFAULT_PAGE_SIZE_QUERY_PARAMETER
+from .settings import setting_maximum_page_size, setting_page_size
 
 
 class MayanPageNumberPagination(pagination.PageNumberPagination):
-    max_page_size = DEFAULT_MAX_PAGE_SIZE
-    page_size = DEFAULT_PAGE_SIZE
+    max_page_size = setting_maximum_page_size.value
+    page_size = setting_page_size.value
     page_size_query_param = DEFAULT_PAGE_SIZE_QUERY_PARAMETER

mayan/apps/rest_api/settings.py

@@ -2,7 +2,10 @@
 
 from mayan.apps.smart_settings.classes import SettingNamespace
 
-from .literals import DEFAULT_REST_API_DISABLE_LINKS
+from .literals import (
+    DEFAULT_REST_API_DISABLE_LINKS, DEFAULT_REST_API_MAXIMUM_PAGE_SIZE,
+    DEFAULT_REST_API_PAGE_SIZE
+)
 
 namespace = SettingNamespace(
     label=_('REST API'), name='rest_api', version='0001'
@@ -14,3 +17,16 @@
         'Disable the REST API links in the tools menu.'
     )
 )
+setting_maximum_page_size = namespace.add_setting(
+    default=DEFAULT_REST_API_MAXIMUM_PAGE_SIZE,
+    global_name='REST_API_MAXIMUM_PAGE_SIZE', help_text=_(
+        'The maximum page size that can be requested.'
+    )
+)
+setting_page_size = namespace.add_setting(
+    default=DEFAULT_REST_API_PAGE_SIZE,
+    global_name='REST_API_PAGE_SIZE', help_text=_(
+        'The default page size if none is specified.'
+    )
+)
+