update docs

Author: akira-dev

docs/configuration.rst

@@ -0,0 +1,10 @@
+.. _configuration:
+
+Configuration
+=============
+
+You have access to 3 configration keys:
+
+* PAGE_SIZE: the default page size (default is 30)
+* MAX_PAGE_SIZE: the maximum page size. If you speficy a page size greater than this value you will receive 400 Bad Request response.
+* MAX_INCLUDE_DEPTH: the maximum length of an include through schema relationships

docs/data_layer.rst

@@ -100,6 +100,8 @@ Optional parameters:
     :id_field: the field used as identifier field instead of the primary key of the model
     :url_field: the name of the parameter in the route to get value to filter with. Instead "id" is used.
 
+By default SQLAlchemy eagerload related data specified in include querystring parameter. If you want to disable this feature you must add eagerload_includes: False to data layer parameters.
+
 Custom data layer
 -----------------
 

docs/index.rst

@@ -57,6 +57,7 @@ Flask-REST-JSONAPI with Flask.
    api
    permission
    oauth
+   configuration
 
 API Reference
 -------------

docs/pagination.rst

@@ -5,7 +5,7 @@ Pagination
 
 .. currentmodule:: flask_rest_jsonapi
 
-When you use the default implementation of get method on a ResourceList your results will be paginated by default. Default pagination size is 20 but you can manage it from querystring parameter named "page".
+When you use the default implementation of get method on a ResourceList your results will be paginated by default. Default pagination size is 30 but you can manage it from querystring parameter named "page".
 
 .. note::
 

docs/quickstart.rst

@@ -826,4 +826,4 @@ Response:
       }
     }
 
-If you want to see more examples to go `JSON API 1.0 specification <http://jsonapi.org/>`_
+If you want to see more examples go to `JSON API 1.0 specification <http://jsonapi.org/>`_