Skip to content

Commit 96b3531

Browse files
author
Ryan P Kilby
committed
Add release notes for dynamic action changes
1 parent 23bf8cc commit 96b3531

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs/topics/release-notes.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,31 @@ You can determine your currently installed version using `pip freeze`:
3838

3939
---
4040

41+
## 3.8.x series
42+
43+
### 3.8.0
44+
45+
**Date**: [unreleased][3.8.0-milestone]
46+
47+
* Refactor dynamic route generation and improve viewset action introspectibility. [#5705][gh5705]
48+
49+
`ViewSet`s have been provided with new attributes and methods that allow
50+
it to introspect its set of actions and the details of the current action.
51+
52+
* Merged `list_route` and `detail_route` into a single `action` decorator.
53+
* Get all extra actions on a `ViewSet` with `.get_extra_actions()`.
54+
* Extra actions now set the `url_name` and `url_path` on the decorated method.
55+
* Enable action url reversing through `.reverse_action()` method (added in 3.7.4)
56+
* Example reverse call: `self.reverse_action(self.custom_action.url_name)`
57+
* Add `detail` initkwarg to indicate if the current action is operating on a
58+
collection or a single instance.
59+
60+
Additional changes:
61+
62+
* Deprecated `list_route` & `detail_route` in favor of `action` decorator with `detail` boolean.
63+
* Deprecated dynamic list/detail route variants in favor of `DynamicRoute` with `detail` boolean.
64+
* Refactored the router's dynamic route generation.
65+
4166
## 3.7.x series
4267

4368
### 3.7.7
@@ -947,6 +972,7 @@ For older release notes, [please see the version 2.x documentation][old-release-
947972
[3.7.5-milestone]: https://github.com/encode/django-rest-framework/milestone/63?closed=1
948973
[3.7.6-milestone]: https://github.com/encode/django-rest-framework/milestone/64?closed=1
949974
[3.7.7-milestone]: https://github.com/encode/django-rest-framework/milestone/65?closed=1
975+
[3.8.0-milestone]: https://github.com/encode/django-rest-framework/milestone/61?closed=1
950976

951977
<!-- 3.0.1 -->
952978
[gh2013]: https://github.com/encode/django-rest-framework/issues/2013
@@ -1760,3 +1786,6 @@ For older release notes, [please see the version 2.x documentation][old-release-
17601786
[gh5695]: https://github.com/encode/django-rest-framework/issues/5695
17611787
[gh5696]: https://github.com/encode/django-rest-framework/issues/5696
17621788
[gh5697]: https://github.com/encode/django-rest-framework/issues/5697
1789+
1790+
<!-- 3.8.0 -->
1791+
[gh5705]: https://github.com/encode/django-rest-framework/issues/5705

0 commit comments

Comments
 (0)