Commit Graph

1319 Commits

Author SHA1 Message Date
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
9d6129a95f Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2014-01-14 20:36:04 +00:00
Tom Christie
d20c49da4a More HyperlinkedModelSerializer docs 2014-01-14 20:34:33 +00:00
Tom Christie
9a8082878a Use a local virtualenv, not in the users homedir. 2014-01-14 17:13:48 +00:00
Tom Christie
cbd214699d Tweak html for hidden h1 on homepage 2014-01-14 14:47:34 +00:00
JakeSidSmith
4655d34848 Added h1 and alt to logo to improve SEO
Added title attribution to logo
2014-01-14 14:40:36 +00:00
Tom Christie
85d74fc86a Added write_only and write_only_fields. Refs #1306 2014-01-14 11:25:44 +00: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
Tom Christie
2b033d2456 New font in logo 2014-01-07 14:57:00 +00:00
Tom Christie
399e4d9b08 Merge branch 'master' into logo 2014-01-03 13:27:00 +00:00
Tom Christie
442916b964 Link to BrightAPI, and remove ad except from frontpage 2014-01-03 13:24:52 +00:00
Tom Christie
3050f0e82a Frontpage tweaks 2014-01-03 13:06:41 +00:00
Kevin Brown
0672d6de6e Fix bugfix note
This fixes a bugfix note that was added because of #1293, which
pointed out that a change in a bugfix [1] broke backwards
compatibility.  The bugfix did not work as expected because a
variable was quoted when it should not have been.  This removes
the quotes around the variable, which brings back the expected
functionality.
2014-01-02 16:46:57 -05:00
Tom Christie
1f3f2741f5 Happy new year 2014-01-02 09:28:34 +00: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
bed2f08c24 Updated release notes 2013-12-23 11:57:25 +00:00
Tom Christie
d8a95b4b6d Back out permissions example change in favor of easier to follow example 2013-12-23 09:12:34 +00:00
amatellanes
2846ddb5d2 Simplified some examples in tutorial 2013-12-23 09:06:03 +01:00
amatellanes
74f1cf6355 Revert "Simplified some examples in tutorial"
This reverts commit d6806340e5.
2013-12-23 08:56:34 +01:00
amatellanes
d6806340e5 Simplified some examples in tutorial 2013-12-23 08:50:46 +01: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
02ae1682b5 Add note on compat import in tutorial 2013-12-17 09:45:28 +00:00
Xavier Ordoquy
8026480454 Use the BytesIO for buffering bytes and import the one from the compat module. 2013-12-17 10:30:23 +01:00
Tom Christie
31dd160256 Typo 2013-12-16 11:59:14 +00:00
Tom Christie
6b6b255684 Add note on pagination bugfix. Closes #1293. 2013-12-14 20:42:58 +00:00
Tom Christie
f78b3187df Added @philipforget for work on #1232. Thanks :) 2013-12-13 22:01:19 +00:00
Tom Christie
54d3c6a725 Updated release notes 2013-12-13 21:59:47 +00:00
Tom Christie
39dbea4da4 Links to drf-nested-routers 2013-12-13 20:27:17 +00:00
Tom Christie
87b99d1ac8 Update release notes 2013-12-13 20:17:26 +00:00
Tom Christie
ca244ad614 Expanded notes in quickstart. Closes #1127. Closes #1128. 2013-12-13 15:30:59 +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
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
c09ad1bedc Remove incorrect apostrophe 2013-12-10 08:53:38 +00:00
Tom Christie
40164fcc62 Update release notes 2013-12-10 08:49:54 +00: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
Tom Christie
2c898bd901 Update release notes 2013-12-09 09:27:10 +00:00
Tom Christie
c1be503308 Add notes to contributing docs 2013-12-09 08:46:18 +00:00
Tom Christie
e6f6bb5c7e Add notes to contributing docs 2013-12-09 08:42:09 +00:00
Tom Christie
23369650e3 Add notes to contributing docs 2013-12-09 08:14:21 +00:00
Tom Christie
e80b353085 Add notes to contributing docs 2013-12-09 08:10:51 +00:00
Tom Christie
5eca31d161 Merge pull request #1275 from qooleot/master
RelatedField is function of serializer class
2013-12-08 23:46:55 -08:00
Rustam Lalkaka
b8732d2165 Minor grammar fix -- 'team' is singular 2013-12-08 19:34:24 -05:00
taras
3399158d62 RelatedField is function of serializer class 2013-12-08 11:40:40 -05:00
Andy Wilson
db19fba50d update installation example to work with django 1.6
looks like django.conf.urls.defaults was deprecated as of django 1.6
2013-12-06 22:31:07 -06:00
Tom Christie
910de38a9c Version 2.3.10 2013-12-06 22:13:50 +00:00
Tom Christie
85d9eb0f7e Update release-notes.md 2013-12-06 21:47:26 +00:00
Tom Christie
51359e4612 Added @chuckharmston for kickass bug squashing in #1272 2013-12-06 21:42:52 +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
6446b44f01 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2013-12-04 14:59:28 +00:00
Tom Christie
de5b9e39dd First pass on contribution guide 2013-12-04 14:59:09 +00:00
Tom Christie
04a43ddca5 Merge pull request #1267 from tomchristie/fix-1133
Clarify wording, fixes #1133.
2013-12-04 00:52:07 -08:00
Tom Christie
3c3906e278 Clarify wording, fixes #1133. 2013-12-04 08:51:34 +00:00
Tom Christie
38d78b21c0 Remove Content-Type header from empty responses. Fixes #1196 2013-12-03 16:55:11 +00:00
Tom Christie
9f1918e41e Added @ian-foote, for work on #1250. Thanks! 2013-12-03 16:06:57 +00:00
Tom Christie
b92c911cf6 Update release-notes.md 2013-12-03 16:05:19 +00:00
Tom Christie
fe4c7d4000 Update release-notes.md 2013-12-03 08:26:58 +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
304b193efe Update release-notes.md 2013-11-19 15:58:34 +00:00
Tom Christie
ca2bd616d9 Remove a couple of .html suffixes in docs 2013-11-19 11:01:27 +00:00
Tom Christie
bc69a6d983 Add a 404 page to the docs 2013-11-18 16:10:26 +00:00
Tom Christie
20325cce18 Drop .html suffixes in docs 2013-11-18 16:10:14 +00:00
Tom Christie
075b8c1037 Add User import. Refs #599 2013-11-18 09:29:09 +00:00
Tom Christie
128bda5712 Use less specfic language in UltaJSON notes 2013-11-15 15:24:32 +00:00
Tom Christie
1d1b2f765c Version 2.3.9 2013-11-15 13:55:02 +00:00
Alex
72d72e4d3e Add Alex Good to credits (Whoop!) 2013-11-13 14:32:37 +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
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