prepare 0.11

Author: barseghyanartur

CHANGELOG.rst

@@ -17,18 +17,36 @@ are used for versioning (schema follows below):
 
 0.11
 ----
-yyyy-mm-dd (not released yet)
+2018-07-15
 
 .. note::
 
-    This release contains minor backwards incompatible changes.
-    You should update your code and other parts of your applications
-    that were relying on the complex queries using `|` and `:` in the
+    This release contains backwards incompatible changes.
+    You should update your Django code and front-end parts of your applications
+    that were relying on the complex queries using `|` and `:` chars in the
     GET params.
+
+.. note::
+
+    If you have used custom filter backends using `SEPARATOR_LOOKUP_VALUE`
+    `SEPARATOR_LOOKUP_COMPLEX_VALUE` or
+    `SEPARATOR_LOOKUP_COMPLEX_MULTIPLE_VALUE` constants or
+    `split_lookup_complex_value` helper method of the `FilterBackendMixin`,
+    you most likely want to run your functional tests to see if everything
+    still works.
+
+.. note::
+
     Do not keep things as they were in your own fork, since new search backends
     will use the `|` and `:` symbols differently.
 
-**Old**
+**Examples of old API requests vs new API requests**
+
+.. note::
+
+    Note, that `|` and `:` chars were mostly replaced with `__` and `,`.
+
+*Old API requests*
 
 .. code-block:: text
 
@@ -37,8 +55,9 @@ yyyy-mm-dd (not released yet)
     http://localhost:8000/api/articles/?id__terms=1|2|3
     http://localhost:8000/api/users/?age__range=16|67|2.0
     http://localhost:8000/api/articles/?id__in=1|2|3
+    http://localhost:8000/api/articles/?location__geo_polygon=40,-70|30,-80|20,-90|_name:myname|validation_method:IGNORE_MALFORMED
 
-**New**
+*New API requests*
 
 .. code-block:: text
 
@@ -47,15 +66,21 @@ yyyy-mm-dd (not released yet)
     http://localhost:8000/api/articles/?id__terms=1__2__3
     http://localhost:8000/api/users/?age__range=16__67__2.0
     http://localhost:8000/api/articles/?id__in=1__2__3
-
+    http://localhost:8000/api/articles/?location__geo_polygon=40,-70__30,-80__20,-90___name,myname__validation_method,IGNORE_MALFORMED
 
 - `SEPARATOR_LOOKUP_VALUE` has been removed. Use
   `SEPARATOR_LOOKUP_COMPLEX_VALUE` and
   `SEPARATOR_LOOKUP_COMPLEX_MULTIPLE_VALUE` instead.
 - `SEPARATOR_LOOKUP_NAME` has been added.
 - The method `split_lookup_complex_value` has been removed. Use
   `split_lookup_complex_value` instead.
-- Default filter lookup option is added.
+- Default filter lookup option is added. In past, if no specific lookup was
+  provided and there were multiple values for a single field to filter on, by
+  default `terms` filter was used. The `term` lookup was used by default
+  in similar situation for a single value to filter on. It's now possible to
+  declare default lookup which will be used when no lookup is given.
+- Removed deprecated `views` module. Import from `viewsets` instead.
+- Removed undocumented `get_count` helper from `helpers` module.
 
 0.10
 ----

docs/advanced_usage_examples.rst

@@ -517,11 +517,11 @@ Search in all fields (``title``, ``description`` and ``summary``) for word
 **Search a single term on specific field**
 
 In order to search in specific field (``title``) for term "education", add
-the field name separated with ``|`` to the search term.
+the field name separated with ``:`` to the search term.
 
 .. code-block:: text
 
-    http://127.0.0.1:8080/search/books/?search=title|education
+    http://127.0.0.1:8080/search/books/?search=title:education
 
 **Search for multiple terms**
 
@@ -536,11 +536,11 @@ multiple ``search`` query params.
 
 In order to search for multiple terms "education", "technology" in specific
 fields add multiple ``search`` query params and field names separated with
-``|`` to each of the search terms.
+``:`` to each of the search terms.
 
 .. code-block:: text
 
-    http://127.0.0.1:8080/search/books/?search=title|education&search=summary|technology
+    http://127.0.0.1:8080/search/books/?search=title:education&search=summary:technology
 
 **Search with boosting**
 
@@ -590,7 +590,7 @@ Filter documents by field (``states``) "published" and "in_progress".
 
 .. code-block:: text
 
-    http://127.0.0.1:8080/search/books/?state__in=published|in_progress
+    http://127.0.0.1:8080/search/books/?state__in=published__in_progress
 
 **Filter document by a single field**
 
@@ -607,7 +607,7 @@ with use of functional ``in`` query filter.
 
 .. code-block:: text
 
-    http://127.0.0.1:8080/search/books/?tags__in=education|economy
+    http://127.0.0.1:8080/search/books/?tags__in=education__economy
 
 You can achieve the same effect by specifying multiple fields (``tags``)
 "education" and "economy". Note, that in this case multiple filter terms are
@@ -644,15 +644,15 @@ Order documents by field ``price`` (ascending).
 
 .. code-block:: text
 
-    http://127.0.0.1:8080/search/books/?search=title|lorem&ordering=price
+    http://127.0.0.1:8080/search/books/?search=title:lorem&ordering=price
 
 **Order documents by field (descending)**
 
 Order documents by field ``price`` (descending).
 
 .. code-block:: text
 
-    http://127.0.0.1:8080/search/books/?search=title|lorem&ordering=-price
+    http://127.0.0.1:8080/search/books/?search=title:lorem&ordering=-price
 
 **Order documents by multiple fields**
 
@@ -662,15 +662,15 @@ the example below, documents would be ordered first by field
 
 .. code-block:: text
 
-    http://127.0.0.1:8080/search/books/?search=title|lorem&ordering=-publication_date&ordering=price
+    http://127.0.0.1:8080/search/books/?search=title:lorem&ordering=-publication_date&ordering=price
 
 Ids filter
 ----------
 Filters documents that only have the provided ids.
 
 .. code-block:: text
 
-    http://127.0.0.1:8000/api/articles/?ids=68|64|58
+    http://127.0.0.1:8000/api/articles/?ids=68__64__58
 
 Or, alternatively:
 
@@ -881,7 +881,7 @@ 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
+    http://127.0.0.1:8080/search/books/?state_pf__in=published__in_progress
 
 Geo-spatial features
 --------------------
@@ -900,23 +900,23 @@ Filter documents by radius of 100000km from the given location.
 
 .. code-block:: text
 
-    http://localhost:8000/search/publishers/?location__geo_distance=100000km|12.04|-63.93
+    http://localhost:8000/search/publishers/?location__geo_distance=100000km__12.04__-63.93
 
 **Geo-polygon filtering**
 
 Filter documents that are located in the given polygon.
 
 .. code-block:: text
 
-    http://localhost:8000/search/publishers/?location__geo_polygon=40,-70|30,-80|20,-90
+    http://localhost:8000/search/publishers/?location__geo_polygon=40,-70__30,-80__20,-90
 
 **Geo-bounding-box filtering**
 
 Filter documents that are located in the given bounding box.
 
 .. code-block:: text
 
-    http://localhost:8000/search/publishers/?location__geo_bounding_box=44.87,40.07|43.87,41.11
+    http://localhost:8000/search/publishers/?location__geo_bounding_box=44.87,40.07__43.87,41.11
 
 Ordering
 ~~~~~~~~
@@ -925,7 +925,7 @@ Ordering
 
 .. code-block:: text
 
-    http://localhost:8000/search/publishers/?ordering=location|48.85|2.30|km|plane
+    http://localhost:8000/search/publishers/?ordering=location__48.85__2.30__km__plane
 
 Suggestions
 -----------

docs/basic_usage_examples.rst

@@ -277,11 +277,11 @@ Search in all fields (``name``, ``address``, ``city``, ``state_province`` and
 **Search a single term on specific field**
 
 In order to search in specific field (``name``) for term "reilly", add
-the field name separated with ``|`` to the search term.
+the field name separated with ``:`` to the search term.
 
 .. code-block:: text
 
-    http://127.0.0.1:8080/search/publisher/?search=name|reilly
+    http://127.0.0.1:8080/search/publisher/?search=name:reilly
 
 **Search for multiple terms**
 
@@ -300,7 +300,7 @@ fields add multiple ``search`` query params and field names separated with
 
 .. code-block:: text
 
-    http://127.0.0.1:8080/search/publisher/?search=name|reilly&search=city|london
+    http://127.0.0.1:8080/search/publisher/?search=name:reilly&search=city:london
 
 Filtering
 ^^^^^^^^^
@@ -373,7 +373,7 @@ Filter documents by radius of 100000km from the given location.
 
 .. code-block:: text
 
-    http://127.0.0.1:8000/search/publishers/?location__geo_distance=100000km|12.04|-63.93
+    http://127.0.0.1:8000/search/publishers/?location__geo_distance=100000km__12.04__-63.93
 
 Ordering
 ^^^^^^^^
@@ -386,7 +386,7 @@ Filter documents by field ``city`` (ascending).
 
 .. code-block:: text
 
-    http://127.0.0.1:8080/search/publisher/?search=country|armenia&ordering=city
+    http://127.0.0.1:8080/search/publisher/?search=country:armenia&ordering=city
 
 **Order documents by field (descending)**
 

docs/changelog.rst

@@ -15,6 +15,73 @@ are used for versioning (schema follows below):
   0.3.4 to 0.4).
 - All backwards incompatible changes are mentioned in this document.
 
+0.11
+----
+2018-07-15
+
+.. note::
+
+    This release contains backwards incompatible changes.
+    You should update your Django code and front-end parts of your applications
+    that were relying on the complex queries using `|` and `:` chars in the
+    GET params.
+
+.. note::
+
+    If you have used custom filter backends using `SEPARATOR_LOOKUP_VALUE`
+    `SEPARATOR_LOOKUP_COMPLEX_VALUE` or
+    `SEPARATOR_LOOKUP_COMPLEX_MULTIPLE_VALUE` constants or
+    `split_lookup_complex_value` helper method of the `FilterBackendMixin`,
+    you most likely want to run your functional tests to see if everything
+    still works.
+
+.. note::
+
+    Do not keep things as they were in your own fork, since new search backends
+    will use the `|` and `:` symbols differently.
+
+**Examples of old API requests vs new API requests**
+
+.. note::
+
+    Note, that `|` and `:` chars were mostly replaced with `__` and `,`.
+
+*Old API requests*
+
+.. code-block:: text
+
+    http://127.0.0.1:8080/search/publisher/?search=name|reilly&search=city|london
+    http://127.0.0.1:8000/search/publishers/?location__geo_distance=100000km|12.04|-63.93
+    http://localhost:8000/api/articles/?id__terms=1|2|3
+    http://localhost:8000/api/users/?age__range=16|67|2.0
+    http://localhost:8000/api/articles/?id__in=1|2|3
+    http://localhost:8000/api/articles/?location__geo_polygon=40,-70|30,-80|20,-90|_name:myname|validation_method:IGNORE_MALFORMED
+
+*New API requests*
+
+.. code-block:: text
+
+    http://127.0.0.1:8080/search/publisher/?search=name:reilly&search=city:london
+    http://127.0.0.1:8000/search/publishers/?location__geo_distance=100000km__12.04__-63.93
+    http://localhost:8000/api/articles/?id__terms=1__2__3
+    http://localhost:8000/api/users/?age__range=16__67__2.0
+    http://localhost:8000/api/articles/?id__in=1__2__3
+    http://localhost:8000/api/articles/?location__geo_polygon=40,-70__30,-80__20,-90___name,myname__validation_method,IGNORE_MALFORMED
+
+- `SEPARATOR_LOOKUP_VALUE` has been removed. Use
+  `SEPARATOR_LOOKUP_COMPLEX_VALUE` and
+  `SEPARATOR_LOOKUP_COMPLEX_MULTIPLE_VALUE` instead.
+- `SEPARATOR_LOOKUP_NAME` has been added.
+- The method `split_lookup_complex_value` has been removed. Use
+  `split_lookup_complex_value` instead.
+- Default filter lookup option is added. In past, if no specific lookup was
+  provided and there were multiple values for a single field to filter on, by
+  default `terms` filter was used. The `term` lookup was used by default
+  in similar situation for a single value to filter on. It's now possible to
+  declare default lookup which will be used when no lookup is given.
+- Removed deprecated `views` module. Import from `viewsets` instead.
+- Removed undocumented `get_count` helper from `helpers` module.
+
 0.10
 ----
 2018-07-06