Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 5da257f

Browse files
author
David Vogt
committedNov 29, 2018
Changelog / Authors update for write_only fixes
1 parent 7eb5858 commit 5da257f

File tree

2 files changed

+72
-69
lines changed

2 files changed

+72
-69
lines changed
 

‎AUTHORS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ Adam Ziolkowski <adam@adsized.com>
33
Alan Crosswell <alan@columbia.edu>
44
Anton Shutik <shutikanton@gmail.com>
55
Christian Zosel <https://zosel.ch>
6+
David Vogt <david.vogt@adfinis-sygroup.ch>
67
Greg Aker <greg@gregaker.net>
78
Jamie Bliss <astronouth7303@gmail.com>
89
Jerel Unruh <mail@unruhdesigns.com>

‎CHANGELOG.md

Lines changed: 71 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
88
Note that in line with [Django REST Framework policy](http://www.django-rest-framework.org/topics/release-notes/),
99
any parts of the framework not mentioned in the documentation should generally be considered private API, and may be subject to change.
1010

11-
1211
## [Unreleased]
1312

1413
### Added
1514

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:
1716
- Django >= 2.1 is not supported with Python < 3.5.
1817

1918
### Deprecated
@@ -22,53 +21,54 @@ any parts of the framework not mentioned in the documentation should generally b
2221

2322
### Fixed
2423

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
2928

3029
## [2.6.0] - 2018-09-20
3130

3231
### Added
3332

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)
3837

3938
### Deprecated
4039

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
4241
`DjangoFilterBackend` and **change clients** to use `filter[id.in]` query parameter instead of `ids[]`.
4342
See [usage docs](docs/usage.md#djangofilterbackend). You also have the option to copy the mixin into your code.
4443

4544
### Changed
4645

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).
4948

5049
### Fixed
5150

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.
5553

5654
## [2.5.0] - 2018-07-11
5755

5856
### Added
5957

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
6563
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`
6765

6866
### Deprecated
6967

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:
71+
7272
```python
7373
class CustomPageNumberPagination(PageNumberPagination):
7474
page_query_param = "page"
@@ -77,112 +77,114 @@ any parts of the framework not mentioned in the documentation should generally b
7777
class CustomLimitOffsetPagination(LimitOffsetPagination):
7878
max_limit = None
7979
```
80+
8081
and adjust `REST_FRAMEWORK['DEFAULT_PAGINATION_CLASS']` setting accordingly.
81-
* Deprecate `JSON_API_FORMAT_KEYS`, use `JSON_API_FORMAT_FIELD_NAMES`.
82+
83+
- Deprecate `JSON_API_FORMAT_KEYS`, use `JSON_API_FORMAT_FIELD_NAMES`.
8284

8385
### Fixed
8486

85-
* Performance improvement when rendering included data
87+
- Performance improvement when rendering included data
8688

8789
## [2.4.0] - 2018-01-25
8890

8991
### Added
9092

91-
* Add support for Django REST Framework 3.7.x.
92-
* Add support for Django 2.0.
93+
- Add support for Django REST Framework 3.7.x.
94+
- Add support for Django 2.0.
9395

9496
### Removed
9597

96-
* Drop support for Django 1.8 - 1.10 (EOL)
97-
* Drop support for Django REST Framework < 3.6.3
98+
- Drop support for Django 1.8 - 1.10 (EOL)
99+
- Drop support for Django REST Framework < 3.6.3
98100
(3.6.3 is the first to support Django 1.11)
99-
* Drop support for Python 3.3 (EOL)
100-
101+
- Drop support for Python 3.3 (EOL)
101102

102103
## [2.3.0] - 2017-11-28
103104

104105
### Added
105106

106-
* Add support for polymorphic models
107-
* Add nested included serializer support for remapped relations
107+
- Add support for polymorphic models
108+
- Add nested included serializer support for remapped relations
108109

109110
### Changed
110111

111-
* Enforcing flake8 linting
112+
- Enforcing flake8 linting
112113

113114
### Fixed
114-
* When `JSON_API_FORMAT_KEYS` is False (the default) do not translate request
115-
attributes and relations to snake\_case format. This conversion was unexpected
115+
116+
- When `JSON_API_FORMAT_KEYS` is False (the default) do not translate request
117+
attributes and relations to snake_case format. This conversion was unexpected
116118
and there was no way to turn it off.
117-
* Fix for apps that don't use `django.contrib.contenttypes`.
118-
* Fix `resource_name` support for POST requests and nested serializers
119+
- Fix for apps that don't use `django.contrib.contenttypes`.
120+
- Fix `resource_name` support for POST requests and nested serializers
119121

120122
## [2.2.0] - 2017-04-22
121123

122124
### Added
123125

124-
* Add support for Django REST Framework 3.5 and 3.6
125-
* Add support for Django 1.11
126-
* Add support for Python 3.6
126+
- Add support for Django REST Framework 3.5 and 3.6
127+
- Add support for Django 1.11
128+
- Add support for Python 3.6
127129

128130
## [2.1.1] - 2016-09-26
129131

130132
### Added
131133

132-
* Allow default DRF serializers to operate even when mixed with DRF-JA serializers
134+
- Allow default DRF serializers to operate even when mixed with DRF-JA serializers
133135

134136
### Fixed
135137

136-
* Avoid setting `id` to `None` in the parser simply because it's missing
137-
* Fix out of scope `relation_instance` variable in renderer
138-
* Fix wrong resource type for reverse foreign keys
139-
* Fix documentation typos
138+
- Avoid setting `id` to `None` in the parser simply because it's missing
139+
- Fix out of scope `relation_instance` variable in renderer
140+
- Fix wrong resource type for reverse foreign keys
141+
- Fix documentation typos
140142

141143
## [2.1.0] - 2016-08.18
142144

143145
### Added
144146

145-
* Parse `meta` in JSONParser
146-
* Add code coverage reporting and updated Django versions tested against
147-
* Add support for regular non-ModelSerializers
147+
- Parse `meta` in JSONParser
148+
- Add code coverage reporting and updated Django versions tested against
149+
- Add support for regular non-ModelSerializers
148150

149151
### Changed
150152

151-
* Documented built in `url` field for generating a `self` link in the `links` key
152-
* Convert `include` field names back to snake_case
153-
* Raise a `ParseError` if an `id` is not included in a PATCH request
153+
- Documented built in `url` field for generating a `self` link in the `links` key
154+
- Convert `include` field names back to snake_case
155+
- Raise a `ParseError` if an `id` is not included in a PATCH request
154156

155157
### Fixed
156158

157-
* Fix Django 1.10 compatibility
158-
* Performance enhancements to reduce the number of queries in related payloads
159-
* Fix issue where related `SerializerMethodRelatedField` fields were not included even if in `include`
160-
* Fix bug that prevented `fields = ()` in a serializer from being valid
161-
* Fix stale data returned in PATCH to-one relation
159+
- Fix Django 1.10 compatibility
160+
- Performance enhancements to reduce the number of queries in related payloads
161+
- Fix issue where related `SerializerMethodRelatedField` fields were not included even if in `include`
162+
- Fix bug that prevented `fields = ()` in a serializer from being valid
163+
- Fix stale data returned in PATCH to-one relation
162164

163165
## [2.0.1] - 2016-05-02
164166

165167
### Fixed
166168

167-
* Fixes naming error that caused ModelSerializer relationships to fail
169+
- Fixes naming error that caused ModelSerializer relationships to fail
168170

169171
## [2.0.0] - 2016-04-29
170172

171173
### Added
172174

173-
* Add `get_related_field_name` for views subclassing RelationshipView to override
174-
* Added LimitOffsetPagination
175-
* Support deeply nested `?includes=foo.bar.baz` without returning intermediate models (bar)
176-
* Allow a view's serializer_class to be fetched at runtime via `get_serializer_class`
177-
* Added support for `get_root_meta` on list serializers
175+
- Add `get_related_field_name` for views subclassing RelationshipView to override
176+
- Added LimitOffsetPagination
177+
- Support deeply nested `?includes=foo.bar.baz` without returning intermediate models (bar)
178+
- Allow a view's serializer_class to be fetched at runtime via `get_serializer_class`
179+
- Added support for `get_root_meta` on list serializers
178180

179181
### Changed
180182

181-
* Exception handler can now easily be used on DRF-JA views alongside regular DRF views
182-
* Rename `JSON_API_FORMAT_RELATION_KEYS` to `JSON_API_FORMAT_TYPES` to match what it was actually doing
183-
* Rename `JSON_API_PLURALIZE_RELATION_TYPE` to `JSON_API_PLURALIZE_TYPES`
184-
* Documented ResourceRelatedField and RelationshipView
183+
- Exception handler can now easily be used on DRF-JA views alongside regular DRF views
184+
- Rename `JSON_API_FORMAT_RELATION_KEYS` to `JSON_API_FORMAT_TYPES` to match what it was actually doing
185+
- Rename `JSON_API_PLURALIZE_RELATION_TYPE` to `JSON_API_PLURALIZE_TYPES`
186+
- Documented ResourceRelatedField and RelationshipView
185187

186188
### Fixed
187189

188-
* Fixes bug where write_only fields still had their keys rendered
190+
- Fixes bug where write_only fields still had their keys rendered

0 commit comments

Comments
 (0)
Please sign in to comment.