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

843 Commits

Author SHA1 Message Date
Laurent Bristiel
d8cb85ef8f typo 2014-04-28 22:00:36 +02:00
dpetzel
5e8f05a8de very minor typo in code example 2014-04-28 13:51:50 -04: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
Miro Hrončok
f68596a732 Document new UnicodeYAMLRenderer 2014-04-10 01:58:06 +02:00
Craig
3234a5dd6b Fix python syntax in filtering docs 2014-04-08 22:56:07 -04:00
Tom Christie
abe14c06f7 Minor docs tweak 2014-03-17 08:36:13 +00:00
Tom Christie
dddbff5931 Tweak DRF compound fields docs 2014-03-17 08:33:18 +00:00
Steven Cummings
c779dce3e4 Serializer fields section for 3rd-party packages 
* Add new section to serializer fields page where we can list and link 3rd-party packages that provide more field types
* Add an entry for drf-compound-fields
 2014-03-16 18:55:21 -05:00
Peter Inglesby
2353878951 Add SEARCH_PARAM and ORDERING_PARAM to settings 
Fixes #1434
 2014-03-06 21:39:44 +00:00
Kumar McMillan
c2cd610b15 Adds HawkREST to 3rd party auth docs 2014-02-28 16:52:47 -06:00
Kumar McMillan
a4470c4276 Fix trailing whitespace 
Sorry, my editor does this automatically
 2014-02-28 16:51:32 -06:00
Charlie Denton
c3967c08ab Minor docs example fix 
Dates are smaller when they happen before.
 2014-02-21 14:23:33 +00:00
Tom Christie
9841069373 Link to DRF-extensions. Refs #1430 2014-02-20 14:54:17 +00:00
Elvio Toccalino
1a4c6f075b include djangorestframework-httpsignature in the docs 2014-02-20 01:07:39 -03:00
Saurabh Kumar
b3aa512d35 fix(docs): fix code indentation in serializers.md 
It fixes the indentation of `restore_object()` in the section "Specifying which fields should be write-only" serializers documentation.
 2014-02-18 20:39:39 +05:30
Bo Peng
6f4c2c6f05 Update throttling.md 
Added comma to make DEFAULT_THROTTLE_CLASSES a tuple in example, for copy&paste to work nicely.
 2014-02-14 13:47:06 -06:00
Vita Smid
821f848802 Minor typos fixed in api-guide/testing.md (request -> response). 2014-02-14 10:44:02 +01:00
Hassan Shamim
97b7c25987 Replace 'detail' with 'default_detail' in Exceptions guide and APIException class docstring. 2014-02-10 12:54:56 -06:00
Andrey Kaygorodov
2d20512d25 #1390, docs, turning of pagination 2014-02-05 21:10:51 +08:00
Andrey Kaygorodov
d48ba1cff7 turn of pagination 2014-02-05 05:47:27 +08:00
RicterZ
ba8a0bac53 Fixed a bug backticks 
fix

    you may optionally exclude the ``self.check_object_permissions, and simply return the object from the `get_object_or_404` lookup.

to

    you may optionally exclude the `self.check_object_permissions`, and simply return the object from the `get_object_or_404` lookup.
 2014-02-04 23:41:13 +08: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
Jeff Fein-Worton
a33eb4177e fixed typo (wrong "its") 2014-02-02 21:21:08 -08:00
meoooh
e437854a44 Update fields.md 2014-02-01 15:02:11 +09:00
Tom Christie
fab531961b Merge pull request #1379 from bodylabs/exception_example 
Fix doc for custom exception sample
 2014-01-31 09:52:47 -08:00
Paul Melnikow
77ced39e6c Fix doc for custom exception sample 
The way to provide a default detail for APIException is to define a `default_detail` attribute on the subclass.

Defining a `detail` attribute without `default_detail` will not work, and will result in empty detail instead.
 2014-01-31 12:26:45 -05:00
Tom Christie
e3c5a13451 Drop django-rest-framework-bulk API descriptions 2014-01-19 21:09:49 +00:00
Tom Christie
96e6565be8 Merge pull request #1363 from miki725/master 
Added docs for bulk views from django-rest-framework-bulk.
 2014-01-19 13:08:12 -08:00
José Padilla
1c34051f5e Include the djangorestframework-jwt package 2014-01-18 23:51:18 -05:00
Miroslav Shubernetskiy
37cd49cac9 Added docs for bulk views from django-rest-framework-bulk. 2014-01-18 22:31:36 -05:00
Tom Christie
71c03b9db9 Security update to OrderingFilter 2014-01-15 14:27:41 +00:00
Tom Christie
d20c49da4a More HyperlinkedModelSerializer docs 2014-01-14 20:34:33 +00:00
Tom Christie
85d74fc86a Added write_only and write_only_fields. Refs #1306 2014-01-14 11:25:44 +00:00
Tom Christie
4ab97843e8 Merge pull request #1333 from bodylabs/2.4.0+lookup_regex 
Let viewsets specify their regex
 2014-01-13 07:34:58 -08:00
Yuri Prezument
6e622d644c CharField - add allow_null argument 2014-01-12 10:53:54 +02:00
Tom Christie
b61cef435e Merge pull request #1345 from bodylabs/serializers_doc 
serializers.md: Fix typos
 2014-01-10 05:25:21 -08:00
Paul Melnikow
4b8d1b66ab serializers.md: Fix typos 2014-01-10 08:22:47 -05:00
Yuri Prezument
052e236fde Fix URL/Slug Field signatures in docs 2014-01-09 18:12:30 +02:00
Tom Christie
78494401c5 Use www.django-rest-framework.org for docs instead of django-rest-framework.org due to issues with naked domains 2014-01-08 15:22:41 +00:00
Paul Melnikow
899381575a Fix a typo 2014-01-04 17:03:01 -05:00
Paul Melnikow
3cd15fb171 Router: Do not automatically adjust lookup_regex when trailing_slash is True 
BREAKING CHANGE

When trailing_slash is set to True, the router no longer will adjust the lookup regex to allow it to include periods. To simulate the old behavior, the programmer should specify `lookup_regex = '[^/]+'` on the viewset.

https://github.com/tomchristie/django-rest-framework/pull/1328#issuecomment-31517099
 2014-01-04 16:57:50 -05:00
Paul Melnikow
a1d7aa8f71 Allow viewset to specify lookup value regex for routing 
This patch allows a viewset to define a pattern for its lookup field, which the router will honor. Without this patch, any characters are allowed in the lookup field, and overriding this behavior requires subclassing router and copying and pasting the implementation of get_lookup_regex.

It's possible it would be better to remove this functionality from the routers and simply expose a parameter to get_lookup_regex which allows overriding the lookup_regex. That way the viewset config logic could be in the a subclass, which could invoke the super method directly.

I'm using this now for PostgreSQL UUID fields using https://github.com/dcramer/django-uuidfield . Without this patch, that field passes the lookup string to the database driver, which raises a DataError to complain about the invalid UUID. It's possible the field ought to signal this error in a different way, which could obviate the need to specify a pattern.
 2014-01-04 16:45:03 -05:00
Tom Christie
75e8724731 Fuller notes on the 'base_name' argument. Closes #1160. 2013-12-23 14:38:51 +00:00
Tom Christie
d24ea39a4e Added note on view_name in hyperlinked relationships. Closes #1221 2013-12-23 14:29:22 +00:00
Tom Christie
52686420f4 Merge branch 'bennbollay-patch-1' into 2.4.0 
Conflicts:
	.travis.yml
	docs/api-guide/routers.md
	rest_framework/compat.py
	tox.ini
 2013-12-23 09:48:59 +00:00
Tom Christie
bc0e994784 Added example of using APIException class. Closes #1300 2013-12-21 21:10:05 +00:00
Tom Christie
1f3ded4559 Docs tweaks 2013-12-21 17:18:25 +00:00
Vitaly Babiy
22343ee117 Added links to djangorestframework-camel-case in the third party 
sections of the docs for both parsers and renderers.
 2013-12-21 07:07:06 -05:00
Tom Christie
39dbea4da4 Links to drf-nested-routers 2013-12-13 20:27:17 +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
7e7336db91 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 
Conflicts:
	docs/api-guide/routers.md
 2013-12-13 09:04:54 +00:00
S. Andrew Sheppard
73e8536e0d third-party package: wq.db 2013-12-12 21:45:44 -06:00
Tom Christie
ed931b90ae Further docs tweaks 2013-12-13 00:11:59 +00:00
Tom Christie
83da4949c0 Allow NUM_PROXIES=0 and include more docs 2013-12-13 00:02:18 +00:00
Tom Christie
df2d9034c2 Add third party packages 2013-12-12 23:10:31 +00:00
OddBloke
4f473f0b9e Use get_user_model instead of User in Generating Tokens example 
Because that's a better way of doing it.
 2013-12-11 13:56:56 +00:00
OddBloke
5acefd3b17 Add full required imports to Generating Tokens example 
Previously we were missing User and post_save.
 2013-12-11 13:55:54 +00:00
David Ray
7382f8c6ad Update routers.md 
Reference to ```DefaultRouter``` should be ```SimpleRouter```
 2013-12-10 14:56:07 -05:00
Tom Christie
785a42cd5a Tweak REST condition text. 2013-12-10 08:38:43 +00:00
Maxim Kamenkov
9ba7be959c Added REST Condition to 3rd party permissions packages list. 2013-12-09 20:33:06 +02:00
Tom Christie
b599447b71 Merge pull request #1277 from Ian-Foote/master 
Fix typo "Not" -> "Note"
 2013-12-09 01:54:37 -08:00
Ian
de319f3e28 Fix typo "Not" -> "Note" 2013-12-09 09:53:16 +00:00
taras
3399158d62 RelatedField is function of serializer class 2013-12-08 11:40:40 -05:00
kahnjw
887da7f6c5 Add missing tick marks 2013-12-06 14:30:33 -08:00
kahnjw
196c5952e4 Fix typo 2013-12-06 14:24:16 -08:00
kahnjw
100a933279 Add documentation to explain what effect these changes have. 2013-12-06 14:22:08 -08:00
Tom Christie
910de38a9c Version 2.3.10 2013-12-06 22:13:50 +00:00
Tom Christie
f8088bedef Upgrade JSONP security warning. 2013-12-05 09:01:00 +00:00
Drew Kowalik
f2682537e0 fix broken documentation links 2013-12-04 16:10:05 -08:00
Tom Christie
3c3906e278 Clarify wording, fixes #1133. 2013-12-04 08:51:34 +00:00
Pablo Recio
699ec7236b Adds pre_delete and post_delete hooks on 2013-12-03 00:07:41 +00:00
Stephan Groß
850cd83ba7 Fix TemplateHTMLRenderer example 2013-12-02 11:44:04 +01:00
Omer Katz
c46106c961 Rephrased documentation changes according to feedback on IRC. 2013-11-27 14:47:37 +02:00
Omer Katz
2dce8d7a8a Recommend using Pillow instead of PIL. 2013-11-27 13:23:49 +02:00
Tom Christie
3765865b4b Update 'default' explanation. Closes #1239 2013-11-20 17:40:56 +00:00
Tom Christie
128bda5712 Use less specfic language in UltaJSON notes 2013-11-15 15:24:32 +00:00
Jacob Haslehurst
52ac2199a8 Added drf-ujson-renderer to renderers docs 
drf-ujson-renderer is a third party renderer that implements JSON renderering using UltraJSON
 2013-11-11 22:24:37 +11:00
Doğan Çeçen
fd2c291c4d Typo on api-guide/fields.md and serializers.py 2013-11-11 11:54:30 +02:00
erkarl
f72488d609 Updated OAuth2 authentication docs. 2013-10-31 03:47:23 +02:00
Kit Randel
7d5499bcac In the API test client example 'data' was not defined. There's also no 
need to define 'expected' as we can just test against the dict.
 2013-10-25 11:45:33 +13:00
Tom Christie
d1edef410d Merge pull request #1199 from yamila-moreno/get-filter-backends 
Added get_filter_backends method
 2013-10-24 07:29:21 -07:00
Yamila Moreno
82e9ddcf7a Added get_filter_backends method 2013-10-24 16:16:01 +02:00
Yamila
c92af2b1dd Typo on generic-views.md 2013-10-24 15:56:53 +02:00
Jacek Bzdak
cc9c7cd8a4 Small documentation fix 2013-10-22 13:15:48 +02:00
Jacek Bzdak
8fffc346c1 Merge remote-tracking branch 'origin/master' 2013-10-22 13:13:01 +02:00
Jacek Bzdak
25c9d552c0 Explained a bit more about django-filter implementation. 
Well, I spent some time trying to gues how djang-filter works, and
if this changes would be introduced, I would have saved this time.
 2013-10-22 13:11:14 +02:00
Tom Christie
76672787cd Added . Closes #1188. 2013-10-21 09:47:07 +01:00
Jesús Espino
ed9c3258a6 Remove the detail=None from APIException signature 
The documentation not match with the implementation. The APIException doesn't have detail parameter in the constructor class, actually doesn't have constructor method at all.
 2013-10-21 10:24:06 +02:00
Álvaro Lázaro
89ac03af26 Add missing commas in relations.md 2013-10-12 20:31:33 +02:00
Carlton Gibson
0bbc775b95 Merge pull request #1071 from craigds/field-transform-methods 
Feature: add transform_<fieldname> methods to serializers
 2013-10-09 01:11:46 -07:00
Omer Katz
ab4be47379 Fixed code example. 2013-10-03 17:34:34 +02:00
Tom Christie
afc9e9e038 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2013-10-03 15:18:47 +01:00
Tom Christie
f6301636fb Drop erronous left-over bit of docs. Closes #1147 2013-10-03 15:18:38 +01:00
Craig de Stigter
42bbf6907e docs: add paragraph on transform_fieldname methods 2013-10-03 12:38:42 +13:00
Doron Pearl
8a1d327579 corrected doc for throttle_classes decorator 
the decorator actually expects an array and otherwise raise an exception.
 2013-09-30 14:08:46 -04:00
Tom Christie
21cd638659 Merge master 2013-09-25 09:44:26 +01:00
Grzegorz Kapkowski
fda0c520bd Match docs to current code. 2013-09-23 16:10:46 +02:00
Tom Christie
895beb89c6 Note on '.model' as default only, with 'serializer_class', and 'queryset' attributes prefered. Closes #1100 2013-09-12 21:41:21 +01:00
Diego Ponciano
2a6a2013df small typo correction on ViewSet example code 2013-09-11 17:25:57 -03:00
Tom Christie
5970baa201 Tweaks and docs to object-level model permissions. 2013-09-10 21:00:13 +01:00
Tom Christie
b6c0c815aa Extra docs on custom exception handling. 2013-09-07 20:45:43 +01:00
Andy Freeland
bae0ef6b5d Add EXCEPTION_HANDLER docs to exception docs 2013-09-06 13:57:32 -05:00
Andy Freeland
b5523bcc7d Support customizable view EXCEPTION_HANDLER 
Add `api_settings.EXCEPTION_HANDLER` to support custom error responses.

Fixes #907.
 2013-09-06 12:47:33 -05:00
Tom Christie
916d8ab37d Fix typo 2013-09-06 12:19:51 +01:00
Tyler Hayes
c4cb26f73b Tiny typo fix 2013-09-04 03:38:34 -07:00
Kevin Brown
d0123a1385 Changed DOAC documentation link 2013-09-02 10:23:54 -04:00
Tom Christie
9a5b2eefa9 Merge master 2013-08-30 09:28:33 +01:00
Brett Koonce
da9c17067c minor sp 2013-08-29 09:23:34 -05:00
Tom Christie
bf07b8e616 Better docs for customizing dynamic routes. Refs #908 2013-08-29 08:53:19 +01:00
Andrey Antukh
2d37952e78 Add composed-permissions entry to the api-guide. 2013-08-29 00:52:07 +02:00
Tom Christie
97b52156cc Added .cache attribute on throttles. 
Closes #1066.  More localised than a new settings key, and more
flexible in that different throttles can use different behavior.
Thanks to @chicheng for the report! :)
 2013-08-28 13:34:14 +01:00
Tom Christie
848567a0cd Docs for MAX_PAGINATE_BY setting & view attribute. 2013-08-28 12:55:49 +01:00
Tom Christie
ea6eee304c Note 'request.session' as available on requests. 2013-08-27 12:37:55 +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
53d60543c3 Add warning against HTMLFormRenderer 2013-08-25 20:31:04 +01:00
Tom Christie
c7847ebc45 Docs for HTMLFormRenderer 2013-08-23 17:10:50 +01:00
Tom Christie
c77e4a2c59 Merge branch 'master' into html-form-renderer 2013-08-23 16:46:14 +01:00
Tom Christie
436e66a42d JSON responses should not include a charset 2013-08-23 16:45:55 +01:00
Tom Christie
b72a99fef2 Merge branch 'display-nested-data' into html-form-renderer 2013-08-23 14:39:52 +01:00
Tom Christie
dba6027813 Add missing period. 2013-08-23 11:27:12 +01:00
Ramiro Morales
ec5955101b Update parsers.md 
s/renderers/parsers/
 2013-08-22 12:40:12 -03:00
Tom Christie
16ffdedd14 Merge master 2013-08-21 21:31:59 +01:00
Tom Christie
cf6ae397db Docs tweaking around check_object_permissions 2013-08-21 19:57:30 +01:00
Tom Christie
d900847d98 Merge pull request #1050 from filipeximenes/master 
Improving documentation about object level permissions #1049
 2013-08-21 11:52:45 -07: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
Filipe Ximenes
1bf7123415 improving documentation about object level permissions #1049 2013-08-20 16:24:13 -03: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
Tom Christie
5120670624 Document customizable view names/descriptions 2013-08-19 08:45:53 +01:00
Tom Christie
13ca305b06 Tweak docs. 2013-08-16 13:27:21 +01:00
Veronica Lynn
4d8d2340be Fixed typos in a bunch of docs 2013-08-07 14:00:06 -04:00
James Summerfield
4ff1dc6a11 Fixing typos in routers.md 2013-08-03 10:23:39 +01:00
Ricky Rosario
3802442c89 Add missing comma to generic view example. 2013-08-01 17:02:16 -04:00
Stephan Groß
e612103991 Fix typo 2013-07-31 20:25:28 +02:00
Stephan Groß
294d957361 Add drf-any-permission docs entry 2013-07-31 20:14:49 +02:00
James Rutherford
195b1af7ba Minor typo fix 2013-07-29 10:16:51 +01:00
James Rutherford
1a4ff1567e Updated authtoken docs to mention south migrations 2013-07-29 10:16:15 +01:00
Tom Christie
856dc855c9 Notes on customizing BrowsableAPIRenderer. Refs #1001 2013-07-29 09:21:20 +01:00
Tom Christie
6a6b2c9318 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2013-07-29 09:11:29 +01:00
Tom Christie
5c4bf5309d Docs about migrations and post_save. 
Documentation detailing requirement to migrate prior to running `createsuperuser` if using an authtoken `post_save` signal.
Closes #987.  Thanks to @yprez.
 2013-07-29 09:08:35 +01:00
Will Kahn-Greene
3fbb4097e6 Fix *Throttle class names in the docs 
* AnonThrottle -> AnonRateThrottle
* UserThrottle -> UserRateThrottle
* ScopedThrottle -> ScopedRateThrottle
* (cosmetic) removed one errant whitespace character

Fixes #1006.
 2013-07-25 12:56:47 -04: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
Tom Christie
ce5e8f8946 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2013-07-15 11:39:24 +01:00
Tom Christie
ae63c49777 Added test case classes 2013-07-15 11:38:38 +01:00
Mark Aaron Shirley
b5dc6b6113 Fix docs typo 2013-07-14 18:18:39 -07:00
Mark Aaron Shirley
7815811fe3 Update nested serialization docs 2013-07-14 18:13:37 -07:00
Yuri Prezument
77dd334026 Fix Mixin class name in viewsets docs example 2013-07-14 19:16:56 +03:00
Tom Christie
6de9b7c8ca Add note on ModelSerializer validation of both model fields and serializer fields. Refs #949 2013-07-11 21:02:47 +01:00
Tom Christie
edc3585652 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2013-07-10 21:12:27 +01:00
Matthias Jacob
453b7b03dd Fix broken links in views doc 2013-07-10 19:02:38 +02:00
Tom Christie
045ad73f69 Fixing up content negotiation docs 2013-07-10 14:32:10 +01:00
Tom Christie
99794773cf Merge pull request #962 from tomchristie/test-client 
APIClient and APIRequestFactory
 2013-07-04 05:50:04 -07:00
Tom Christie
a890116ab3 Minor docs addition 2013-07-04 13:49:28 +01:00
Tom Christie
b88bdfb9a5 Add section on dynamically modifying fields. Refs #958 2013-07-04 13:30:56 +01:00
Tom Christie
7398464b39 Tweak docs 2013-07-03 13:08:43 +01:00
Tom Christie
6d1c474618 Minor tidying 2013-07-02 22:29:38 +01:00
Tom Christie
efafa617a8 Merge pull request #956 from omouse/update-router-docs 
#955 updated documentation for overriding `routes` attribute in Router sub-classes
 2013-07-02 14:06:22 -07:00
Rudolf Olah
e460180a4d #955 updated router docs with more information on the Route named tuple and its parameters. 2013-07-02 13:20:25 -04:00
Tom Christie
e7529b4072 Fix broken link by hacking around md->html translating 2013-07-02 16:22:22 +01:00
Tom Christie
8d410c4671 Tweak text 2013-07-01 17:32:06 +01:00
Tom Christie
8274ff7d9c Capitalization on OAuth 2013-07-01 17:27:23 +01:00
Tom Christie
53dc98eefb Added Django OAuth2 Consumer package 2013-07-01 17:22:42 +01:00
Tom Christie
5427d90fa4 Remove console style from code blocks 2013-07-01 17:22:11 +01:00
Tom Christie
0a722de171 Complete testing docs 2013-07-01 13:59:05 +01:00
Tom Christie
d31d7c1867 First pass at testing docs 2013-06-29 22:53:27 +01:00
Tom Christie
58d38d694e Merge branch 'master' into writable-nested-modelserializer 2013-06-28 09:07:09 +01:00
Rudolf Olah
f5f23793e3 #955 updated documentation for overriding routes attribute in Router sub-classes 2013-06-27 16:30:24 -04:00
Tom Christie
13a3c993ab Fix incorrect example 2013-06-26 11:30:27 +01:00
Tom Christie
8d83ff8e6c Add decorator brackets back. Refs #941 2013-06-21 23:12:16 +01:00
Tom Christie
8cc63b09f6 Add support for StreamingHttpResponse. Closes #939 2013-06-21 22:42:04 +01:00
Tom Christie
a68f473dd8 Brackets not required on decorator without arguments 2013-06-21 23:25:14 +02:00
Tom Christie
8b0d4115c6 Merge pull request #941 from FreakyDug/master 
Fixed a couple of small problems I found when using the action decorator.
 2013-06-21 14:23:40 -07:00
Tom Christie
2d5f7f201f Update router docs on base_name. Refs #933. 2013-06-21 22:19:14 +01: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
Tom Christie
aa706f581c Add Django OAuth Toolkit to docs 2013-06-17 09:27:12 +01:00
Toby Champion
250dfef158 Changes 'python' to 'Python' when used in prose. 2013-06-12 14:51:17 -07:00
Tom Christie
5d0aeef69e Better docs related to lookup_field and hyperlinked serializers. Closes #920. 2013-06-10 17:46:55 +01:00
Ryan Kaskel
e483c4fed6 Remove pass statement before docstring. 2013-06-07 10:07:42 +01:00
Tom Christie
4b96614b12 Merge pull request #914 from gnunamed/master 
Fix typos
 2013-06-06 00:57:13 -07:00
Tom Christie
40e09472d8 Never deepcopy validators. Closes #913 2013-06-06 08:56:39 +01:00
gnunamed
fdb689f9b5 Update serializers.md 2013-06-05 13:53:00 -05:00
Tom Christie
de00ec95c3 Merge master 2013-06-05 13:33:19 +01:00
Tom Christie
f1251e8c58 Added trailing_slash argument to routers. Closes #905 2013-06-04 20:59:12 +01:00
Tom Christie
ffa27b840f Fix ModelField docs. Closes #909. 2013-06-04 20:23:16 +01:00
Tom Christie
6e0567c271 request.user should be still be accessible in renderer context if authentication fails 2013-06-03 12:32:57 +01:00
Tom Christie
27d8b848bc Add notes on 'method' argument to '@action' decorator 2013-06-02 20:40:56 +01:00
Tom Christie
b15a6ccef2 Serializer field 'default' argument may be a callable 2013-06-02 20:12:49 +01:00
Craig Teegarden
9154b09eb9 fix typo 2013-05-31 18:02:47 -04:00
Stephan Groß
7a570e16e9 Fix md formatting and typos 2013-05-28 17:13:12 +02: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
Tom Christie
78c53d530f Updating docs 2013-05-24 21:08:27 +01:00
Tom Christie
7a93fdbe0a Last bits of charset sorting-out-ness 2013-05-22 16:46:15 +01:00
Tom Christie
0e80a535fb Tweak nav style slightly 2013-05-21 17:45:25 +01:00
Tom Christie
ac99b81497 Note usage of django-filter 0.5.4 for Django 1.3 support. Closes #877 2013-05-21 12:05:44 +01:00
Tom Christie
aef7ac72cc content type may be set explicitly on the response 2013-05-20 21:18:17 +01:00
Tom Christie
f19e0d544f Fix charset issues 2013-05-20 21:00:56 +01:00
Neamar
4c85829cb7 Legacy parameter order 2013-05-20 10:48:07 +03:00
Neamar
42a8fe8995 Corrected docs (authentication instead of filtering) 2013-05-20 10:42:10 +03:00
Pablo Recio
71e29644a2 Adds new renderer into the documentation 2013-05-18 17:06:54 +02:00
Tom Christie
e1a3cab400 Merge pull request #854 from ryankask/issue-775 
All relations pointing to ManyToManyFields should default to read-only
 2013-05-18 07:22:22 -07:00
Tom Christie
2e8ff4473b Tweak docs 2013-05-18 14:47:39 +01:00
Oscar Vilaplana
4dbf2d907f added comment about error behavior with DEBUG=True 2013-05-18 14:55:55 +02:00
Ryan Kaskel
770ed3de2e ToMany fields default to read-only if targeting ManyToManyField. 2013-05-18 13:11:40 +01:00
Johannes
df11198c6c Fix typo + grammar in viewsets docs 2013-05-17 12:27:48 +02:00
Andy Freeland
abe207b869 HyperlinkedIdentityField uses lookup_field kwarg. 
According to the [Serializers API Guide][1], `HyperlinkedIdentityField`
takes `lookup_field` as a kwarg like the other related fields and the
generic views. However, this was not actually implemented.

[1]: http://django-rest-framework.org/api-guide/serializers.html#hyperlinkedmodelserializer
 2013-05-16 11:48:35 -04:00
Tom Christie
2cff6e69db Added OrderingFilter 2013-05-14 11:27:08 +01:00
Tom Christie
6a037f63ed Added OrderingFilter 2013-05-14 11:27:03 +01:00
Tom Christie
aa0dcd2e4a More docs on SearchFilter 2013-05-14 10:16:00 +01:00
Tom Christie
f9aeb68383 Updated release notes 2013-05-14 09:59:29 +01:00
Tom Christie
260a8125c5 Improve custom filtering example 2013-05-10 22:56:23 +01:00
Tom Christie
293dc3e6d8 Added SearchFilter 2013-05-10 22:33:11 +01:00
Hamish Campbell
5c8356d51d Fix minor code error in Generic Views documentation - missing if statement. 2013-05-10 13:28:50 +12:00
Tom Christie
31f94ab409 Added GenericViewSet and docs tweaking 2013-05-09 13:31:42 +01:00
Tom Christie
f2466418dd Tweak doc text slightly 2013-05-09 13:14:20 +01:00
Tom Christie
3737e17d7c Added 'Customizing the generic views' section. Closes #816 2013-05-09 13:10:45 +01:00
Mark Aaron Shirley
e550740b3d Merge remote-tracking branch 'upstream/master' into writable-nested-modelserializer 
Conflicts:
	rest_framework/tests/relations_nested.py
 2013-05-08 22:39:48 -07:00
Tom Christie
b443560080 Fix DATETIME_FORMAT, DATE_FORMAT, TIME_FORMAT settings. Closes #798 2013-05-08 20:38:50 +01:00
Tom Christie
9d59e55cec Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2013-05-08 20:09:03 +01:00
Tom Christie
429e078eee Allow None filename on uploaded files 2013-05-08 20:07:51 +01:00
Tom Christie
673a7a496f Update generic-views.md 2013-05-08 10:17:27 +02:00
Tom Christie
3353889ae8 Docs for FileUploadParser 2013-05-07 13:27:27 +01:00
Tom Christie
642970a1b8 Merge pull request #806 from wronglink/master 
Added FileUploadParser
 2013-05-07 05:09:09 -07:00
Tom Christie
3c2bb06660 Support for multiple filter classes 2013-05-07 13:00:44 +01:00
Tom Christie
d71a5533f9 allow_empty -> pending deprecation in preference of overridden get_queryset. 2013-05-07 12:25:41 +01:00
Tom Christie
b70c9cc107 Merge master 2013-05-05 18:12:35 +01:00
Tom Christie
2dfd8c9697 docs, docs, docs 2013-05-05 16:48:12 +01:00
Michael Elovskikh
5faaba9c69 Docs for FileUploadParser 2013-05-04 18:04:48 +06:00
Tom Christie
74beaefd12 Simplifying bits of docs 2013-05-02 12:08:05 +01:00
Victor Shih
8cabae22c5 Example and spelling fixes. Change "browseable" to "browsable" for consistency. 2013-05-01 21:26:40 -07:00
Tom Christie
35f99cddc4 lookup_field on hyperlinked fields, and overriddable hyperlinked fields. Closes #688 2013-05-01 09:03:09 +01:00
Tom Christie
22af28d146 Merge master 2013-04-30 19:32:34 +01:00
Tom Christie
b65b065375 Add DjangoModelPermissionsOrAnonReadOnly 2013-04-30 14:34:28 +01:00
Tom Christie
21ae3a6691 Drop out attribute 2013-04-30 08:24:33 +01:00
Tom Christie
d17e2d852f Remove AutoRouter. (Adding shortcut to generic views/viewsets means it's unneccessary) 2013-04-29 12:46:57 +01:00
Tom Christie
33a26a76f1 Typo 2013-04-27 16:35:42 +02:00
Tom Christie
73019f91fe Update docs on object-level permissions. 
Closes #801.
 2013-04-27 14:29:32 +02:00
Tom Christie
8fa79a7fd3 Deal with List/Instance suffixes for viewsets 2013-04-26 14:59:21 +01:00
Tom Christie
e301e2d974 Adding 'view or viewset' to docs appropriate. 2013-04-26 14:03:26 +01:00
Tom Christie
d985aec3c9 DecimalField 2013-04-26 13:59:06 +01:00
Tom Christie
50c6bc5762 Fix up viewset docs slightly 2013-04-26 13:31:19 +01:00
Tom Christie
51f80c3604 Fix broken queryset in example 2013-04-26 10:23:05 +01:00
Tom Christie
74b3307978 Docs, docs, docs 2013-04-25 20:43:37 +01:00
Tom Christie
9abaf77401 More viewset/router docs 2013-04-25 17:39:33 +01:00
Tom Christie
95abe6e844 Cleanup docstrings 2013-04-25 12:47:34 +01:00
Tom Christie
b94da2468c Various clean up and lots of docs 2013-04-24 22:40:24 +01:00
Tom Christie
835d3f89d3 Merge remove-django-generics 2013-04-23 11:59:13 +01:00
Mark Aaron Shirley
c7e000e46e Merge remote-tracking branch 'upstream/master' into writable-nested-modelserializer 
Conflicts:
	docs/api-guide/serializers.md
 2013-04-16 09:55:47 -07:00
Stephan Groß
ad436d966f Add DecimalField support 2013-04-15 13:02:18 +02:00
Tom Christie
d75cebf756 Remove router bit from viewset docs 2013-04-11 15:48:41 +01:00
Victor Shih
b73dfb9cc1 Remove redundant text. 2013-04-11 01:48:25 -07:00
Mark Aaron Shirley
bda25479aa Update docs with allow_add_remove 2013-04-10 08:44:54 -07:00
Tom Christie
027792c981 Viewsets and routers in seperate docs 2013-04-09 11:54:51 +01:00
Tom Christie
371698331c Tweaks 2013-04-04 22:24:30 +01:00
Tom Christie
c785628300 Fleshing out viewsets/routers 2013-04-04 20:00:44 +01:00
Tom Christie
64bcbb34d4 Merge pull request #769 from vshih/master 
Spelling/grammar fixes.
 2013-03-31 05:34:13 -07:00
Tom Christie
ec076a0078 Add viewsets/routers to indexs etc 2013-03-31 11:36:58 +01:00
Victor Shih
33ce7dfac4 Spelling/grammar fixes. 2013-03-30 20:28:27 -07:00
Tom Christie
399ac70b83 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2013-03-30 15:40:11 +00:00
Tom Christie
d243538547 Note on using curl with token auth 2013-03-28 14:54:42 +00:00
Fernando Rocha
b2cea84fae Complete remove of client checks from oauth2 
Signed-off-by: Fernando Rocha <fernandogrd@gmail.com>
 2013-03-27 19:00:36 -03:00
Tom Christie
92c929094c Version 2.2.5 2013-03-26 07:48:53 +00:00
Tom Christie
8387cb5d16 Docs fix 2013-03-25 20:28:17 +00:00
Tom Christie
7eefcf7e53 Bulk update, allow_add_remove flag 2013-03-25 20:26:34 +00:00
Tom Christie
870d5c7d78 Merge pull request #744 from tomchristie/basic-bulk-edit 
Basic bulk create and bulk update
 2013-03-22 14:47:29 -07:00
Tom Christie
13794baf70 Bit of extra tidying and plenty of docs 2013-03-22 17:01:06 +00:00
Tom Christie
8adde506e8 Default date/time fields now return python date/time objects again by default 2013-03-21 08:41:54 +00:00
Tom Christie
b2dc664485 Basic bulk create and bulk update 2013-03-19 14:26:48 +00:00
Tom Christie
034c4ce408 Fix serializer restore_object example for partial updates 2013-03-17 20:06:38 +00:00
Tom Christie
ef0caf64d3 Extra note on method 2013-03-17 19:59:13 +00:00
Tom Christie
e80d3d1bdf Fix text regarding serializer error messages. 
Closes #734.
 2013-03-17 19:51:04 +00:00
Tom Christie
a53596ce28 Docs for TokenHasReadWriteScope 2013-03-13 13:13:30 +00:00
Tom Christie
e8db504a98 Merge master 2013-03-12 18:49:38 +00:00
Tom Christie
a34f45b06e Docs polishing. 2013-03-09 00:31:19 +00:00
Tom Christie
69d169f5f6 Neater override hooks and more docs for DjangoModelPermissions. 
Refs #702.
 2013-03-08 23:42:20 +00:00
Tom Christie
5e993f3929 Merge 2013-03-08 23:00:23 +00:00
Tom Christie
53b58a5059 Merge branch 'master' of https://github.com/bitmonkey/django-rest-framework into list-deserialization 2013-03-08 21:20:52 +00:00
Tom Christie
4d48de631b Docs on per-object filtering 2013-03-08 20:41:00 +00:00
Ian Dash
66605acaf0 Errors during deserializing lists now return a list of tuples with 
index of bad item in data plus usual errors dict
 2013-03-08 15:08:05 +00:00
Tom Christie
e42e49852d Tweak docs 2013-03-07 19:49:36 +00:00
Tom Christie
a4b33992a5 Merge OAuth2 work. 2013-03-07 17:43:13 +00:00
Tom Christie
d4e3610e71 Merge & clean OAuth support 2013-03-07 09:01:53 +00:00
Pierre Dulac
30e3775b8b Update the documentation 
with a warning for incompatibility with Python 3
and taking @tomchristie advice into account on how to reformulate some
sentences
 2013-03-06 19:16:57 +01:00
Tom Christie
6135df56c6 Merge pull request #703 from tomchristie/datetime-formats 
Datetime formats
 2013-03-06 04:25:35 -08:00
Tom Christie
1106596c80 Clean ups to datetime formatting 2013-03-06 12:19:39 +00:00
Tom Christie
4f7b028a0a Updating docs 2013-03-05 20:57:35 +00:00
Tom Christie
c20ebe95f6 Merge datetime formats 2013-03-05 17:50:28 +00:00
Stephan Groß
7464def4e3 Fix typo 2013-03-05 18:42:31 +01:00
Tom Christie
6e7ddd579b Docs tweak. 2013-03-05 17:39:34 +00:00
Tom Christie
6c2dbf1220 Minor docs tweak 2013-03-05 14:03:28 +00:00
Stephan Groß
b4c9b68c96 Add note for using authtoken with custom django user model and south 2013-03-04 14:09:59 +01:00
Stephan Groß
d6391359f5 Fix fix migrate authtoken 2013-03-04 14:04:03 +01:00
Stephan Groß
4cdb6b2959 Fix authtoken migration 2013-03-04 13:53:39 +01:00
Stephan Groß
4a2788a7be Update docs 2013-03-01 16:50:18 +01:00
Stephan Groß
a9d36d4726 Add docs update - part 1 2013-03-01 16:50:18 +01:00
Stephan Groß
9157db5da0 Add better date / datetime validation (pull 2) 
addition to #631 with update to master + timefield support
 2013-03-01 16:48:20 +01:00
Pierre Dulac
653fcf7e33 Use the correct doc link style 2013-03-01 12:02:03 +01:00
Pierre Dulac
aed3c13471 Merge branch 'master' into oauth2-authentication 
Conflicts:
	rest_framework/tests/authentication.py
 2013-03-01 11:50:11 +01:00
Pierre Dulac
d8f455bc0f Add OAuth2Authentication documentation 2013-03-01 02:09:52 +01:00
Tom Christie
13b3af0d22 Auth is no longer lazy. Closes #667. 
More consistent auth failure behavior.
 2013-02-28 17:58:58 +00:00
Tom Christie
27aa2d6aad Use plularized URLs for better consistency. 
Closes #684.
 2013-02-27 22:13:34 +00:00
swistakm
2eabc5c2b4 rfc5849 link with anchor 2013-02-27 11:02:50 +01:00
Tom Christie
35331f5820 More consistent examples 2013-02-26 19:54:04 +00:00
Tom Christie
e7ca326555 Tweaks 2013-02-26 19:51:09 +00:00
Tom Christie
19135061b6 Merge pull request #681 from dbrgn/format_suffixes_docs 
Added function type detail to format suffix docs
 2013-02-26 11:49:09 -08:00
Wiliam Souza
cd7f552540 Fixed a typo WritableField field name in docs 2013-02-26 10:43:33 -03:00
Danilo Bargen
bfdbc95f1a Added CBV example to format-suffixes docs 2013-02-26 10:30:42 +01:00
Danilo Bargen
70db398595 Renamed UserInstance to UserDetail in docs 2013-02-25 21:31:12 +01:00
swistakm
5d9ed34e41 add OAuthAuthentication documentation stub 2013-02-25 17:41:34 +01:00
Ryan Detzel
cd9a192027 method fix for custom authentication 2013-02-23 23:32:47 +01:00
Tom Christie
ca8e073e34 TODO -> TODONE 2013-02-23 22:01:29 +00:00
Tom Christie
5432f9ba49 Fill in missing and incorrect settings. 2013-02-23 17:12:45 +00:00
Tom Christie
b3019d9824 Note requirements explicitly. 2013-02-22 20:46:20 +00:00
Tom Christie
31f3fa63b2 Tweak TemplateHTMLRenderer docs. 2013-02-22 08:39:50 +00:00
Tom Christie
c5cf51cf51 Fix typos. 2013-02-19 17:16:48 +00:00
Tom Christie
66a6ffaf95 Fix typos. 2013-02-19 17:09:28 +00:00
Tom Christie
618606888a Mention caching. Closes #659. 2013-02-15 09:27:37 +00:00
Andreas Pelme
5a5df18d18 Added a serializer TimeField 2013-02-14 21:19:51 +01:00
floppya
876bd67888 Minor doc fixes 
Fixes misspelling of "primitive"  and removes an awkward "with".
 2013-02-13 13:59:00 -06:00
Tom Christie
0b2adaa942 Drop note on object-level permissions. 
Not yet supported by DjangoModelPermissions.
 2013-02-12 23:17:41 +00:00
Tom Christie
b7a5c4b050 Notes on creating a custom obtain_auth_token view. Fixes #641. 2013-02-12 23:13:48 +00:00
Tom Christie
f97aa49809 Docs on serializer context. 2013-02-12 13:55:00 +00:00
Tom Christie
f642ee48a6 Document serializing querysets 2013-02-12 12:14:58 +00:00
Tom Christie
c81b2c6442 Notes on object-level permissions. 2013-02-12 08:58:28 +00:00
Tom Christie
f5a0275547 Tidy up internal view permission checking logic. 
Also document correctly - these methods are now public and will fall
under the deprecation policy from now on.
 2013-02-12 08:58:28 +00:00
Tom Christie
09b01887f2 New style object-level permission checks 2013-02-12 08:58:28 +00:00
Tom Christie
0997ce9fc2 Improve relations documentation. 2013-02-10 16:44:32 +00:00
Tom Christie
fd57978cb7 Add missing model = to serializer classes in docs 2013-02-08 09:01:45 +00:00
Tom Christie
15c8fd96ef Docs for related fields, with lots of examples. 2013-02-07 23:11:12 +00:00
Tom Christie
7ffb2435ca Add link to djangorestframework-digestauth 2013-02-07 21:23:10 +00:00
Tom Christie
c18fb0d695 Added a post_save hook. Closes #558. 2013-02-06 21:28:03 +00:00
Tom Christie
1929159db1 Docs tweaks. 2013-01-29 09:15:16 +00:00
swistakm
661c8f9ad5 fix mistake in docs 2013-01-28 13:05:52 +01:00
Michael Elovskikh
499d6424ae Merge branch 'upstream_master' into docs_patch_method 
Conflicts:
	docs/api-guide/authentication.md
 2013-01-28 16:26:16 +06:00
Tom Christie
e682bfa54e Drop unneccessary source= argument. 2013-01-28 08:01:54 +00:00
Tom Christie
a58145e20f Note auto_now, auto_now_add behavior. Refs #622. 2013-01-28 07:46:30 +00:00
Tom Christie
99ef0bcad9 Tweak description of example throttle. 2013-01-28 07:37:15 +00:00
Tom Christie
e649f2ec61 Example custom authentication. Fixes #301. 2013-01-28 07:36:57 +00:00
Tom Christie
cb219fa04f Example custom throttle. Fixes #300. 2013-01-28 07:30:28 +00:00
Tom Christie
84a33b0a1f Example custome permission. Fixes #299. 2013-01-28 07:29:50 +00:00
Tom Christie
a7479e02fa AJAX, CSRF & CORS documentation 2013-01-27 17:23:56 +00:00
Tom Christie
a2dcf5e878 Fix pagination docs 2013-01-26 20:52:58 +00:00
Tom Christie
b7ab2aee46 Merge branch 'master' into unauthenticated_response 
Conflicts:
	docs/api-guide/authentication.md
 2013-01-22 09:11:38 +00:00
Tom Christie
65b62d64ec WWW-Authenticate responses 2013-01-21 21:29:49 +00:00
Bruno Renié
9b9b6529bc Fixed reference to authtoken in the docs 2013-01-20 14:49:07 +01:00