encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-14 13:46:59 +03:00
Code Issues Packages Projects Releases Wiki Activity
4,605 Commits 18 Branches 132 Tags 104 MiB
b4550c65dd
Commit Graph

630 Commits

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