encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-10-30 23:47:53 +03:00
Code Issues Packages Projects Releases Wiki Activity
4,237 Commits 16 Branches 134 Tags 128 MiB
a6c73c6f90
Commit Graph

1417 Commits

Author SHA1 Message Date
Kyle
e40ffd60d4 Issue #1707 - Add documentation about the caching of GenericAPIView.queryset 
to the `queryset` property, `get_queryset()`, and do generic-views.md; remove
changes to the viewsets.md documentation from my last commit.
 2014-07-28 10:11:40 -07:00
Kyle Valade
48b02f016a Issue #1707: Add documentation to api-docs.viewsets notifying users 
that they should use the get_queryset() method when overriding a
ModelViewSet method, such as list(). Otherwise, since queryset is
a static property, the value will be cached for every instance of
that ViewSet.
 2014-07-27 14:01:43 -07:00
Xavier Ordoquy
4876bec9f5 Merge remote-tracking branch 'origin/master' into 2.4.0 
Conflicts:
	rest_framework/fields.py
 2014-07-26 00:06:56 +02:00
Tom Christie
299a8347e8 Merge pull request #1692 from davbo/patch-1 
Update fields.md
 2014-07-22 15:59:04 +02:00
Tom Christie
81d15aa9be Add link to drf-extra-fields. Closes #1698 2014-07-20 15:45:45 +01:00
Tom Christie
4324f50437 Phrasing tweak 2014-07-18 11:54:51 +01:00
Tom Christie
ab34ddcf2f Typo 2014-07-18 11:53:23 +01:00
Tom Christie
550243fd26 Beef up the kickstarter announcement 2014-07-18 11:51:48 +01:00
Tom Christie
ead0e60099 Docs for kickstarter announcement 2014-07-17 17:17:41 +01:00
Tom Christie
6bf0f81b0b Kickstarter note on front page 2014-07-17 13:41:19 +01:00
Dave King
680fabe9dd Update fields.md 
obj.__class__ will return the actual Class object, we want to serialise a string (accessed with obj.__class__.__name__)
 2014-07-17 11:46:59 +01:00
Tom Christie
dd2e950cde Fusion ads 2014-07-15 15:02:09 +01:00
Emmanouil
18eab53e89 Updated quick start project set up order 2014-07-09 15:53:31 +01:00
Tom Christie
b519018125 Docs on object level permissions and filters. Closes #1683 2014-07-07 09:51:23 +01:00
Tom Christie
91eabd54bb Docs tweak 2014-07-01 14:34:23 +01:00
Chibisov Gennady
c1426d1078 Fixes #1651. Add link to drf-extensions nested routers to docs 2014-06-26 23:29:00 +04:00
Carlton Gibson
d98245ac22 Merge branch '2.4.0' of github.com:tomchristie/django-rest-framework into #1559 
Conflicts:
	docs/topics/release-notes.md
 2014-06-24 10:30:08 +02:00
Carlton Gibson
3f727ce738 Added (first pass) notes to docs & release notes. Backed out SOUTH_MIGRATION_MODULES setting from rest_framework.settings 2014-06-24 09:02:44 +02:00
Xavier Ordoquy
2489e38a06 Merge remote-tracking branch 'origin/master' into 2.4.0 
Conflicts:
	.travis.yml
	docs/api-guide/viewsets.md
	rest_framework/serializers.py
	rest_framework/throttling.py
	tests/test_generics.py
	tests/test_serializers.py
	tox.ini
 2014-06-23 14:02:45 +02:00
Walt Javins
b4c7717cb8 Refactor login template to extend base. 
While experimenting with extending DRF, I found that the login page
1) had no title, and 2) duplicated <head> info from base.html.

This change adds a new {% block body %} to the base.html template
which allows override of the entire html <body>. login_base.html
has its duplicated head info stripped, and now extends base.html
to share common html <head> templating.

As part of this change, pretify.css is unnecessarily added to
login_base.html.  If this is deemed a problem, it will be easy to
block that css out, and have login_base.html override the block.

Ideally, I would have liked to create a new api_base.html that extends
base.html, move the api specific logic into that template, and leave
base.html content agnostic, to truely be a unifying base for all DRF
pages.  But this change would break current apps that override
api.html and expect base.html to be the immediate super template. :/

This change is benificial because it:
 - removes duplication of header declarations (mostly css includes)
 - adds a html title to the login page
 - standardizes html header info across all DRF pages

Docs are updated to reflect the new structure.
 2014-06-13 22:26:00 -07:00
Tom Christie
82659873c9 Fix accidental docs change 2014-06-12 11:48:58 +01:00
Tom Christie
1386767013 Version 2.3.14 2014-06-12 11:47:26 +01:00
Greg Barker
be84f71bc9 Fix #1614 - Corrected reference to serializers.CharField 2014-06-10 15:20:45 -07:00
Rodolfo Carvalho
31f63e1e55 Fix typo in docs 2014-06-02 11:06:03 +02:00
Tom Christie
a7ff51118f Note on configuring TokenAuthentication 2014-05-29 14:33:16 +01:00
khamaileon
eab5933070 Add the allow_add_remove parameter to the get_serializer method 2014-05-26 18:43:50 +02:00
Tom Christie
218b94e606 Merge pull request #1536 from Ian-Foote/choicefield_blank_display_value 
Allow customising ChoiceField blank display value
 2014-05-20 16:03:51 +01:00
Ian Foote
1e7b5fd2c0 Document ChoiceField blank_display_value parameter 2014-05-20 14:55:00 +01:00
Giorgos Logiotatidis
768f537dcb Typo fix. 2014-05-15 15:42:22 +03:00
Sylvain Bellemare
e033a0b9a0 Replaced singular "is" by plural "are" 2014-05-06 15:08:53 +02:00
Sylvain Bellemare
beb7253a96 Removed unnecessary "that" 2014-05-06 15:08:53 +02:00
Sylvain Bellemare
9dc5e15e5a Added missing "the" word 2014-05-06 15:08:53 +02:00
Sylvain Bellemare
9e3ba939e1 Removed superfluous "./"s 2014-05-05 20:28:00 +02:00
Sylvain Bellemare
05fc974dc9 Added missing "the" word 2014-05-05 14:44:54 +02:00
Sylvain Bellemare
cdc7d19034 Added missing "to" word 2014-05-05 14:41:10 +02:00
Xavier Ordoquy
15c2c58b43 Updated the release-notes. 2014-05-01 08:43:49 +02:00
Xavier Ordoquy
7b4463f739 Merge remote-tracking branch 'reference/2.4.0' into feature/pytest 
Conflicts:
	rest_framework/runtests/urls.py
	tests/test_response.py
	tox.ini
 2014-05-01 08:01:38 +02:00
Xavier Ordoquy
2aca69a946 Merge remote-tracking branch 'reference/master' into feature/pytest 
Conflicts:
	tests/test_serializer.py
 2014-04-30 22:24:01 +02:00
Xavier Ordoquy
56b4390316 Merge remote-tracking branch 'origin/master' into 2.4.0 
Conflicts:
	.travis.yml
	rest_framework/serializers.py
	rest_framework/tests/test_authentication.py
 2014-04-30 22:21:26 +02:00
Xavier Ordoquy
d8fb81ceb1 Merge pull request #1391 from kaygorodov/master 
Turning off pagination
 2014-04-30 20:14:16 +02:00
Laurent Bristiel
d8cb85ef8f typo 2014-04-28 22:00:36 +02:00
dpetzel
5e8f05a8de very minor typo in code example 2014-04-28 13:51:50 -04:00
Xavier Ordoquy
f4a82dd5da Updated the release notes. 2014-04-24 14:33:36 +02:00
Xavier Ordoquy
1797a74e82 Merge remote-tracking branch 'pelme/pytest' into feature/pytest 
Conflicts:
	.travis.yml
	rest_framework/runtests/runtests.py
	tests/test_filters.py
	tests/test_pagination.py
	tox.ini
 2014-04-17 09:53:44 +02:00
Xavier Ordoquy
d08536ad9d Merge remote-tracking branch 'origin/master' into 2.4.0 
Conflicts:
	.travis.yml
	docs/api-guide/fields.md
	docs/api-guide/routers.md
	docs/topics/release-notes.md
	rest_framework/authentication.py
	rest_framework/serializers.py
	rest_framework/templatetags/rest_framework.py
	rest_framework/tests/test_authentication.py
	rest_framework/tests/test_filters.py
	rest_framework/tests/test_hyperlinkedserializers.py
	rest_framework/tests/test_serializer.py
	rest_framework/tests/test_testing.py
	rest_framework/utils/encoders.py
	tox.ini
 2014-04-13 00:05:57 +02:00
Miro Hrončok
f68596a732 Document new UnicodeYAMLRenderer 2014-04-10 01:58:06 +02:00
Craig
3234a5dd6b Fix python syntax in filtering docs 2014-04-08 22:56:07 -04:00
Dmitry Mukhin
e45e52a255 replace page with page_size to avoide confusion 2014-04-07 20:39:45 +04:00
Tom Christie
abe14c06f7 Minor docs tweak 2014-03-17 08:36:13 +00:00
Tom Christie
dddbff5931 Tweak DRF compound fields docs 2014-03-17 08:33:18 +00:00
Steven Cummings
c779dce3e4 Serializer fields section for 3rd-party packages 
* Add new section to serializer fields page where we can list and link 3rd-party packages that provide more field types
* Add an entry for drf-compound-fields
 2014-03-16 18:55:21 -05:00
Peter Inglesby
2353878951 Add SEARCH_PARAM and ORDERING_PARAM to settings 
Fixes #1434
 2014-03-06 21:39:44 +00:00
Tom Christie
c1148241ee Version 2.3.13 2014-03-06 09:01:05 +00:00
Andreas Pelme
971578ca34 Support for running the test suite with py.test 
* Get rid of runtests.py
 * Moved test code  from rest_framework/tests and rest_framework/runtests to tests
 * Invoke py.test from setup.py
 * Invoke py.test from Travis
 * Invoke py.test from tox
 * Changed setUpClass to be just plain setUp in test_permissions.py
 * Updated contribution guideline to show how to invoke py.test
 2014-03-02 12:40:30 +01:00
Kumar McMillan
c2cd610b15 Adds HawkREST to 3rd party auth docs 2014-02-28 16:52:47 -06:00
Kumar McMillan
a4470c4276 Fix trailing whitespace 
Sorry, my editor does this automatically
 2014-02-28 16:51:32 -06:00
Kumar McMillan
e2857bdcff Fix link to tox 2014-02-28 16:35:03 -06:00
Kumar McMillan
f5f4c1a837 strip trailing whitespace 
my editor does this by default
 2014-02-28 16:34:42 -06:00
DanSears
abb240648c clarified which urls.py to edit 2014-02-28 08:40:45 -08:00
Charlie Denton
c3967c08ab Minor docs example fix 
Dates are smaller when they happen before.
 2014-02-21 14:23:33 +00:00
Tom Christie
9841069373 Link to DRF-extensions. Refs #1430 2014-02-20 14:54:17 +00:00
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
Tom Christie
aaa5885232 Update credits 2014-02-13 17:40:00 +00:00
Tom Christie
c465ceaf5c Merge pull request #1417 from amezhenin/issue_1386 
Add myself into credits.md
 2014-02-13 17:38:38 +00:00
Artem Mezhenin
45d89b5d11 credit, issue #1386, PR #1397 2014-02-13 21:25:35 +04:00
amatellanes
0cb08ac707 Fixed Testing docs section 2014-02-12 23:17:05 +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
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
2911cd64ad Minor tweaks to 'lookup_value_regex' work 2014-01-13 15:37:52 +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
Tom Christie
a90796c0f0 Track changes that need noting in 2.4 announcement 2014-01-13 09:56:57 +00: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
Tom Christie
2b033d2456 New font in logo 2014-01-07 14:57:00 +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
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
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
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
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
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
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
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