Add update to CHANGELOG.md

Signed-off-by: Mehdy Khoshnoody <[email protected]>

Author: mehdy

CHANGELOG.md

@@ -15,6 +15,7 @@ any parts of the framework not mentioned in the documentation should generally b
 * Adjusted error messages to correctly use capital "JSON:API" abbreviation as used in the specification.
 * Avoid error when `parser_context` is `None` while parsing.
 * Raise comprehensible error when reserved field names `meta` and `results` are used.
+* Use `relationships` in the `pointer` when the field is actually a relationship.
 
 ### Changed
 
@@ -43,11 +44,13 @@ any parts of the framework not mentioned in the documentation should generally b
 * Allow `get_serializer_class` to be overwritten when using related urls without defining `serializer_class` fallback
 * Preserve field names when no formatting is configured.
 * Properly support `JSON_API_FORMAT_RELATED_LINKS` setting in related urls. In case you want to use `dasherize` for formatting links make sure that your url pattern matches dashes as well like following example:
+
   ```
   url(r'^orders/(?P<pk>[^/.]+)/(?P<related_field>[-\w]+)/$',
       OrderViewSet.as_view({'get': 'retrieve_related'}),
       name='order-related'),
   ```
+
 * Ensure default `included_resources` are considered when calculating prefetches.
 * Avoided error when using `include` query parameter on related urls (a regression since 4.1.0)
 
@@ -69,7 +72,6 @@ any parts of the framework not mentioned in the documentation should generally b
 * Correctly resolve the resource type of `ResourceRelatedField(many=True)` fields on plain serializers
 * Render `meta_fields` in included resources
 
-
 ## [4.0.0] - 2020-10-31
 
 This release is not backwards compatible. For easy migration best upgrade first to version
@@ -81,16 +83,17 @@ This release is not backwards compatible. For easy migration best upgrade first
 * Added support for Django 3.1.
 * Added support for Python 3.9.
 * Added initial optional support for [openapi](https://www.openapis.org/) schema generation. Enable with:
+
   ```
   pip install djangorestframework-jsonapi['openapi']
   ```
+
   This first release is a start at implementing OAS schema generation. To use the generated schema you may
   still need to manually add some schema attributes but can expect future improvements here and as
   upstream DRF's OAS schema generation continues to mature.
 
 ### Removed
 
-
 * Removed support for Python 3.5.
 * Removed support for Django 1.11.
 * Removed support for Django 2.1.
@@ -110,7 +113,7 @@ This is the last release supporting Django 1.11, Django 2.1, Django REST framewo
 ### Added
 
 * Added support for serializing nested serializers as attribute json value introducing setting `JSON_API_SERIALIZE_NESTED_SERIALIZERS_AS_ATTRIBUTE`
- * Note: As keys of nested serializers are not JSON:API spec field names they are not inflected by format field names option.
+* Note: As keys of nested serializers are not JSON:API spec field names they are not inflected by format field names option.
 * Added `rest_framework_json_api.serializer.Serializer` class to support initial JSON:API views without models.
   * Note that serializers derived from this class need to define `resource_name` in their `Meta` class.
   * This fix might be a **BREAKING CHANGE** if you use `rest_framework_json_api.serializers.Serializer` for non JSON:API spec views (usually `APIView`). You need to change those serializers classes to use `rest_framework.serializers.Serializer` instead.
@@ -125,15 +128,14 @@ This is the last release supporting Django 1.11, Django 2.1, Django REST framewo
 ### Changed
 
 * `SerializerMethodResourceRelatedField` is now consistent with DRF `SerializerMethodField`:
-   * Pass `method_name` argument to specify method name. If no value is provided, it defaults to `get_{field_name}`
+  * Pass `method_name` argument to specify method name. If no value is provided, it defaults to `get_{field_name}`
 * Allowed repeated filter query parameters.
 
 ### Deprecated
 
 * Deprecate `source` argument of `SerializerMethodResourceRelatedField`, use `method_name` instead
 * Rendering nested serializers as relationships is deprecated. Use `ResourceRelatedField` instead
 
-
 ## [3.1.0] - 2020-02-08
 
 ### Added
@@ -163,6 +165,7 @@ This release is not backwards compatible. For easy migration best upgrade first
 
 * Moved dependency definition for `django-polymorphic` and `django-filter` into extra requires.
   Hence dependencies of each optional module can be installed with pip using
+
   ```
   pip install djangorestframework-jsonapi['django-polymorphic']
   pip install djangorestframework-jsonapi['django-filter']
@@ -187,7 +190,6 @@ This release is not backwards compatible. For easy migration best upgrade first
 * Avoid exception when using `ResourceIdentifierObjectSerializer` with unexisting primary key.
 * Format metadata field names correctly for OPTIONS request.
 
-
 ## [2.8.0] - 2019-06-13
 
 This is the last release supporting Python 2.7, Python 3.4, Django Filter 1.1, Django REST framework <=3.9 and Django 2.0.
@@ -221,7 +223,7 @@ This is the last release supporting Python 2.7, Python 3.4, Django Filter 1.1, D
 ### Added
 
 * Add support for Django 2.1, DRF 3.9 and Python 3.7. Please note:
-  - Django >= 2.1 is not supported with Python < 3.5.
+  * Django >= 2.1 is not supported with Python < 3.5.
 
 ### Fixed
 
@@ -259,7 +261,6 @@ This is the last release supporting Python 2.7, Python 3.4, Django Filter 1.1, D
 * Performance improvement when rendering relationships with `ModelSerializer`
 * Do not show deprecation warning when user has implemented custom pagination class overwriting default values.
 
-
 ## [2.5.0] - 2018-07-11
 
 ### Added
@@ -276,6 +277,7 @@ This is the last release supporting Python 2.7, Python 3.4, Django Filter 1.1, D
 
 * Deprecate `PageNumberPagination` and `LimitOffsetPagination`. Use `JsonApiPageNumberPagination` and `JsonApiLimitOffsetPagination` instead.
   * To retain deprecated values for `PageNumberPagination` and `LimitOffsetPagination` create new custom class like the following in your code base:
+
   ```python
   class CustomPageNumberPagination(PageNumberPagination):
     page_query_param = "page"
@@ -284,6 +286,7 @@ This is the last release supporting Python 2.7, Python 3.4, Django Filter 1.1, D
   class CustomLimitOffsetPagination(LimitOffsetPagination):
     max_limit = None
   ```
+
   and adjust `REST_FRAMEWORK['DEFAULT_PAGINATION_CLASS']` setting accordingly.
 * Deprecate `JSON_API_FORMAT_KEYS`, use `JSON_API_FORMAT_FIELD_NAMES`.
 
@@ -305,7 +308,6 @@ This is the last release supporting Python 2.7, Python 3.4, Django Filter 1.1, D
   (3.6.3 is the first to support Django 1.11)
 * Drop support for Python 3.3 (EOL)
 
-
 ## [2.3.0] - 2017-11-28
 
 ### Added
@@ -318,6 +320,7 @@ This is the last release supporting Python 2.7, Python 3.4, Django Filter 1.1, D
 * Enforcing flake8 linting
 
 ### Fixed
+
 * When `JSON_API_FORMAT_KEYS` is False (the default) do not translate request
   attributes and relations to snake\_case format. This conversion was unexpected
   and there was no way to turn it off.