Added examples to schema of CursorPagination (#8687)

norbertschuler · web-flow · commit 911b207fa13f · 2022-10-11T11:50:33.000+01:00
* Added examples to schema of CursorPagination Fix #8686 Added missing examples for CursorPagination class to disable warnings in https://github.com/tfranzel/drf-spectacular and make it consistent with other pagination classes. * Adapted test case for paginated response schema
diff --git a/rest_framework/pagination.py b/rest_framework/pagination.py
@@ -898,10 +898,16 @@ def get_paginated_response_schema(self, schema):
                 'next': {
                     'type': 'string',
                     'nullable': True,
+                    'format': 'uri',
+                    'example': 'http://api.example.org/accounts/?{cursor_query_param}=cD00ODY%3D"'.format(
+                        cursor_query_param=self.cursor_query_param)
                 },
                 'previous': {
                     'type': 'string',
                     'nullable': True,
+                    'format': 'uri',
+                    'example': 'http://api.example.org/accounts/?{cursor_query_param}=cj0xJnA9NDg3'.format(
+                        cursor_query_param=self.cursor_query_param)
                 },
                 'results': schema,
             },
diff --git a/tests/test_pagination.py b/tests/test_pagination.py
@@ -922,10 +922,14 @@ def test_get_paginated_response_schema(self):
                 'next': {
                     'type': 'string',
                     'nullable': True,
+                    'format': 'uri',
+                    'example': 'http://api.example.org/accounts/?cursor=cD00ODY%3D"'
                 },
                 'previous': {
                     'type': 'string',
                     'nullable': True,
+                    'format': 'uri',
+                    'example': 'http://api.example.org/accounts/?cursor=cj0xJnA9NDg3'
                 },
                 'results': unpaginated_schema,
             },
