encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-23 10:03:57 +03:00
Code Issues Packages Projects Releases Wiki Activity
4,775 Commits 18 Branches 132 Tags 105 MiB
01bb85e80a
Commit Graph

650 Commits

Author SHA1 Message Date
Tom Christie
ac71d9aaae Merge master 2014-09-26 14:39:20 +01:00
Collin Anderson
da385c9c1f remove patterns and strings from urls #1898 2014-09-23 17:10:02 -04:00
Tom Christie
88008c0a68 Merge branch 'master' into version-3.0 2014-09-19 14:05:50 +01:00
Matthew J Morrison
764366b2e1 Fixed code formatting 2014-09-17 11:29:15 -05:00
Matthew J Morrison
e5af0bbb35 Clarify "raised inside REST framework" 
I ran into an issue today where I was not seeing the rest_framework.views.exception_handler do what I thought it should be doing. It turned out that I had imported View from rest_framework.views rather than importing APIView from rest_framework.views. The phrase "raised inside REST framework" was confusing as I was debugging this issue. I was unsure if that meant that I could raise those exceptions in my code or if it had to originate from within framework code.

I'm not sure if the proposed wording is ideal, I just wanted to point out what I found to be confusing.
 2014-09-17 07:49:54 -05:00
Tom Christie
4fceceae7d DecimalField documentation 2014-09-12 20:09:08 +01:00
Tom Christie
f95e7fae38 Updating docs 2014-09-12 12:40:53 +01:00
Tom Christie
19b8f779de Throttles now use Retry-After header and no longer support the custom style 2014-09-11 20:43:44 +01:00
Tom Christie
de301f3b66 Merge master 2014-09-11 13:20:44 +01:00
S. Andrew Sheppard
e76f56a3d6 add django rest pandas 2014-09-10 11:55:43 -05:00
Darren Maki
fe06d96dec Fixing quotes in filtering.md 
Incorrect quotes used in examples.
 2014-09-07 12:53:21 -04:00
Tom Christie
0f8fdf4e72 Remove allow_empty. 
Closes #1774.
 2014-08-29 10:57:24 +01:00
Tom Christie
d8eb9e6d45 Docs whitespace fix. 2014-08-29 10:48:16 +01:00
Tom Christie
8f4ae06b3b Merge pull request #1784 from tomchristie/remove-model-attribute 
Deprecate `.model` attribute on views
 2014-08-29 10:03:07 +01:00
Nathan Hubbell
be21cafd2b Update generic-views.md 
Small grammar changes.
 2014-08-27 17:57:40 -07:00
Nathan Hubbell
19076510f4 Update generic-views.md 2014-08-26 17:31:08 -07:00
Carlton Gibson
c29c75da28 Merge pull request #1789 from nemesisdesign/patch-5 
docs: added drf-hstore to third party fields
 2014-08-26 11:19:48 +02:00
Federico Capoano
eb81c55d16 docs: added HStoreSerializer to third party serializers 
added a reference to django-rest-framework-hstore in docs/api-guide/serializers.md
 2014-08-25 12:32:44 +02:00
Federico Capoano
8e3f7700f6 docs: added drf-hstore to third party fields 
added a reference to django-rest-framework-hstore in docs/api-guide/fields.md
 2014-08-25 12:29:10 +02:00
Tom Christie
8b2052172c Add .model deprecation to release notes 2014-08-21 12:25:20 +01:00
Tom Christie
4d8c63abc9 Deprecate .model in related routers/permissions 2014-08-20 17:15:46 +01:00
Tom Christie
0c65e028b6 Release notes 2014-08-19 23:25:12 +01:00
Tom Christie
e385a7b8eb Merge master 2014-08-19 10:11:10 +01:00
Tom Christie
2aad8e4b35 Merge pull request #1654 from carltongibson/1559-take-2 
Allow use of native migrations in 1.7 — Take 2
 2014-08-18 18:54:43 +01:00
Carlton Gibson
556948661a Improve wording. 2014-08-18 13:54:46 +02:00
Carlton Gibson
db4426fc35 Alter other reference to migrations. 2014-08-18 13:52:57 +02:00
Carlton Gibson
ae2ab496c2 Updated docs for South v1.0 2014-08-18 13:48:46 +02:00
Tom Christie
8244c7cc33 Merge pull request #1711 from kdazzle/ModelViewSet-queryset-static-property 
Issue #1707: Add documentation to api-docs.viewsets
 2014-08-18 12:25:03 +01:00
Tom Christie
6edbabe0e1 Link to Django docs on widgets. Closes #1760. 2014-08-18 10:58:00 +01:00
Tom Christie
c6326d0a67 Merge pull request #1745 from nemesisdesign/patch-4 
docs: add reference to gis serializer
 2014-08-09 07:41:37 +01:00
Federico Capoano
c462a43a87 docs: added reference to gis serializer 
added reference to GeoFeatureModelSerializer of django-rest-framework-gis
 2014-08-08 14:39:56 +02:00
Federico Capoano
5eb901cd2a docs: added reference to DRF-gis in fields 
added django-rest-framework-gis to third party packages section in /docs/api-guide/fields.md
 2014-08-08 14:25:02 +02:00
Rob Terhaar
3217842346 minor doc fix, @api_view() needs an iterable 2014-08-06 18:55:08 -04:00
Kevin London
c0f002b09d Updated Permissions doc link to Django docs 
The previous link went to version 1 docs so it was a dead link.
 2014-07-31 12:41:15 -07:00
Tom Christie
57d6e04ff5 Add django-rest-framework-mongoengine link. Closes #1722 Closes #1562 Closes #1545 2014-07-30 12:50:36 +01:00
Kyle
fc8eb76c22 Issue #1707 - Add info about queryset property caching to get_queryset() docs. 
Add documentation to the get_queryset() method of generic-views.md regarding
the caching of the queryset property.
 2014-07-28 10:19:42 -07:00
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
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
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
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
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
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
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
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
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
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