Commit Graph

593 Commits

Author SHA1 Message Date
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