docs updated

Author: barseghyanartur

README.rst

@@ -49,6 +49,7 @@ Main features and highlights
 - :doc:`Geo-spatial ordering filter backend <advanced_usage_examples>` (the
   following filters implemented: ``geo_distance``).
 - :doc:`Faceted search filter backend <advanced_usage_examples>`.
+- :doc:`Post-filter filter backend <advanced_usage_examples>`.
 - :doc:`Nested filtering filter backend <nested_fields_usage_examples>`.
 - :doc:`Highlight backend <advanced_usage_examples>`.
 - :doc:`Suggester filter backend <advanced_usage_examples>`.

ROADMAP.rst

@@ -2,11 +2,6 @@ Roadmap
 =======
 Road-map/upcoming releases.
 
-0.7
----
-yyyy-mm-dd (future)
-
-- Improved geo-spatial search/filtering/ordering support.
-- All filters (mentioned in the ``constants`` module) implemented.
-- Aggregations (also for geo-spatial backends).
-- Awesome documentation.
+See `GitHub issues
+<https://github.com/barseghyanartur/django-elasticsearch-dsl-drf/issues>`_
+for a complete list of TODOs.

advanced_usage_examples.rst

@@ -759,6 +759,130 @@ In the example below, we show results with faceted ``state`` and
 
     http://127.0.0.1:8000/search/books/?facet=state&facet=pages_count
 
+Post-filter
+-----------
+The `post_filter` is very similar to the common filter. The only difference
+is that it doesn't affect facets. So, whatever post-filters applied, the
+numbers in facets will remain intact.
+
+Sample view
+~~~~~~~~~~~
+.. note::
+
+    Note the ``PostFilterFilteringFilterBackend`` and ``post_filter_fields``
+    usage.
+
+*search_indexes/viewsets/book.py*
+
+.. code-block:: python
+
+    # ...
+
+    from django_elasticsearch_dsl_drf.filter_backends import (
+        # ...
+        PostFilterFilteringFilterBackend,
+    )
+
+    # ...
+
+    class BookDocumentView(DocumentViewSet):
+        """The BookDocument view."""
+
+        document = BookDocument
+        serializer_class = BookDocumentSerializer
+        lookup_field = 'id'
+        filter_backends = [
+            FilteringFilterBackend,
+            OrderingFilterBackend,
+            DefaultOrderingFilterBackend,
+            SearchFilterBackend,
+            PostFilterFilteringFilterBackend,
+        ]
+        # Define search fields
+        search_fields = (
+            'title',
+            'summary',
+            'description',
+        )
+        # Define filtering fields
+        filter_fields = {
+            'id': {
+                'field': '_id',
+                'lookups': [
+                    LOOKUP_FILTER_RANGE,
+                    LOOKUP_QUERY_IN,
+                ],
+            },
+            'publisher': 'publisher.raw',
+            'publication_date': 'publication_date',
+            'isbn': 'isbn.raw',
+            'tags': {
+                'field': 'tags',
+                'lookups': [
+                    LOOKUP_FILTER_TERMS,
+                    LOOKUP_FILTER_PREFIX,
+                    LOOKUP_FILTER_WILDCARD,
+                    LOOKUP_QUERY_IN,
+                    LOOKUP_QUERY_EXCLUDE,
+                ],
+            },
+            'tags.raw': {
+                'field': 'tags.raw',
+                'lookups': [
+                    LOOKUP_FILTER_TERMS,
+                    LOOKUP_FILTER_PREFIX,
+                    LOOKUP_FILTER_WILDCARD,
+                    LOOKUP_QUERY_IN,
+                    LOOKUP_QUERY_EXCLUDE,
+                ],
+            },
+        }
+        # Define post-filter filtering fields
+        post_filter_fields = {
+            'publisher_pf': 'publisher.raw',
+            'isbn_pf': 'isbn.raw',
+            'state_pf': 'state.raw',
+            'tags_pf': {
+                'field': 'tags',
+                'lookups': [
+                    LOOKUP_FILTER_TERMS,
+                    LOOKUP_FILTER_PREFIX,
+                    LOOKUP_FILTER_WILDCARD,
+                    LOOKUP_QUERY_IN,
+                    LOOKUP_QUERY_EXCLUDE,
+                ],
+            },
+        }
+        # Define ordering fields
+        ordering_fields = {
+            'id': 'id',
+            'title': 'title.raw',
+            'price': 'price.raw',
+            'state': 'state.raw',
+            'publication_date': 'publication_date',
+        }
+        # Specify default ordering
+        ordering = ('id', 'title',)
+
+Sample queries
+~~~~~~~~~~~~~~
+
+**Filter documents by field**
+
+Filter documents by field (``state``) "published".
+
+.. code-block:: text
+
+    http://127.0.0.1:8080/search/books/?state_pf=published
+
+**Filter documents by multiple fields**
+
+Filter documents by field (``states``) "published" and "in_progress".
+
+.. code-block:: text
+
+    http://127.0.0.1:8080/search/books/?state_pf__in=published|in_progress
+
 Geo-spatial features
 --------------------
 

setup.py

@@ -54,6 +54,13 @@
         'advanced_usage_examples.html#faceted-search'
         '>`_'.format(version)
     ),
+    (
+        ':doc:`Post-filter filter backend <advanced_usage_examples>`',
+        '`Post-filter filter backend <'
+        'http://django-elasticsearch-dsl-drf.readthedocs.io/en/{}/'
+        'advanced_usage_examples.html#post-filter'
+        '>`_'.format(version)
+    ),
     (
         ':doc:`Highlight backend <advanced_usage_examples>`',
         '`Highlight backend <'

src/django_elasticsearch_dsl_drf/tests/test_filtering_nested.py

@@ -554,7 +554,7 @@ def test_schema_fields_with_filter_fields_list(self):
         """Test schema field generator"""
         fields = self.backend.get_schema_fields(self.view)
         fields = [f.name for f in fields]
-        self.assertEqual(fields, list(self.view.filter_fields.keys()))
+        self.assertEqual(fields, list(self.view.nested_filter_fields.keys()))
 
     @unittest.skipIf(not CORE_API_AND_CORE_SCHEMA_ARE_INSTALLED,
                      CORE_API_AND_CORE_SCHEMA_MISSING_MSG)