Commit Graph

839 Commits

Author SHA1 Message Date
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
Tom Christie
73b69b9bb6 Rephrasing. 2013-01-18 22:26:36 +00:00
Tom Christie
fb5943bb64 Merge pull request #588 from nemesisdesign/patch-1
mod_wsgi specific documentation for WSGIPassAuthorization
2013-01-18 14:08:59 -08:00
Tom Christie
15ad94c611 Drop the curl notes. Unnecessary. 2013-01-18 22:06:41 +00:00
Tom Christie
bd089836a1 Note on setting ContentType. Fixes #589. Refs #586. 2013-01-18 22:01:33 +00:00
Michael Elovskikh
ed13754859 Added PATCH HTTP method to the docs 2013-01-17 17:17:53 +06:00
Federico Capoano
f19d4ea8b1 Update docs/api-guide/authentication.md
refined mod_wsgi
2013-01-16 17:17:07 +01:00
Federico Capoano
55cc745254 Update docs/api-guide/authentication.md
Added mod_wsgi specific instructions
2013-01-16 17:10:46 +01:00
Tom Christie
190473f508 Tweak messagepack links 2013-01-14 17:38:45 +00:00
Tom Christie
a7e7c441a4 Add link to @mjumbewu's CSV package 2013-01-14 17:38:32 +00:00
Stephan Groß
919c5e1e01 Fix typo in permission_classes 2013-01-11 20:26:44 +01:00
Tom Christie
cb235977f6 Include CSRF note in SessionAuthentication docs. 2013-01-09 09:22:23 +00:00
Marc Tamlyn
4df1172665 Fix reference to BasicAuthentication in settings. 2013-01-08 11:45:55 +00:00
Tom Christie
31b585f26a Note paginate_by=None usage. Fixes #555. 2013-01-07 21:13:10 +00:00
Tom Christie
36fa722ebb Merged to latest master 2013-01-07 21:04:52 +00:00
Tom Christie
e429f702e0 Fix PAGINATE_BY_PARAM docs. Refs #551 2013-01-07 20:17:52 +00:00
Tom Christie
d9df15f321 Added @juanriaza's djangorestframework-msgpack package to the docs. 2013-01-07 17:36:31 +00:00
Tom Christie
ef73160599 Added RetrieveUpdateAPIView 2013-01-02 13:46:19 +00:00
Tom Christie
8fad0a727a Relation fields move into relations.py 2012-12-31 08:53:40 +00:00
Tom Christie
1f6af163fe Tweak quote 2012-12-29 12:15:15 +00:00
Tom Christie
5d4ea3d23f Add .validate() example 2012-12-28 12:59:24 +00:00
Reinout van Rees
5f9ecd1c7a slug_kwarg attribute doesn't work; it should be slug_url_kwarg 2012-12-21 10:42:40 +01:00
Stephan Groß
e198a2b376 added RetrieveUpdateAPIView 2012-12-13 16:57:17 +01:00
Tom Christie
ff01ae3571 Version 2.1.8 2012-12-08 13:01:03 +00:00
Marko Tibold
3868241f6a Update docs/api-guide/permissions.md
@permission_classes takes a tuple or list.
2012-12-05 15:09:06 +01:00
Pavel Savchenko
fd383b2b5e Fix location of obtain_auth_token view 2012-11-28 11:58:34 +02:00
Yuri Prezument
80be571b2e Import from correct place 2012-11-27 19:42:37 +02:00
Yuri Prezument
e8a41322fb api-guide/views.md - add imports to code example
* It wasn't clear where `Response` should be imported from.
2012-11-27 11:42:25 +02:00
Mark Aaron Shirley
0876bed963 Merge remote-tracking branch 'upstream/master' into partial-update 2012-11-21 09:37:22 -08:00
Stephan Groß
9459289d7d updated comparison due to pep8 programming recommendations
http://www.python.org/dev/peps/pep-0008/#programming-recommendations
2012-11-21 13:35:20 +01:00
Stephan Groß
6ba4df8a27 Merge remote-tracking branch 'upstream/master' into regex_field
Conflicts:
	docs/topics/release-notes.md
2012-11-21 11:56:34 +01:00
Mark Aaron Shirley
3b43d41e91 Documentation changes for partial serializer updates 2012-11-20 15:57:54 -08:00
Tom Christie
8e8b23b6a9 Merge pull request #430 from j4mie/serializer-method-field
Serializer method field
2012-11-20 15:30:30 -08:00
Stephan Groß
86484668f6 added RegexField 2012-11-20 15:38:50 +01:00
Jamie Matthews
5f4c385a86 Add example use of SerializerMethodField to docs 2012-11-20 13:25:21 +00:00
Tom Christie
a44a94dd6e More docs tweaking. 2012-11-19 22:08:38 +00:00
Tom Christie
ce5b186ca8 Docs tweaks. 2012-11-19 21:42:33 +00:00
Jamie Matthews
3ab8c4966d Tweaks to SerializerMethodField docs 2012-11-19 17:24:08 +00:00
Jamie Matthews
de5b071d67 Add SerializerMethodField 2012-11-19 17:22:17 +00:00
Robert Romano
f5f1ac49ec Update robromano fork with upstream master
Conflicts:
	docs/topics/credits.md
	docs/topics/release-notes.md
2012-11-18 21:07:44 -08:00
Tom Christie
f131e533ed Docs, docs, docs, docs, docs, docs 2012-11-18 17:57:07 +00:00
Tom Christie
2263ed8b94 Tweak 2012-11-16 23:24:36 +00:00
Tom Christie
0eba278e13 Improve pagination docs 2012-11-16 23:22:23 +00:00
Tom Christie
e801e21210 Merge pull request #422 from markotibold/max_length_for_modelserializers
Max length for modelserializers
2012-11-16 14:54:16 -08:00
Tom Christie
e40000c834 Merge pull request #408 from markotibold/file_and_image_fields
Added a FileField and an ImageField
2012-11-16 14:48:42 -08:00
Tom Christie
31f01bd631 Polishing to page size query parameters & more docs 2012-11-16 22:45:57 +00:00
Marko Tibold
f801e5d305 Simplified docs a bit for FileField and ImageField.
Added note about MultipartParser only supporting file uploads and Django's default upload handlers.
2012-11-16 23:44:55 +01:00
Marko Tibold
0076e2f462 Added brief docs for URLField and SlugField. 2012-11-16 23:23:34 +01:00
Tom Christie
9973cf329a Merge pull request #412 from minddust/custom_page_size_per_request
support for custom page size per request
2012-11-16 13:45:27 -08:00
Tom Christie
2f2bde69e4 Docs, tox and travis use django-filter 0.5.4 2012-11-16 20:58:49 +00:00
Tom Christie
c5765641a4 Fix typo 2012-11-16 17:28:08 +00:00
Marko Tibold
b4cfb46a56 WIP on docs for File- and ImageFileds. 2012-11-16 00:22:08 +01:00
Stephan Groß
3ae203a018 updated script to just use page_size_kwarg 2012-11-15 12:06:43 +01:00
Stephan Groß
38e94bb8b4 added global and per resource on/off switch + updated docs 2012-11-15 11:15:05 +01:00
Rob Romano
321ba156ca Renamed AuthTokenView to ObtainAuthToken, added obtain_auth_token var, updated tests & docs. Left authtoken.urls in place as example. 2012-11-14 12:51:00 -08:00
Rob Romano
eb20b5663e Added documentation on how to use the token authentication login view. 2012-11-14 12:48:03 -08:00
Stephan Groß
1e83b60a43 added description how to use the auth token 2012-11-14 18:00:59 +01:00
Stephan Groß
5967f15f7f updated docs 2012-11-14 16:11:35 +01:00
Tom Christie
957700ecfb Remove OAuth2 from docs 2012-11-13 11:26:45 +00:00
Tom Christie
e224061189 Support for read_only_fields on ModelSerializer classes 2012-11-09 17:01:20 +00:00
Tom Christie
8953a60196 Merge with master 2012-11-09 13:49:52 +00:00
Tom Christie
9aaeeacdfe Minor docs tweak. 2012-11-09 13:39:40 +00:00
Tom Christie
71ef58e154 Typo 2012-11-09 13:17:00 +00:00
Tom Christie
c7df9694b5 Merge pull request #383 from tomchristie/filtering
Support for filtering backends
2012-11-09 05:07:34 -08:00
Tom Christie
ff1234b711 Updated filteing docs. 2012-11-09 13:05:36 +00:00
Tom Christie
bc6f2a1703 Make default FILTER_BACKEND = None 2012-11-08 21:46:53 +00:00
Tom Christie
0089f0faa7 Add media_type to example file parser 2012-11-08 20:43:23 +00:00
Tom Christie
34c5fb0cc6 Add filtering into documentation 2012-11-07 21:28:10 +00:00
Tom Christie
47b534a13e Make filtering optional, and pluggable. 2012-11-07 21:07:24 +00:00
Stephan Groß
e02a8470e8 fixed typo 2012-11-06 21:18:49 +01:00
Stephan Groß
4136b7e44b fixed typo in html status code 2012-11-06 21:11:05 +01:00
Tom Christie
6d3bb67aa6 Add pk_url_kwarg to hyperlinked fields 2012-11-06 17:11:52 +00:00
Stephan Groß
2c52a2581f added slug support for HyperlinkedIdentityField 2012-11-06 17:02:34 +01:00
Tom Christie
b19c58ae17 Support for HTML error templates. Fixes #319. 2012-11-06 10:44:19 +00:00
Tom Christie
455a8cedcf Tweaks 2012-11-05 17:03:22 +00:00
Tom Christie
1418d104a8 Tweak related field docs now that queryset is no longer required. 2012-11-05 16:44:26 +00:00
Tom Christie
9731b95fc3 Merge pull request #347 from minddust/master
support for passing custom slug options to HyperlinkedRelatedField
2012-11-05 08:36:59 -08:00
Stephan Groß
85b176cf47 added docs 2012-11-05 16:51:49 +01:00
Tom Christie
b7b942c599 Swap position of instance and data keyword arguments. 2012-11-05 10:53:20 +00:00
Tom Christie
062f5caef3 Tweaks fields docs, and fix 2.0.1 version. 2012-11-01 23:40:34 +00:00
Otto Yiu
96dc9ce1ad Fixing documentation on auth/throttling guides 2012-10-31 21:27:21 -07:00
Stephan Groß
7f7f0b6ffb added missing semicolon 2012-10-31 10:41:56 +01:00
Stephan Groß
5865842019 fixed api_view decorator useage 2012-10-29 09:32:11 +01:00
Stephan Groß
2de89f2d53 remove empty rows 2012-10-29 09:29:45 +01:00
Stephan Groß
ff4804a360 fix api_view decorator useage 2012-10-29 09:25:17 +01:00
Stephan Groß
73cf859e26 add missing whitespace 2012-10-29 09:23:25 +01:00
Stephan Groß
741b387f35 fixed missplaced semicolon 2012-10-29 09:22:20 +01:00
Stephan Groß
5164f5d797 fixed missplaced semicolon 2012-10-29 09:21:27 +01:00
Stephan Groß
46e546ff23 fixed missplaced semicolon 2012-10-29 09:20:14 +01:00
Stephan Groß
72f3a7e4a7 add missing semicolon 2012-10-29 09:13:56 +01:00
Stephan Groß
842c8b4da4 add missing "`" for code formatting 2012-10-29 09:12:21 +01:00
Stephan Groß
8d2774dc97 fixed api_view decorator useage 2012-10-29 09:07:42 +01:00
Tom Christie
351382fe35 nested -> depth 2012-10-28 20:43:43 +00:00
Tom Christie
6e4ab09aae readonly -> read_only 2012-10-28 20:21:45 +00:00
Tom Christie
795f611663 Merge pull request #332 from tomchristie/tutorial-refactor
Improve fields docs
2012-10-28 13:18:51 -07:00
Tom Christie
3906ff0df5 Improve fields docs 2012-10-28 20:18:02 +00:00
Tom Christie
3d3df22d82 Merge pull request #330 from tomchristie/tutorial-refactor
Tutorial refactor
2012-10-28 12:42:10 -07:00
Tom Christie
12c363c1fe TemplateHTMLRenderer, StaticHTMLRenderer 2012-10-28 18:12:56 +00:00
Tom Christie
d995742afc Add AllowAny permission 2012-10-27 20:04:33 +01:00
Tom Christie
cef379db06 2.0 Announcement 2012-10-27 18:39:17 +01:00
Tom Christie
ec1429ffc8 Tweaks 2012-10-27 17:27:12 +02:00
Jamie Matthews
5180b72565 Documentation for function-based view decorators 2012-10-27 13:53:07 +01:00
Tom Christie
c221bc6f6f Use context dict in HTMLRenderer 2012-10-26 17:30:45 +02:00
Tom Christie
d4063eb02e Fix incorrect method signature in docs 2012-10-26 12:46:31 +01:00
Jamie Matthews
41d27b1a30 Fix section headings in generic views docs 2012-10-25 14:22:36 +01:00
Jamie Matthews
1ceca69e5f Update generic view documentation 2012-10-25 13:50:48 +01:00
Tom Christie
d97c712124 Fix typo reported by @diviei 2012-10-24 20:49:09 +02:00
Jamie Matthews
d60d598e02 Clean up internal names and documentation 2012-10-24 11:43:30 +01:00
Jamie Matthews
ac2d39892d Add cross-field validate method 2012-10-24 11:39:17 +01:00
Jamie Matthews
388a807f64 Switch from clean_<fieldname> to validate_<fieldname>, clarify documentation 2012-10-24 11:27:01 +01:00
Jamie Matthews
51fae73f3d Implement per-field validation on Serializers 2012-10-24 09:28:10 +01:00
Marko Tibold
aba0172f5c Update docs/api-guide/fields.md
Fix typo.
2012-10-22 21:31:15 +03:00
Tom Christie
95a670de41 Merge field changes: .default and .widget 2012-10-22 15:24:09 +01:00
Tom Christie
13d0a82939 Minor docs tweaks 2012-10-21 17:40:49 +01:00
Marko Tibold
65d4970bf7 Changed IsAdmin -> IsAdminUser in example 2012-10-21 16:34:50 +02:00
Marko Tibold
71a93930fd Fixing spelling errors. 2012-10-21 16:34:07 +02:00
Tom Christie
efabd2bb1b docs, docs, docs, docs, docs, docs, docs 2012-10-19 19:59:55 +01:00
Tom Christie
0c65d9babe Merge pull request #304 from tomchristie/consitent_settings
Make settings consistent with corrosponding view attributes
2012-10-18 04:46:01 -07:00
Tom Christie
e8f542aac8 Minor docs fix 2012-10-18 09:19:38 +01:00
Tom Christie
fed235dd01 Make settings consistent with corrosponding view attributes 2012-10-17 23:09:11 +01:00
Tom Christie
e126b61542 Negotiation API finalized. .select_renderers and .select_parsers 2012-10-17 22:58:18 +01:00
Tom Christie
fb56f215ae Added media_type to .parse() - Consistency with renderer API. 2012-10-17 22:39:07 +01:00
Tom Christie
4231995fbd parser_context includes view, request, args, kwargs. (Not meta and upload_handlers)
Consistency with renderer API.
2012-10-17 22:19:59 +01:00
Tom Christie
99d48f9003 Drop .parse_string_or_stream() - keep API minimal. 2012-10-17 22:07:56 +01:00
Tom Christie
cab4a2a5ad Split up doc sections more cleanly 2012-10-17 15:41:57 +01:00
Tom Christie
b78872b7db Use two seperate exceptions - AuthenticationFailed, and NotAuthenticated
Cleaner seperation of exception and resulting HTTP response.
Should result in more obvious error messages.
2012-10-17 15:23:36 +01:00
Tom Christie
a4d500ba10 Use correct status code 2012-10-17 15:10:11 +01:00
Tom Christie
5ae49a4ec4 Add docs for 401 vs 403 responses 2012-10-17 14:59:53 +01:00
Tom Christie
4c17d1441f Add Unauthenticated exception. 2012-10-17 14:59:37 +01:00
Tom Christie
bd8360c826 Highlight use of permissions alnog with authentication 2012-10-17 14:02:30 +01:00
Tom Christie
9c1fba3483 Tweak parsers to take parser_context 2012-10-15 13:27:50 +01:00
Jens Alm
c942726509 Added docs, integer fields and refactored models.TextField to use CharField
I realized that per the django forms, there is no need for a separate
TextField, an unlimited CharField is perfectly good.
Also added default field for the different IntegerField types
2012-10-15 13:46:44 +02:00
Tom Christie
41dd63b3b0 Merge branch 'restframework2' of https://github.com/tomchristie/django-rest-framework into restframework2 2012-10-14 22:43:41 +01:00
Tom Christie
551c86c43a Documentation for parsers 2012-10-14 22:43:07 +01:00
Tom Christie
7a89d7a770 Work on docs 2012-10-14 20:46:38 +01:00
Tom Christie
27b8904ffe Fix typo 2012-10-13 23:28:05 +02:00
Tom Christie
fe5db41949 Fix typo 2012-10-13 15:12:44 +01:00
Tom Christie
7608cf1193 Improve documentation for Requests 2012-10-13 15:07:43 +01:00
Tom Christie
648d2be29b Make sure JSON output in Browseable API is nicely indented 2012-10-10 12:15:18 +01:00
Tom Christie
ccd2b0117d Permissions and throttles no longer have a view attribute on self. Explicitly passed to .has_permissions(request, view, obj=None) / .allow_request(request, view) 2012-10-10 10:02:37 +01:00
Tom Christie
9bbc1cc403 Add flag in get_related_field 2012-10-09 17:49:04 +01:00
Tom Christie
b0c370dd2b Fixed couple of incorrect imports in the docs 2012-10-09 17:36:03 +01:00
Tom Christie
52a2ff8f77 Docs tweaks 2012-10-09 16:44:49 +01:00
Tom Christie
97a7f27c82 Rename HTMLTemplateRenderer -> HTMLRenderer, DocuemntingHTMLRenderer -> BrowseableAPIRenderer 2012-10-09 15:58:48 +01:00
Tom Christie
b581ffe323 Docs tweaks 2012-10-08 15:46:52 +01:00
Tom Christie
f79ed6175d Add RetrieveDestroyAPIView and remove Metadata mixin 2012-10-08 14:13:15 +01:00
Tom Christie
9bc4aead65 Tweak fields docs 2012-10-05 19:26:57 +01:00
Tom Christie
cc21948a69 Fix django 1.3 bug 2012-10-05 17:02:33 +01:00
Tom Christie
84958d131a Doc style tweaks 2012-10-05 15:22:30 +01:00
Tom Christie
3e862c7737 Tweak view slightly 2012-10-05 14:22:02 +01:00
Tom Christie
6a15556384 Docs tweaks 2012-10-05 14:00:02 +01:00
Tom Christie
1a09983dfc Tweak doc headings 2012-10-05 13:51:09 +01:00
Tom Christie
2575ea92aa Docs for template responses 2012-10-05 13:04:34 +01:00
Tom Christie
26c7d6df6c HTMLTemplateRenderer working 2012-10-05 12:13:44 +01:00
Tom Christie
d07dc77e91 Accepted media type uses most specific of client/renderer media types. 2012-10-05 10:23:47 +01:00
Tom Christie
bcd2caf559 Abstract out the app_label on test models 2012-10-04 09:18:46 +01:00
Tom Christie
b89125ef53 Update view docs slightly 2012-10-02 21:26:15 +01:00
Tom Christie
ab173fd8f9 Fix bug where pk could be set in post data 2012-10-02 15:37:13 +01:00
Tom Christie
e7685f3eb5 URL overrides in settings fixed up slightly 2012-10-02 15:24:42 +01:00
Tom Christie
8855a462c6 Clean up docs slightly 2012-10-02 11:48:25 +01:00
Tom Christie
b526b82abf Placeholder for FBV docs 2012-10-02 11:04:06 +01:00
Tom Christie
34637bf857 Make example more realistic and less of a toy 2012-10-02 11:03:51 +01:00
Tom Christie
ae8a827004 Make 'results_field' attribute of BasePaginationSerializer public. 2012-10-02 10:40:43 +01:00
Tom Christie
2284e592de Clean up reverse docs slightly 2012-10-02 10:40:04 +01:00
Tom Christie
a8f6ac3f3a Renderer documentation 2012-10-02 10:39:28 +01:00
Tom Christie
dae6d09398 Add example of using paginator in a view 2012-10-01 16:27:22 +01:00
Tom Christie
8d1d990187 Pagination docs 2012-10-01 16:17:01 +01:00
Tom Christie
b16fb57771 Expand pagination support, add docs 2012-10-01 15:49:19 +01:00
Tom Christie
43d3634e89 Docs tweaking 2012-09-30 15:55:24 +01:00
Tom Christie
ee36e4ab0c Only display forms when user has permissions. #159 2012-09-27 21:51:46 +01:00
Tom Christie
0cc7030aab Fix @api_view decorator tests 2012-09-26 21:47:19 +01:00
Tom Christie
4b691c4027 Change package name: djangorestframework -> rest_framework 2012-09-20 13:06:27 +01:00
Tom Christie
a96211d3d1 Simplify negotiation. Drop MSIE hacks. Etc. 2012-09-16 21:48:55 +01:00
Tom Christie
eb761be9d0 Flesh out resources/routers part of tutorial 2012-09-14 12:43:14 +01:00
Tom Christie
886f8b4751 Tweak throttles and improve docs 2012-09-14 08:54:58 +01:00
Tom Christie
d8b5d6603e Tweak copy 2012-09-13 18:35:06 +01:00
Tom Christie
6c109ac60f Improve throttles and docs 2012-09-13 18:32:56 +01:00
Tom Christie
b16c45aa6d Tweak throttling/permissions/auth docs 2012-09-13 09:39:16 +01:00
Tom Christie
003a65f0e0 Tweaks to Token auth 2012-09-12 20:39:22 +01:00
Tom Christie
dac4cb9e8b GitHub link in toolbar 2012-09-12 13:11:26 +01:00
Tom Christie
c85f799ade Updating docs 2012-09-12 10:12:13 +01:00
Tom Christie
b5e07abc15 Move quote below title for consistency 2012-09-08 22:13:11 +01:00
Tom Christie
247696e820 Links to source files in docs 2012-09-08 22:06:13 +01:00
Mjumbe Wawatu Poe
8df71f4d1d Get rid of the BaseToken abstract model 2012-09-07 16:19:15 -04:00
Mjumbe Wawatu Poe
f741cdae44 Move TokenAuthentication class into djangorestframework.authentication 2012-09-07 16:15:33 -04:00
Mjumbe Wawatu Poe
3b1404bd7d Rename the default token class to "BasicToken" 2012-09-07 14:23:53 -04:00
Mjumbe Wawatu Poe
36cd91bbbe Update docs for tokenauth 2012-09-07 14:12:46 -04:00
Tom Christie
c648f2786f TODO notes in docs 2012-09-06 16:46:56 +01:00
Tom Christie
c707034649 Add more settings to settings.py 2012-09-06 15:57:16 +01:00
Tom Christie
224b538b31 Tidying up docs 2012-09-05 21:14:00 +01:00
Tom Christie
3a106aed79 Flesh out authentication docs 2012-09-05 20:10:06 +01:00
Tom Christie
ef5279e97c Improve docs 2012-09-05 13:03:55 +01:00
Tom Christie
40d1821f2d Add missing doc files 2012-09-05 10:01:43 +01:00
Tom Christie
deedf6957d REST framework 2 docs 2012-09-01 20:26:27 +01:00