Merge branch 'hotfix-0.11.2' into develop

Author: akira-dev

docs/data_layer.rst

@@ -29,7 +29,9 @@ Example:
                       'model': Person}
 
 You can also plug additional methods to your data layer in the resource manager. There is 2 kind of additional methods:
+
 * query: the "query" additional method takes view_kwargs as parameter and return an alternative query to retrieve the collection of objects in the get method of the ResourceList manager.
+
 * pre / post process methods: all CRUD and relationship(s) operations have a pre / post process methods. Thanks to it you can make additional work before and after each operations of the data layer. Parameters of each pre / post process methods are available in the `flask_rest_jsonapi.data_layers.base.Base <https://github.com/miLibris/flask-rest-jsonapi/blob/master/flask_rest_jsonapi/data_layers/base.py>`_ base class.
 
 Example:
@@ -109,7 +111,7 @@ Usage example:
 
     from flask_rest_jsonapi import ResourceList
     from your_project.schemas import PersonSchema
-    from your_project_data_layers import MyCustomDataLayer
+    from your_project.data_layers import MyCustomDataLayer
 
     class PersonList(ResourceList):
         schema = PersonSchema

docs/errors.rst

@@ -55,9 +55,9 @@ The previous example displays error located in data provided instead of this nex
 
 Flask-REST-JSONAPI provides two kind of helpers to achieve error displaying:
 
-| * **the errors module**: you can import jsonapi_errors from the errors module to create the structure of a list of errors according to JSONAPI 1.0 specification
+| * **the errors module**: you can import jsonapi_errors from the `errors module <https://github.com/miLibris/flask-rest-jsonapi/blob/master/flask_rest_jsonapi/errors.py>`_ to create the structure of a list of errors according to JSONAPI 1.0 specification
 |
-| * **the exceptions module**: you can import lot of exceptions from this module that helps you to raise exceptions that will be well formatted according to JSONAPI 1.0 specification
+| * **the exceptions module**: you can import lot of exceptions from this `module <https://github.com/miLibris/flask-rest-jsonapi/blob/master/flask_rest_jsonapi/exceptions.py>`_ that helps you to raise exceptions that will be well formatted according to JSONAPI 1.0 specification
 
 When you create custom code for your api I recommand to use exceptions from exceptions module of Flask-REST-JSONAPI to raise errors because JsonApiException based exceptions are catched and rendered according to JSONAPI 1.0 specification.
 

docs/filtering.rst

@@ -106,8 +106,6 @@ You can also use boolean combinaison of operations:
     ] HTTP/1.1
     Accept: application/vnd.api+json
 
-Availables operators depend on field type
-
 Common available operators:
 
 * any: used to filter on to many relationships

docs/include_related_objects.rst

@@ -11,8 +11,6 @@ This features will add an additional key in result named "included"
 
 Example:
 
-.. sourcecode:: http
-
 Request:
 
     GET /persons/1?include=computers HTTP/1.1
@@ -81,8 +79,6 @@ You can even follow relationships with include
 
 Example:
 
-.. sourcecode:: http
-
 Request:
 
     GET /persons/1?include=computers.owner HTTP/1.1

docs/index.rst

@@ -12,7 +12,7 @@ Main concepts
    :width: 600px
    :alt: Architecture
 
-| * `JSON API 1.0 specification <http://jsonapi.org/>`_: it is a very popular specification about client server interactions for REST JSON API. It helps you to work in team because it is a very precise and sharable. Thanks to this specification your server will offer lot of features for clients like a strong structure of request and response, filtering, pagination, sparse fieldsets, including related resources, great error formatting etc.
+| * `JSON API 1.0 specification <http://jsonapi.org/>`_: it is a very popular specification about client server interactions for REST JSON API. It helps you to work in team because it is very precise and sharable. Thanks to this specification your api offers lot of features like a strong structure of request and response, filtering, pagination, sparse fieldsets, including related objects, great error formatting etc.
 | 
 | * **Logical data abstration**: you usually need to expose resources to clients that don't fit your data table architecture. For example sometimes you don't want to expose all attributes of a table, compute additional attributes or create a resource that use data from multiple data storage. Flask-REST-JSONAPI helps you to create a logical abstraction of your data with `Marshmallow <https://marshmallow.readthedocs.io/en/latest/>`_ / `marshmallow-jsonapi <https://marshmallow-jsonapi.readthedocs.io/>`_ so you can expose your data through a very flexible way.
 | 

docs/resource_manager.rst

@@ -7,7 +7,7 @@ Resource Manager
 
 Resource manager is the link between your logical data abstraction, your data layer and optionally other softwares. It is the place where logic management of your resource is located.
 
-Flask-REST-JSONAPI provides 3 kind of resource manager with default methods implementation according to JSONAPI 1.0 specification:
+Flask-REST-JSONAPI provides 3 kinds of resource manager with default methods implementation according to JSONAPI 1.0 specification:
 
 | * **ResourceList**: provides get and post methods to retrieve a collection of objects or create one.
 |
@@ -32,6 +32,7 @@ Example:
     from flask_rest_jsonapi import ResourceList
     from your_project.schemas import PersonSchema
     from your_project.models import Person
+    from your_project.extensions import db
 
     class PersonList(ResourceList):
         schema = PersonSchema
@@ -48,28 +49,28 @@ All resource mangers are inherited from flask.views.MethodView so you can provid
 
 You can plug additional decorators to each methods with this optional attributes:
 
-    :get_decorators: a list a decorators plugged to the get method of the resource manager
-    :post_decorators: a list a decorators plugged to the post method of the resource manager
-    :patch_decorators: a list a decorators plugged to the patch method of the resource manager
-    :delete_decorators: a list a decorators plugged to the delete method of the resource manager
+    :get_decorators: a list a decorators plugged to the get method
+    :post_decorators: a list a decorators plugged to the post method
+    :patch_decorators: a list a decorators plugged to the patch method
+    :delete_decorators: a list a decorators plugged to the delete method
 
 You can also provides default schema kwargs to each resource manager methods with this optional attributes:
 
-    :get_schema_kwargs: a dict of default schema instance kwargs in get method
-    :post_schema_kwargs: a dict of default schema instance kwargs in post method
-    :patch_schema_kwargs: a dict of default schema instance kwargs in patch method
-    :delete_schema_kwargs: a dict of default schema instance kwargs in delete method
+    :get_schema_kwargs: a dict of default schema kwargs in get method
+    :post_schema_kwargs: a dict of default schema kwargs in post method
+    :patch_schema_kwargs: a dict of default schema kwargs in patch method
+    :delete_schema_kwargs: a dict of default schema kwargs in delete method
 
 Each method of a resource manager got a pre and post process methods that take view args and kwargs as parameter for the pre process methods and the result of the method as parameter for the post process method. Thanks to this you can make custom work before and after the method process. Availables rewritable methods are:
 
-    :before_get(*args, **kwargs): pre process method of the get method
-    :after_get(result): post process method of the get method
-    :before_post(*args, **kwargs): pre process method of the post method
-    :after_post(result): post process method of the post method
-    :before_patch(*args, **kwargs): pre process method of the patch method
-    :after_patch(result): post process method of the patch method
-    :before_delete(*args, **kwargs): pre process method of the delete method
-    :after_delete(result): post process method of the delete method
+    :before_get: pre process method of the get method
+    :after_get: post process method of the get method
+    :before_post: pre process method of the post method
+    :after_post: post process method of the post method
+    :before_patch: pre process method of the patch method
+    :after_patch: post process method of the patch method
+    :before_delete: pre process method of the delete method
+    :after_delete: post process method of the delete method
 
 Example:
 
@@ -80,6 +81,7 @@ Example:
     from your_project.models import Person
     from your_project.security import login_required
     from your_project.decorators import dummy_decorator
+    from your_project.extensions import db
 
     class PersonList(ResourceDetail):
         schema = PersonSchema
@@ -88,9 +90,14 @@ Example:
         methods = ['GET', 'PATCH']
         decorators = (login_required, )
         get_decorators = [dummy_decorator]
+        get_schema_kwargs = {'only': ('name', )}
 
         def before_patch(*args, **kwargs):
-           """Make custom work here. View args and kwargs are provided as parameter 
+           """Make custom work here. View args and kwargs are provided as parameter
+           """
+
+        def after_patch(result):
+           """Make custom work here. Add something to the result of the view.
            """
 
 ResourceList
@@ -105,6 +112,9 @@ Example:
 .. code-block:: python
 
     from flask_rest_jsonapi import ResourceList
+    from your_project.schemas import PersonSchema
+    from your_project.models import Person
+    from your_project.extensions import db
 
     class PersonList(ResourceList):
         schema = PersonSchema
@@ -123,6 +133,9 @@ Example:
 .. code-block:: python
 
     from flask_rest_jsonapi import ResourceDetail
+    from your_project.schemas import PersonSchema
+    from your_project.models import Person
+    from your_project.extensions import db
 
     class PersonDetail(ResourceDetail):
         schema = PersonSchema
@@ -131,7 +144,7 @@ Example:
 
 This minimal ResourceDetail configuration provides GET, PATCH and DELETE interface to retrieve details of objects, update an objects and delete an object with all powerful features like sparse fieldsets and including related objects.
 
-If your schema has relationship(s) field(s) you can update an object and also link(s) to his related object(s) in the same time. If you want to see example go to  :ref:`quickstart`.
+If your schema has relationship(s) field(s) you can update an object and also update his link(s) to related object(s) in the same time. If you want to see example go to  :ref:`quickstart`.
 
 ResourceRelationship
 --------------------
@@ -141,6 +154,9 @@ Example:
 .. code-block:: python
 
     from flask_rest_jsonapi import ResourceRelationship
+    from your_project.schemas import PersonSchema
+    from your_project.models import Person
+    from your_project.extensions import db
 
     class PersonRelationship(ResourceRelationship):
         schema = PersonSchema

docs/routing.rst

@@ -5,7 +5,7 @@ Routing
 
 .. currentmodule:: flask_rest_jsonapi
 
-The routing system is very simple and fits this pattern:
+The routing system is very simple and fits this pattern ::
 
     api.route(<Resource manager>, <endpoint name>, <url_1>, <url_2>, ...)
 

docs/sparse_fieldsets.rst

@@ -46,4 +46,4 @@ Example:
 
 .. warning::
 
-    If you want to use both "fields" and "include" don't forget to specify the name of the relation in fields; if you don't the include wont work.
+    If you want to use both "fields" and "include" don't forget to specify the name of the relationship in fields; if you don't the include wont work.

setup.py

@@ -1,7 +1,7 @@
 from setuptools import setup, find_packages
 
 
-__version__ = '0.11.1'
+__version__ = '0.11.2'
 
 
 setup(