diff --git a/README.rst b/README.rst index 7e7a6d58..905f15df 100644 --- a/README.rst +++ b/README.rst @@ -126,24 +126,26 @@ Settings One can either add ``rest_framework_json_api.parsers.JSONParser`` and ``rest_framework_json_api.renderers.JSONRenderer`` to each ``ViewSet`` class, or -override ``settings.REST_FRAMEWORK``:: - -REST_FRAMEWORK = { - 'PAGE_SIZE': 10, - 'EXCEPTION_HANDLER': 'rest_framework_json_api.exceptions.exception_handler', - 'DEFAULT_PAGINATION_CLASS': - 'rest_framework_json_api.pagination.PageNumberPagination', - 'DEFAULT_PARSER_CLASSES': ( - 'rest_framework_json_api.parsers.JSONParser', - 'rest_framework.parsers.FormParser', - 'rest_framework.parsers.MultiPartParser' - ), - 'DEFAULT_RENDERER_CLASSES': ( - 'rest_framework_json_api.renderers.JSONRenderer', - 'rest_framework.renderers.BrowsableAPIRenderer', - ), - 'DEFAULT_METADATA_CLASS': 'rest_framework_json_api.metadata.JSONAPIMetadata', -} +override ``settings.REST_FRAMEWORK`` + +:: + + REST_FRAMEWORK = { + 'PAGE_SIZE': 10, + 'EXCEPTION_HANDLER': 'rest_framework_json_api.exceptions.exception_handler', + 'DEFAULT_PAGINATION_CLASS': + 'rest_framework_json_api.pagination.PageNumberPagination', + 'DEFAULT_PARSER_CLASSES': ( + 'rest_framework_json_api.parsers.JSONParser', + 'rest_framework.parsers.FormParser', + 'rest_framework.parsers.MultiPartParser' + ), + 'DEFAULT_RENDERER_CLASSES': ( + 'rest_framework_json_api.renderers.JSONRenderer', + 'rest_framework.renderers.BrowsableAPIRenderer', + ), + 'DEFAULT_METADATA_CLASS': 'rest_framework_json_api.metadata.JSONAPIMetadata', + } If ``PAGINATE_BY`` is set the renderer will return a ``meta`` object with record count and a ``links`` object with the next and previous links. Pages