Commit Graph

1226 Commits

Author SHA1 Message Date
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
Tom Christie
003b9dda34 Merge pull request #1207 from erkarl/master
Updated OAuth2 authentication docs.
2013-11-02 02:24:08 -07:00
Tom Christie
5e0538fcda Added @robhudson for work on #1211. Thanks! 2013-11-02 09:15:35 +00: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
2ddf7869e3 Added @yamila-moreno for work on #1199. Thanks! 2013-10-24 15:29:40 +01: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
Tom Christie
4d894fd39e Added @alexanderlukanin13 for fix #1198. Thanks! 2013-10-24 13:50:05 +01:00
Tom Christie
f92d8bd972 Added @jbzdak, for the nice docs improvements in #1191. Thanks! 2013-10-22 12:21:26 +01: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
fa87fac61b Added @ross for work on #1187. Thanks! 2013-10-22 10:21:06 +01:00
Tom Christie
76672787cd Added . Closes #1188. 2013-10-21 09:47:07 +01:00
Tom Christie
c37bd40d28 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2013-10-21 09:30:17 +01:00
Tom Christie
70b0798118 Add invite signup 2013-10-21 09:30:01 +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
Tom Christie
c3aeb16557 Update 3-class-based-views.md 2013-10-18 09:32:04 +01:00
Tom Christie
016deaf9de Merge pull request #1177 from rprince/patch-2
Mention name of file to edit
2013-10-18 01:30:17 -07:00
Tom Christie
44a0f1cfbc Merge pull request #1178 from rprince/patch-3
Using the filenames where relevant
2013-10-18 01:16:51 -07:00
Tom Christie
78c8e6de40 Update 2-requests-and-responses.md 2013-10-18 09:10:54 +01:00
Tom Christie
bad5083e09 Merge pull request #1176 from rprince/patch-1
Added name of file to edit
2013-10-18 01:10:03 -07:00
Colin
daf927ef68 add @tamakisquare for work on #1111 2013-10-17 12:28:58 -07:00
Tom Christie
545ee013e3 Added @badale, for work on #1179. Thanks! 2013-10-17 09:40:06 +01:00
Rikki
bf60848952 Using the filenames where relevant
Sometimes it's hard to tell which file the code is intended to go in. Now it spells it out.
2013-10-16 03:21:43 +01:00
Rikki
cb123e896e Mention name of file to edit
To reduce unnecessary cognitive load of the learner, name the file they are putting this code in.
2013-10-16 03:08:43 +01:00
Rikki
e83bc00323 Added name of file to edit
So reader doesn't have to remember, or check through all the files to find where this code fragment was, mention the file name when it is relevant.
2013-10-16 03:03:51 +01:00
Álvaro Lázaro
89ac03af26 Add missing commas in relations.md 2013-10-12 20:31:33 +02:00
Tom Christie
97fbc5caec Merge pull request #1157 from dpetzel/tutorial_authentication
Be sure to import UserSerializer
2013-10-11 00:36:55 -07: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
dpetzel
864497eebb Be sure to import UserSerializer 2013-10-05 23:16:58 -04:00
dpetzel
48a38386af **very minor** typo fix 2013-10-05 19:29:25 -04:00
Tom Christie
3833f1d55f Added @hcliff for #1153. Thanks! 2013-10-04 15:55:57 +01: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
Jeff
61dd9ce914 Update release-notes.md
Simple typo fix.
2013-10-01 15:47:47 -06: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
Krzysztof Jurewicz
49847584a8 Minor documentation fix. 2013-09-29 12:49:38 +02:00
Tom Christie
57a51f790b Added @mkai, for work on #1126. Thanks! 2013-09-24 09:21:55 +01:00
Grzegorz Kapkowski
fda0c520bd Match docs to current code. 2013-09-23 16:10:46 +02:00
John Mee
de6e7accef Mindnumbingly trivial single-char typo. 2013-09-23 14:03:09 +10:00
Braulio Soncco
3d8fad0444 Fixing simple typo 2013-09-18 00:33:05 -05:00
Tom Christie
e8c6cd5622 Update release notes. 2013-09-13 19:43:19 +01:00
Tom Christie
d75ecb3d69 Added @mrmachine. Thanks!
For work on #1109.
2013-09-13 19:40:58 +01:00
Tai Lee
a9dbd46c94 Refs #1109 -- Update docs. Integrate changes from feedback. 2013-09-14 00:54:44 +10: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
Tom Christie
2da9ab8cc5 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2013-09-12 20:27:36 +01:00
Tom Christie
dfc430caba Fix django guardian link 2013-09-12 20:27:23 +01:00
Diego Ponciano
2a6a2013df small typo correction on ViewSet example code 2013-09-11 17:25:57 -03:00
Tom Christie
195790e60b Version 2.3.8 2013-09-11 09:09:30 +01:00
Tom Christie
e021472a16 Added @bwreilly for awesome work on #1093. Thanks!!! 2013-09-10 21:07:20 +01:00
Tom Christie
101da45810 Updated release notes 2013-09-10 21:06:42 +01:00
Tom Christie
5970baa201 Tweaks and docs to object-level model permissions. 2013-09-10 21:00:13 +01:00
Tom Christie
75fb4b02b4 Merge branch 'master' of git://github.com/bwreilly/django-rest-framework into bwreilly-master 2013-09-10 20:21:15 +01:00
Tom Christie
f5c34926d6 Update release-notes.md 2013-09-09 20:41:54 +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
bwreilly
4a9dcfa760 added guardian as optional requirement, stubbed out object-level permission class 2013-09-06 11:01:31 -05:00
Tom Christie
916d8ab37d Fix typo 2013-09-06 12:19:51 +01:00
Tom Christie
b47f1b0257 Added @edmundwong for work on #1076. Thanks! 2013-09-05 20:25:45 +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
8b245fed14 Add windows virtualenv activate instruction
Closes #1075.
2013-09-02 09:17:51 +01:00
tom-leys
85ab879a85 Updated tutorial part 6: 2 examples were missing includes 2013-08-31 19:40:53 +12:00
Tom Christie
f8101114d1 Update release notes 2013-08-30 09:31:35 +01:00
Tom Christie
556b4bbba9 Added note on botbot IRC archives 2013-08-29 20:04:00 +01:00
Tom Christie
ac0fb01be3 Update release notes. 2013-08-29 19:31:36 +01:00
Tom Christie
4b46de7dce Added @diox for fix #1074. Thanks! 2013-08-29 19:31:36 +01:00
Brett Koonce
da9c17067c minor sp 2013-08-29 09:23:34 -05:00
Tom Christie
6f8acb5a76 Added @niwibe
For docs addition #1070 - Thanks!
2013-08-29 09:31:12 +01:00
Andrey Antukh
2d37952e78 Add composed-permissions entry to the api-guide. 2013-08-29 00:52:07 +02:00
Tom Christie
711fb9761c Update release notes. 2013-08-28 13:35:27 +01: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
d7224afe54 Added @alexander-akhmetov.
For work on MAX_PAGINATE_BY, #1063.  Thanks! :)
2013-08-28 12:57:29 +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
Tom Christie
c3e273a90e Added @kristianoellegaard.
For docs addition #1059.  Thanks!
2013-08-27 09:16:20 +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
2340035789 Added @ericbuehl
For pull request #1058.  Thank you! :)
2013-08-25 20:48:10 +01: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
f54fc3a76b Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2013-08-23 14:06:39 +01:00
Tom Christie
7bbe0f868f Added @krzysiekj
For work on #1034.  Thanks!
2013-08-23 13:37:25 +01:00
Tom Christie
f2b190e374 Update release notes 2013-08-23 12:06:23 +01:00
Tom Christie
dba6027813 Add missing period. 2013-08-23 11:27:12 +01:00
Tom Christie
19a774f972 force_authenticate(None) also clears session info.
Closes #1055.
2013-08-23 11:21:52 +01:00
Stephan Groß
b8561f4123 Add @ramiro for #1056 thanks! 2013-08-22 17:52:22 +02:00
Ramiro Morales
ec5955101b Update parsers.md
s/renderers/parsers/
2013-08-22 12:40:12 -03:00
Tom Christie
4338e1e43f Added @filipeximenes
For work on #1050.  Thanks!
2013-08-21 20:00:35 +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
f84d4951bf Update release notes 2013-08-19 21:46:34 +01:00
Tom Christie
34d65119fc Update release notes. 2013-08-19 08:54:48 +01:00
Tom Christie
3a99b0af50 Added @chrispaolini.
For customizable view names/descriptions in #1043.  Thanks! :)
2013-08-19 08:47:52 +01:00
Tom Christie
5120670624 Document customizable view names/descriptions 2013-08-19 08:45:53 +01:00
Tom Christie
c1ccd8b5b5 Update docs to include testing. 2013-08-16 14:12:24 +01:00
Tom Christie
f6f69dc71d Version 2.3.7 2013-08-16 14:03:20 +01:00
Tom Christie
13ca305b06 Tweak docs. 2013-08-16 13:27:21 +01:00
Tom Christie
d5b56310b0 Update release notes 2013-08-16 13:23:27 +01:00
Tom Christie
7bc63fbb11 Added @jsatt.
For fix & tests in #1037.
2013-08-14 13:17:30 +01:00
Stephan Groß
999056cde1 Add @martync for #1033 thanks! 2013-08-13 10:43:07 +02:00
martync
770d496307 Small typo 2013-08-13 09:19:40 +02:00
Tom Christie
54b7b6760c Added @etos.
For fixes in #1029, #1030 - Thanks!
2013-08-12 09:27:34 +01:00
Tom Christie
2761d6a472 Added @kolvia.
For multiple documentation fixes in #1026.  Thank you! :)
2013-08-07 20:27:41 +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
Stephan Groß
e4144b5b67 Add @rlr for #1022 thanks! 2013-08-02 08:59:18 +02: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
leandersikma
56d19dcc1c Wrong name of the login_base html file.
Changed rest_framework/base_login.html to rest_framework/login_base.html (which is the correct name the user should extends in their templates).
2013-07-30 11:26:17 +02:00
Stephan Groß
205c626d6e Add @jimr for #1013 thanks! 2013-07-29 15:53:26 +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
Stephan Groß
e98c229e5a Add @coderigo for #1011 thanks! 2013-07-28 18:51:22 +02:00
Rodrigo Martell
3a898a11f7 Fix Tutorial5 serializers.py typo
[Issue #N/A]

A slight typo at Tutorial5 causing an Exception "name 'models' is
not defined". A subtle one that can confuse Python/Django noobs
like me.
2013-07-27 10:09:56 +10:00
Kevin Brown
9088c18da8 Added to the credits 2013-07-26 11:03:37 -04:00
Stephan Groß
0fa9866848 Add @willkg for #1007 thanks! 2013-07-26 09:26:32 +02: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
Stephan Groß
c23412b51c Add @pzinovkin for #995 thanks! 2013-07-24 11:02:10 +02:00
Steve
61a242e27b added script block to list of blocks
Phew, was afraid I wouldn't be able to overwrite this section..
2013-07-23 10:40:54 -04:00
Kevin Brown
8f2e71a67f Modified documentation for CSRF as mentioned in #984 2013-07-19 19:49:20 -04:00
Eric Buehl
b676cce61f pedantic doc updates 2013-07-18 19:03:38 -07: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
1cfb1cf458 Added @cyroxx for work on #978 2013-07-10 21:14:18 +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
77364d2b84 Add screenshot, and tweak docs 2013-07-09 14:00:53 +01:00
Tom Christie
cb95e0aab1 Merge pull request #970 from sebastibe/browsable-autocomplete-field-doc
Add recommendation about autocomplete widgets for the browsable API
2013-07-09 05:46:30 -07:00
Tom Christie
f94ce6e7cb Added @gertjanol for work on #976 - thank you :) 2013-07-09 13:13:56 +01:00