encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-13 13:16:55 +03:00
Code Issues Packages Projects Releases Wiki Activity
5,767 Commits 18 Branches 132 Tags 104 MiB
d9c934debd
Commit Graph

815 Commits

Author SHA1 Message Date
Xavier Ordoquy
0daf160946 Fix #2476 2015-01-28 00:06:34 +01:00
Jeff Fein-Worton
0a65913fea typo in fields.md 2015-01-24 18:34:16 -08:00
Jeff Fein-Worton
39da9c7c86 minor typo in viewsets docs 2015-01-24 12:53:21 -08:00
Tom Christie
35f6a82462 Added DictField and support for HStoreField. 2015-01-23 16:27:23 +00:00
Tom Christie
5bb348605e UUIDField docs 2015-01-23 15:31:08 +00:00
Tom Christie
39f26c9eca Merge master 2015-01-23 14:28:59 +00:00
Duncan Maitland
6e471ad8f4 fix link to Django CSRF docs 2015-01-22 18:29:20 +11:00
Tom Christie
9ec08ce578 Merge master 2015-01-21 13:12:14 +00:00
soooooot
3ca8f85a5b correcting unclosed quote in routers.md 
correcting unclosed quote in routers.md
 2015-01-20 22:24:58 +08:00
Tom Christie
6065cdbd93 Merge master 2015-01-19 15:16:57 +00:00
Tom Christie
53edd37df5 Tests for LimitOffsetPagination 2015-01-15 21:07:05 +00:00
Tom Christie
313aa727e3 Tweaks 2015-01-14 17:46:41 +00:00
Tom Christie
1bcec3a0ac API tweaks and pagination documentation 2015-01-13 17:14:13 +00:00
Carlton Gibson
41e13d73fa Merge pull request #2407 from philipn/filters_link_fix 
Fix link to `django-rest-framework-filters`
 2015-01-13 09:04:33 +01:00
Philip Neustrom
7f9a62a5bf Fix link to django-rest-framework-filters (formerly 
`django-rest-framework-chain`)
 2015-01-13 15:22:08 +08:00
Tom Christie
f0ad0a88c4 Link to Roy Fielding versioning interview. 2015-01-08 12:31:51 +00:00
Tom Christie
3dbcefb3c7 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2015-01-08 11:07:52 +00:00
Tom Christie
e61ef3d39f Minor docs updates 2015-01-08 11:07:47 +00:00
JocelynDelalande
fe92a2cfee fixed doc : DEFAULT_AUTHENTICATION_CLASSES -> DEFAULT_AUTHENTICATION 
+ It is consistent with docs about DEFAULT_PERMISSION_CLASSES
 2015-01-07 10:42:11 +01:00
Tom Christie
271b638df1 Update exception docs. Closes #2378. 2015-01-06 11:21:58 +00:00
Tom Christie
949e3b7507 Merge branch 'master' into version-3.1 2015-01-05 15:04:23 +00:00
Tom Christie
b6ca7248eb required=False allows omission of value for output. Closes #2342 2015-01-05 14:32:12 +00:00
Tom Christie
17665aa52a Add docs for OAuth, XML, YAML, JSONP packages. Closes #2179. 2015-01-05 12:26:15 +00:00
Tom Christie
6168f60ba8 Merge branch 'master' into version-3.1 2015-01-05 11:02:28 +00:00
Tom Christie
d8e66970a1 Note on using i18n_patterns with format_suffix_patterns. Closes #2278. 2014-12-28 12:14:07 +00:00
Tom Christie
8dc95ee221 Add notes on include and namespacing. Closes #2335. 2014-12-28 11:24:49 +00:00
Tom Christie
27f84aa0f3 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2014-12-28 11:02:36 +00:00
Tom Christie
a636320ff3 Add import notes in docs. Closes #2357 2014-12-28 11:02:19 +00:00
Rocky Meza
5b5652594a Typo manger => manager 2014-12-26 22:24:31 -07:00
Matías Lang
18687f075d Documented an optional argument of HyperlinkedIdentityField 
lookup_url_kwarg argument of HyperlinkedIdentityField wasn't documented
 2014-12-23 12:22:10 -03:00
Brian Stearns
3569674860 use of double quotes broke the code highlighting. 2014-12-21 18:53:35 -05:00
Tom Christie
2a1485e009 Final bits of docs for ModelSerializer fields API 2014-12-19 21:32:43 +00:00
Tom Christie
48d15f6ff8 Stub out the documentation 2014-12-19 16:58:35 +00:00
Tom Christie
d109ae0a2e Merge pull request #2010 from tanwanirahul/master 
Ability to customize method names without creating a custom router
 2014-12-19 16:09:01 +00:00
Rahul
b4a3e7f640 Updates url_path info per suggestion 2014-12-19 21:20:19 +05:30
Rahul
6aa0e307c9 Added documentation about url_path parameter for custom actions. 2014-12-19 20:31:21 +05:30
Tom Christie
435aef7738 Merge branch 'master' into version-3.1 2014-12-19 11:53:05 +00:00
Tom Christie
7105c1308e Add OPTIONS/metadata to docs index 2014-12-18 15:42:27 +00:00
Tom Christie
c8d88c8c8a Merge branch 'master' into version-3.1 2014-12-18 11:21:25 +00:00
Tymur Maryokhin
eeb6e34064 Docs/tutorial import fixes. Refs #2296 2014-12-17 17:28:11 +01:00
Tom Christie
265ed9377e Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2014-12-17 16:19:13 +00:00
Tom Christie
c9a2ce0703 Expand permissions docs. Closes #2223. 2014-12-17 16:19:02 +00:00
Tom Christie
ad6533e554 Merge pull request #2294 from tomchristie/fix-empty-html-values-with-default 
Fix empty HTML values when a default is provided.
 2014-12-17 15:24:01 +00:00
Tom Christie
3fff5cb6e0 Fix empty HTML values when a default is provided. 2014-12-17 15:13:48 +00:00
Tom Christie
c6137bbf5a Serializer API restrictions. 2014-12-17 14:14:51 +00:00
Tom Christie
05a6eaec8a More docs, plus 'ALLOWED_VERSIONS' setting. 2014-12-17 12:41:46 +00:00
Tom Christie
6e51e4f5cd Versioning first pass 2014-12-16 15:34:19 +00:00
José Padilla
d71ef9c6d8 Closes #2281 2014-12-15 21:48:31 -04:00
Tom Christie
b6ee784240 Merge master 2014-12-15 12:18:55 +00:00
Jason Spafford
56c09cc1f2 Doc typo 2014-12-15 02:41:39 -08:00
Tom Christie
d232c5739e Merge branch 'exception-handler-context' of git://github.com/jpadilla/django-rest-framework into version-3.1 2014-12-15 09:19:53 +00:00
Tom Christie
4778463e32 Merge branch 'master' into version-3.1 2014-12-15 09:18:11 +00:00
José Padilla
478c8d724b Update docs 2014-12-14 10:16:52 -04:00
Brian Jacobel
2d470eef80 Change serializers.Field to serializers.ReadOnlyField for 3.x compatibility 
Using this code snippet as-is on DRF 3.0.1 results in a NotImplementedError
being raised for to_representation due to 3.0's changed behavior with
serializers.Field. The code snippet should be updated to use
serializers.ReadOnlyField instead.

Further discussion here:
https://groups.google.com/forum/?fromgroups=#!topic/django-rest-framework/aX8mLT_v3yc
 2014-12-13 14:47:11 -05:00
Jeff Fein-Worton
00da241482 documentation typo 
base-name -> base_name
 2014-12-12 22:14:22 -08:00
Tom Christie
baaa356489 Merge master 2014-12-12 15:37:43 +00:00
Tom Christie
f5b783af61 allow_blank in ChoiceField. Refs #2239. 2014-12-09 14:21:31 +00:00
Mark Henwood
9b468fba60 Amend ViewSet docs to warn of potential problem 
I went through this exact problem and so thought the docs might
benefit from a small hint at the appropriate point.
 2014-12-07 12:02:43 +00:00
Tom Christie
59b2ad5425 Minor docs tweaks 2014-12-05 13:23:14 +00:00
Tom Christie
e2587c7b4d Merge pull request #2204 from carltongibson/default-docs-fix 
Clarify read-only & `unique_together` Documentation
 2014-12-05 13:20:16 +00:00
Tom Christie
9fb1b396db user in example should have been instance. Closees #2191. 2014-12-05 13:07:31 +00:00
Carlton Gibson
6ee361332b Add missing definite article 2014-12-04 14:15:01 +01:00
Carlton Gibson
71e1a3942e Initial link from Serializers to Validators 2014-12-04 12:15:14 +01:00
Tom Christie
3d6620c72a Merge 2014-12-03 23:24:06 +00:00
Tom Christie
f74e52b31e Merge 2014-12-03 23:14:58 +00:00
Tom Christie
6369f92125 Merge 2014-12-03 23:12:52 +00:00
Matías Lang
5ad22aea60 Updated serializers documentation 
There was an error in the docs: the field extra_field_kwargs of the serializer's Meta doesn't work. The field must be extra_kwargs instead.
 2014-12-02 12:23:25 -03:00
David Ray
84cff98fbf fix typo 2014-12-02 09:46:43 -05:00
Tom Christie
6ac79b8223 Document Field.fail(). Closes #2147. 2014-12-02 09:19:59 +00:00
Tom Christie
f4fc4670ca Promote 'many_init' to public API. Closes #2152. 2014-12-02 08:53:36 +00:00
Tom Christie
555c450497 Add missing 'validators.py' link. Closes #2166. 2014-12-01 14:46:47 +00:00
José Padilla
7f9dc73672 Remove XML support from core 2014-11-29 14:57:51 -04:00
José Padilla
fe745b9616 Remove JSONP support from core 2014-11-29 14:55:33 -04:00
José Padilla
731c8421af Remove YAML support from core 2014-11-29 14:43:05 -04:00
José Padilla
0cc990792c Merge branch 'version-3.1' into oauth_as_package 
Conflicts:
	requirements-test.txt
	rest_framework/compat.py
	tests/settings.py
	tox.ini
 2014-11-28 12:14:40 -04:00
Tom Christie
08c727add3 @api_view defaults to allowing GET 2014-11-28 15:55:02 +00:00
Tom Christie
9ba29a88d6 Finalizing 3.0 release notes 2014-11-28 14:43:33 +00:00
Tom Christie
8e549a76ea Add 2.x notes and links 2014-11-28 14:26:03 +00:00
Tom Christie
276a2a52ee Docs on nested creates/updates and suchlike 2014-11-28 11:26:35 +00:00
Tom Christie
34ca8cd2a5 Moar docs. Amazing. 2014-11-28 09:56:44 +00:00
Tom Christie
0262262fee 3.0 serializer docs 2014-11-27 08:09:58 +00:00
Tom Christie
786cab705a Tweak to 3.0 relationship docs 2014-11-26 11:38:48 +00:00
Tom Christie
5a5a73c7fe 3.0 docs and tidy-up for serializer relationships 2014-11-26 11:30:49 +00:00
Tom Christie
e1b14cbe4a 3.0 docs for serializer fields 2014-11-26 10:27:29 +00:00
Tom Christie
0f5338ada9 Call out removal of pre_save/post_save more strongly 2014-11-26 09:06:15 +00:00
Tom Christie
c01c631ef2 perform_create, perform_update, perform_destroy hooks 2014-11-26 09:04:48 +00:00
Tom Christie
31536566d7 Updating fields docs 2014-11-25 17:35:27 +00:00
Tom Christie
f13c0ebe69 Merge master 2014-11-25 16:27:00 +00:00
Tom Christie
8c91e7b742 Add missing options 2014-11-25 15:52:13 +00:00
José Padilla
16d442dda3 Use MkDocs meta.source to render source code links 2014-11-25 12:44:11 +00:00
Tom Christie
c4dff54ecc Docs on ValidationError 2014-11-25 12:04:46 +00:00
Tom Christie
a3c0c8fb90 Add missing period. 2014-11-25 12:04:35 +00:00
Tom Christie
2e726e22a3 request.DATA, request.FILES -> request.data 2014-11-25 11:42:43 +00:00
Matthew Dapena-Tretter
8e940a22fb Clarify how permission classes are composed 
all/every/AND or any/OR? all/every/AND!
 2014-11-21 16:04:45 -05:00
Tom Christie
0f508c5821 Docs for advanced default argument usage. Closes #1945 2014-11-17 18:36:32 +00:00
Eleni Lixourioti
1aa7783095 Merge branch 'version-3.1' of github.com:tomchristie/django-rest-framework into oauth_as_package 
Conflicts:
	.travis.yml
 2014-11-15 14:27:41 +00:00
Tom Christie
fd7db776ad Bring UniqueValidator implementation in line with other uniquness validators. 2014-11-10 12:32:03 +00:00
Tom Christie
f387cd89da Uniqueness constraints imply a forced 'required=True'. Refs #1945 2014-11-10 12:21:27 +00:00
Brett Koonce
b44def4650 minor spelling tweaks 2014-11-06 23:19:26 -08:00
Tom Christie
5250700659 Add docs on request.accepted_renderer and .accepted_media_type 2014-11-05 11:14:41 +00:00
Tom Christie
571440e143 Stronger calling out of 'DjangoObjectPermissionsFilter'. Closes #1934. 2014-11-05 10:53:46 +00:00
Tom Christie
09f3eedb23 Add notes re view-level and instance-level permissions checks. Closes #1819. 2014-11-03 15:23:16 +00:00
Tom Christie
78ac332f18 Add docs on Meta inheritance. Closes #1926. 2014-11-03 15:08:19 +00:00
Tom Christie
21d06a4103 Added NON_FIELD_ERRORS_KEY to serializer docs. Closes #1971. 2014-11-03 15:03:10 +00:00
Tom Christie
d27b8cc09b PUT as create docs, and move mixin out to external gist 2014-11-03 12:00:19 +00:00
Tom Christie
0e59c27e2f Merge branch 'master' into version-3.0 2014-10-31 15:19:40 +00:00
Tom Christie
159c3de9fc Merge master 2014-10-31 15:19:15 +00:00
Tom Christie
254701230d Fix up validators docs 2014-10-31 13:58:40 +00:00
Tom Christie
2762205887 Validator documentation and tweaks 2014-10-31 13:47:36 +00:00
Andrew Conti
f25f05dde5 Update authentication.md 
Based on the [new documentation](https://docs.djangoproject.com/en/dev/topics/auth/customizing/#django.contrib.auth.get_user_model) for Django 1.7 we should now use:

```python
@receiver(post_save, sender=settings.AUTH_USER_MODEL)
```
instead of:

```python 
@receiver(post_save, sender=get_user_model())
```
because `get_user_model()` only works once Django has imported all models. Otherwise you'll get: 

```python
django.core.exceptions.AppRegistryNotReady: Models aren't loaded yet.
```
When trying to start your sever after adding token authentication.

From the Docs, ( linked above as well ) :
>New in Django 1.7:
>When connecting to signals sent by the User model, you should specify the custom model using the AUTH_USER_MODEL setting.
 2014-10-29 16:31:36 -04:00
konradhalas
113a28ed8a Add djoser to authentication docs. 2014-10-16 13:48:18 +02:00
Tom Christie
babdc78e61 Typo 2014-10-09 11:39:01 +01:00
Tom Christie
6637b2fae0 Document the Metadata API 2014-10-09 11:08:26 +01:00
Craig de Stigter
dfab9af294 Minor: fix spelling and grammar, mostly in 3.0 announcement 2014-10-03 08:41:18 +13:00
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
Jharrod LaFon
baa518cd89 Moved OAuth support out of DRF and into a separate package, per #1767 2014-09-05 15:30:01 -07: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