Add x-paginated in OpenAPI schema

arkindex/project/openapi/schema.py

@@ -23,3 +23,14 @@ class AutoSchema(BaseAutoSchema):
         We want to specify tags manually, so we return nothing instead.
         """
         return []
+
+    def get_operation(self, *args, **kwargs):
+        """
+        Add an `x-paginated` property to each operation to allow the API client to tell whether
+        or not to paginate when someone uses the pagination helper.
+        When either _is_list_view() or _get_paginator() return False or None respectively,
+        Spectacular does not include any pagination parameters.
+        """
+        operation = super().get_operation(*args, **kwargs)
+        operation['x-paginated'] = self._is_list_view() and self._get_paginator() is not None
+        return operation

arkindex/project/tests/openapi/test_schema.py

@@ -57,6 +57,7 @@ class TestAutoSchema(TestCase):
                     {'tokenAuth': []},
                     {'agentAuth': []}
                 ],
+                'x-paginated': False,
             }
         )
         self.assertDictEqual(registry[('DeprecatedException', ResolvedComponent.SCHEMA)].schema, {