encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-26 11:33:59 +03:00
Code Issues Packages Projects Releases Wiki Activity
7,781 Commits 18 Branches 132 Tags 105 MiB
6511b52cca
Commit Graph

62 Commits

Author SHA1 Message Date
Ryan P Kilby
0148a9f8da Improvements to ViewSet extra actions (#5605) 
* View suffix already set by initializer

* Add 'name' and 'description' attributes to ViewSet

ViewSets may now provide their `name` and `description` attributes
directly, instead of relying on view introspection to derive them.
These attributes may also be provided with the view's initkwargs.

The ViewSet `name` and `suffix` initkwargs are mutually exclusive.

The `action` decorator now provides the `name` and `description` to
the view's initkwargs. By default, these values are derived from the
method name and its docstring. The `name` may be overridden by providing
it as an argument to the decorator.

The `get_view_name` and `get_view_description` hooks now provide the
view instance to the handler, instead of the view class. The default
implementations of these handlers now respect the `name`/`description`.

* Add 'extra actions' to ViewSet & browsable APIs

* Update simple router tests

Removed old test logic around link/action decorators from `v2.3`. Also
simplified the test by making the results explicit instead of computed.

* Add method mapping to ViewSet actions

* Document extra action method mapping
 2018-07-06 10:33:10 +02:00
Ryan P Kilby
73203e6b59 Rework dynamic list/detail actions (#5705) 
* Merge list/detail route decorators into 'action'

* Merge dynamic routes, add 'detail' attribute

* Add 'ViewSet.get_extra_actions()'

* Refactor dynamic route checking & collection

* Refactor dynamic route generation

* Add 'ViewSet.detail' initkwarg

* Fixup schema test

* Add release notes for dynamic action changes

* Replace list/detail route decorators in tests

* Convert tabs to spaces in router docs

* Update docs

* Make 'detail' a required argument of 'action'

* Improve router docs
 2018-01-25 09:40:49 +01:00
Carlton Gibson
4bcbf691cf
Document ViewSet.action (#5685) 
Closes #2941

Provides example of adjusting permission by action.
 2017-12-19 12:06:57 +01:00
Ryan P Kilby
7855d3bd8b Add '.basename' and '.reverse_action()' to ViewSet (#5648) 
* Router sets 'basename' on ViewSet

* Add 'ViewSet.reverse_action()' method

* Test router setting initkwargs
 2017-12-04 11:55:49 +01:00
Xavier Ordoquy
703655bc65 Non model Viewset requires base_name when registering to router. 2017-05-19 23:35:25 +02:00
Nick Timkovich
51c6d23a05 Mention where the mixins live 
Ctrl-F on the ViewSets page doesn't show where the `mixins.SomeMixin...` classes come from.
 2017-03-19 17:17:37 -05:00
Anthony Lukach
3fdd6e1db5 Add .partial_update to ModelViewSet documentation 
The ModelViewSet inherits from the UpdateModelMixin, which provides the `.partial_update` method. This should be reflected in the documentation.
 2016-03-29 10:50:12 -06:00
Alexandre Cordeiro
deb2c9eb87 Fixed minor typo on viewsets.md 
I'm not sure how the contribution policy for the docs is, but I thought it'd be faster to issue a pull request than reaching out to you guys/creating an issue for something so simple. Hope it's not a problem :)
 2015-06-16 17:36:11 -03:00
Ernesto Chavez Sanchez
2b4dd739cc Fixed description for get_paginated_response method in generic-views and example using it with @list_route decorator in viewsets. 2015-05-03 22:00:05 +00:00
Ernesto Chavez Sanchez
0ffb0abe81 Document correct method usage for get_paginated_response in 3.x instead 
of old get_pagination_serializer only valid in 2.x
 2015-04-30 02:23:39 +00:00
Tymur Maryokhin
9d80335ac8 Remove '.model' shortcut from viewset docs. Refs #2486. Closes #2549. 2015-02-12 01:10:03 +01:00
James Cooke
f676569661 Small documentation fixes 
* Remove "you you" from viewsets API-guide
* Fix link from routers API-guide to viewsets API-guide
 2015-02-03 13:43:03 +00:00
Jeff Fein-Worton
39da9c7c86 minor typo in viewsets docs 2015-01-24 12:53:21 -08:00
Mark Henwood
9b468fba60 Amend ViewSet docs to warn of potential problem 
I went through this exact problem and so thought the docs might
benefit from a small hint at the appropriate point.
 2014-12-07 12:02:43 +00:00
Tom Christie
f13c0ebe69 Merge master 2014-11-25 16:27:00 +00:00
José Padilla
16d442dda3 Use MkDocs meta.source to render source code links 2014-11-25 12:44:11 +00:00
Tom Christie
2e726e22a3 request.DATA, request.FILES -> request.data 2014-11-25 11:42:43 +00:00
Tom Christie
0c65e028b6 Release notes 2014-08-19 23:25:12 +01:00
Tom Christie
e385a7b8eb Merge master 2014-08-19 10:11:10 +01:00
Tom Christie
8244c7cc33 Merge pull request #1711 from kdazzle/ModelViewSet-queryset-static-property 
Issue #1707: Add documentation to api-docs.viewsets
 2014-08-18 12:25:03 +01:00
Kyle
e40ffd60d4 Issue #1707 - Add documentation about the caching of GenericAPIView.queryset 
to the `queryset` property, `get_queryset()`, and do generic-views.md; remove
changes to the viewsets.md documentation from my last commit.
 2014-07-28 10:11:40 -07:00
Kyle Valade
48b02f016a Issue #1707: Add documentation to api-docs.viewsets notifying users 
that they should use the get_queryset() method when overriding a
ModelViewSet method, such as list(). Otherwise, since queryset is
a static property, the value will be cached for every instance of
that ViewSet.
 2014-07-27 14:01:43 -07:00
Xavier Ordoquy
2489e38a06 Merge remote-tracking branch 'origin/master' into 2.4.0 
Conflicts:
	.travis.yml
	docs/api-guide/viewsets.md
	rest_framework/serializers.py
	rest_framework/throttling.py
	tests/test_generics.py
	tests/test_serializers.py
	tox.ini
 2014-06-23 14:02:45 +02:00
Rodolfo Carvalho
31f63e1e55 Fix typo in docs 2014-06-02 11:06:03 +02:00
Xavier Ordoquy
d08536ad9d Merge remote-tracking branch 'origin/master' into 2.4.0 
Conflicts:
	.travis.yml
	docs/api-guide/fields.md
	docs/api-guide/routers.md
	docs/topics/release-notes.md
	rest_framework/authentication.py
	rest_framework/serializers.py
	rest_framework/templatetags/rest_framework.py
	rest_framework/tests/test_authentication.py
	rest_framework/tests/test_filters.py
	rest_framework/tests/test_hyperlinkedserializers.py
	rest_framework/tests/test_serializer.py
	rest_framework/tests/test_testing.py
	rest_framework/utils/encoders.py
	tox.ini
 2014-04-13 00:05:57 +02:00
Charlie Denton
40b148a2e4 Viewsets docs typo 
The docstring in the example said "update" instead of "create".
 2014-02-03 14:54:44 +00:00
Tom Christie
9c41c007af Merge branch 'master' into 2.4.0 
Conflicts:
	.travis.yml
	docs/api-guide/routers.md
	docs/topics/release-notes.md
	rest_framework/compat.py
 2013-12-13 16:32:34 +00:00
Tom Christie
3c3906e278 Clarify wording, fixes #1133. 2013-12-04 08:51:34 +00:00
Tom Christie
21cd638659 Merge master 2013-09-25 09:44:26 +01:00
Diego Ponciano
2a6a2013df small typo correction on ViewSet example code 2013-09-11 17:25:57 -03:00
Tom Christie
9a5b2eefa9 Merge master 2013-08-30 09:28:33 +01:00
Kristian Øllegaard
afee470aca More information on how actions are mapped to URLs in viewsets 2013-08-26 11:02:01 +02:00
Tom Christie
16ffdedd14 Merge master 2013-08-21 21:31:59 +01:00
Tom Christie
5e40e50f2b Include import paths throughout docs. 
Closes #1051.  Thanks to @pydanny for the report.
 2013-08-21 19:46:09 +01:00
Tom Christie
4292cc18fa Docs tweaking 2013-08-19 20:53:30 +01:00
Tom Christie
c607414f16 Merge 2013-08-19 20:36:18 +01:00
Eric Buehl
b676cce61f pedantic doc updates 2013-07-18 19:03:38 -07:00
Alex Burgel
eaae8fb2d9 Combined link_* and action_* decorators into detail_route and list_route, marked the originals as deprecated. 2013-07-15 18:35:13 -04:00
Alex Burgel
e14cbaf696 Changed collection_* decorators to list_* 2013-07-15 17:59:36 -04:00
Alex Burgel
57cf8b5fa4 Rework extra routes doc for better readability 2013-07-15 17:59:36 -04:00
Alex Burgel
5b11e23f6f Add docs for collection routes 2013-07-15 17:59:35 -04:00
Tom Christie
3eaad89c16 Docs fix 2013-07-15 21:23:34 +01:00
Yuri Prezument
77dd334026 Fix Mixin class name in viewsets docs example 2013-07-14 19:16:56 +03:00
Tom Christie
8d83ff8e6c Add decorator brackets back. Refs #941 2013-06-21 23:12:16 +01:00
Tom Christie
a68f473dd8 Brackets not required on decorator without arguments 2013-06-21 23:25:14 +02:00
Philip Douglas
f3529f1f4a Correct docs' incorrect usage of action decorator 
If you don't call it, it doesn't work.
 2013-06-21 16:26:28 +01:00
Ryan Kaskel
e483c4fed6 Remove pass statement before docstring. 2013-06-07 10:07:42 +01:00
Tom Christie
27d8b848bc Add notes on 'method' argument to '@action' decorator 2013-06-02 20:40:56 +01:00
Pascal Borreli
8f35ac4f93 Fixed typos 2013-05-28 15:09:23 +01:00
Sebastien Beal
b0201bcfbf Fix doc typo in UserViewSet example 2013-05-26 11:52:45 +09:00