You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+71-69Lines changed: 71 additions & 69 deletions
Original file line number
Diff line number
Diff line change
@@ -8,12 +8,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
8
8
Note that in line with [Django REST Framework policy](http://www.django-rest-framework.org/topics/release-notes/),
9
9
any parts of the framework not mentioned in the documentation should generally be considered private API, and may be subject to change.
10
10
11
-
12
11
## [Unreleased]
13
12
14
13
### Added
15
14
16
-
* Add support for Django 2.1, DRF 3.9 and Python 3.7. Please note:
15
+
- Add support for Django 2.1, DRF 3.9 and Python 3.7. Please note:
17
16
- Django >= 2.1 is not supported with Python < 3.5.
18
17
19
18
### Deprecated
@@ -22,53 +21,54 @@ any parts of the framework not mentioned in the documentation should generally b
22
21
23
22
### Fixed
24
23
25
-
* Pass context from `PolymorphicModelSerializer` to child serializers to support fields which require a `request` context such as `url`.
26
-
* Avoid patch on `RelationshipView` deleting relationship instance when constraint would allow null ([#242](https://github.com/django-json-api/django-rest-framework-json-api/issues/242))
27
-
* Avoid error with related urls when retrieving relationship which is referenced as `ForeignKey` on parent
28
-
24
+
- Pass context from `PolymorphicModelSerializer` to child serializers to support fields which require a `request` context such as `url`.
25
+
- Avoid patch on `RelationshipView` deleting relationship instance when constraint would allow null ([#242](https://github.com/django-json-api/django-rest-framework-json-api/issues/242))
26
+
- Avoid error with related urls when retrieving relationship which is referenced as `ForeignKey` on parent
27
+
- No longer show `write_only` relation fields
29
28
30
29
## [2.6.0] - 2018-09-20
31
30
32
31
### Added
33
32
34
-
* Add testing configuration to `REST_FRAMEWORK` configuration as described in [DRF](https://www.django-rest-framework.org/api-guide/testing/#configuration)
35
-
* Add `HyperlinkedRelatedField` and `SerializerMethodHyperlinkedRelatedField`. See [usage docs](docs/usage.md#related-fields)
36
-
* Add related urls support. See [usage docs](docs/usage.md#related-urls)
37
-
* Add optional [jsonapi-style](http://jsonapi.org/format/) filter backends. See [usage docs](docs/usage.md#filter-backends)
33
+
- Add testing configuration to `REST_FRAMEWORK` configuration as described in [DRF](https://www.django-rest-framework.org/api-guide/testing/#configuration)
34
+
- Add `HyperlinkedRelatedField` and `SerializerMethodHyperlinkedRelatedField`. See [usage docs](docs/usage.md#related-fields)
35
+
- Add related urls support. See [usage docs](docs/usage.md#related-urls)
36
+
- Add optional [jsonapi-style](http://jsonapi.org/format/) filter backends. See [usage docs](docs/usage.md#filter-backends)
38
37
39
38
### Deprecated
40
39
41
-
* Deprecate `MultipleIDMixin` because it doesn't comply with the JSON:API 1.0 spec. Replace it with
40
+
- Deprecate `MultipleIDMixin` because it doesn't comply with the JSON:API 1.0 spec. Replace it with
42
41
`DjangoFilterBackend` and **change clients** to use `filter[id.in]` query parameter instead of `ids[]`.
43
42
See [usage docs](docs/usage.md#djangofilterbackend). You also have the option to copy the mixin into your code.
44
43
45
44
### Changed
46
45
47
-
* Replaced binary `drf_example` sqlite3 db with a [fixture](example/fixtures/drf_example.json). See [getting started](docs/getting-started.md#running-the-example-app).
48
-
* Replaced unmaintained [API doc](docs/api.md) with [auto-generated API reference](docs/api.rst).
46
+
- Replaced binary `drf_example` sqlite3 db with a [fixture](example/fixtures/drf_example.json). See [getting started](docs/getting-started.md#running-the-example-app).
47
+
- Replaced unmaintained [API doc](docs/api.md) with [auto-generated API reference](docs/api.rst).
49
48
50
49
### Fixed
51
50
52
-
* Performance improvement when rendering relationships with `ModelSerializer`
53
-
* Do not show deprecation warning when user has implemented custom pagination class overwriting default values.
54
-
51
+
- Performance improvement when rendering relationships with `ModelSerializer`
52
+
- Do not show deprecation warning when user has implemented custom pagination class overwriting default values.
55
53
56
54
## [2.5.0] - 2018-07-11
57
55
58
56
### Added
59
57
60
-
* Add new pagination classes based on JSON:API query parameter *recommendations*:
61
-
*`JsonApiPageNumberPagination` and `JsonApiLimitOffsetPagination`. See [usage docs](docs/usage.md#pagination).
62
-
* Add `ReadOnlyModelViewSet` extension with prefetch mixins
63
-
* Add support for Django REST Framework 3.8.x
64
-
* Introduce `JSON_API_FORMAT_FIELD_NAMES` option replacing `JSON_API_FORMAT_KEYS` but in comparison preserving
58
+
- Add new pagination classes based on JSON:API query parameter _recommendations_:
59
+
-`JsonApiPageNumberPagination` and `JsonApiLimitOffsetPagination`. See [usage docs](docs/usage.md#pagination).
60
+
- Add `ReadOnlyModelViewSet` extension with prefetch mixins
61
+
- Add support for Django REST Framework 3.8.x
62
+
- Introduce `JSON_API_FORMAT_FIELD_NAMES` option replacing `JSON_API_FORMAT_KEYS` but in comparison preserving
65
63
values from being formatted as attributes can contain any [json value](http://jsonapi.org/format/#document-resource-object-attributes).
66
-
* Allow overwriting of `get_queryset()` in custom `ResourceRelatedField`
64
+
- Allow overwriting of `get_queryset()` in custom `ResourceRelatedField`
67
65
68
66
### Deprecated
69
67
70
-
* Deprecate `PageNumberPagination` and `LimitOffsetPagination`. Use `JsonApiPageNumberPagination` and `JsonApiLimitOffsetPagination` instead.
71
-
* To retain deprecated values for `PageNumberPagination` and `LimitOffsetPagination` create new custom class like the following in your code base:
68
+
- Deprecate `PageNumberPagination` and `LimitOffsetPagination`. Use `JsonApiPageNumberPagination` and `JsonApiLimitOffsetPagination` instead.
69
+
70
+
- To retain deprecated values for `PageNumberPagination` and `LimitOffsetPagination` create new custom class like the following in your code base:
0 commit comments