Commit Graph

1763 Commits

Author SHA1 Message Date
José Padilla
d6b203f013 Use page_title instead of title in docs theme 2014-11-25 12:43:02 +00:00
Dougal Matthews
2ddef2d326 Drop simply from the mkdocs install lines
It is still simple tho', honest ;)
2014-11-25 12:43:02 +00:00
Dougal Matthews
84d9c4b46e Change site_dir to html to match mkdocs.py 2014-11-25 12:42:39 +00:00
Dougal Matthews
261c4ce9af Remove redundant requirements file 2014-11-25 12:32:29 +00:00
Dougal Matthews
3a648b9f0b Migrate documentation to MkDocs proper 2014-11-25 12:32:29 +00:00
Tom Christie
3b40f8c1c1 Drop 0.x release notes 2014-11-25 12:15:48 +00:00
Tom Christie
83281254d1 Hypenate 'un-coerced' 2014-11-25 12:06:27 +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
Marc
83e556ba1e Missing quotes on validate_score example 2014-11-25 12:37:20 +01:00
Tom Christie
3371131a61 Merge pull request #2116 from LuRsT/patch-5
Fixed database update instructions
2014-11-24 13:21:15 +00:00
Gil Gonçalves
918b9cc6a6 Added missing import in tutorial snippet 2014-11-24 08:54:07 +00:00
Gil Gonçalves
790a651893 Fixed database update instructions 2014-11-24 08:51:08 +00:00
Tony Nguyen
c94d1e6d3e Fix typo "serailizers" to "serializers" 2014-11-23 22:40:40 +07: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
071c064d25 Fill in TODOs for 3.0 beta release notes 2014-11-20 14:22:53 +00:00
Tom Christie
6a2023a362 Note on 3.1 and 3.2 releases. 2014-11-20 13:52:00 +00:00
Tom Christie
096c58b784 Merge branch 'master' into 3.0-beta 2014-11-20 11:51:42 +00:00
Gil Gonçalves
04d2635b24 Removed unused import from code snippet in tutorial 2014-11-20 11:33:42 +00:00
Raony Guimarães
928cbc640e small type 2014-11-19 13:53:36 -02:00
Tom Christie
bc83dfece4 Merge branch 'master' into 3.0-beta 2014-11-19 14:04:31 +00:00
Tom Christie
51b7033e4a Further notes in 3.0 announcement 2014-11-19 14:03:19 +00:00
Tom Christie
f269826a7d Note on 3.0 beta 2014-11-18 16:26:45 +00:00
Tom Christie
5e74f02d61 Note removal of 'save_object' and fail loudly if it exists 2014-11-18 14:49:00 +00:00
Tom Christie
0f508c5821 Docs for advanced default argument usage. Closes #1945 2014-11-17 18:36:32 +00:00
José Padilla
d08cfb0559 Fix runtests examples
Correctly rename runtests examples to work with current runtests.py file.
2014-11-17 08:17:40 -04: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
ea98de9b88 Model fields with .blank or .null now map to required=False. Closes #2017. Closes #2021. 2014-11-13 19:28:57 +00:00
Tom Christie
fd7db776ad Bring UniqueValidator implementation in line with other uniquness validators. 2014-11-10 12:32:03 +00:00
Tom Christie
8c1fa0b87d Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2014-11-10 12:21:41 +00:00
Tom Christie
f387cd89da Uniqueness constraints imply a forced 'required=True'. Refs #1945 2014-11-10 12:21:27 +00:00
Jochen Van de Velde
440d61ab36 Fix some typos and other errors 2014-11-08 11:02:48 +01:00
José Padilla
058fea23d3 Fix csrf-ajax link. Closes #2045 2014-11-07 23:55:42 -04:00
Tom Christie
93633c297c Tweaks to release notes 2014-11-07 20:44:12 +00:00
Tom Christie
59b30307e8 Fixes to release notes 2014-11-07 20:10:15 +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
Sumana Harihareswara
7352405697 Updated book link in HATEOAS page
Per http://www.crummy.com/2013/10/03/0 , the new book is *RESTful Web APIs* and the old book, *RESTful Web Services*, is obsolete.
2014-11-04 17:18:13 -05:00
Tom Davis
3375fecc8b Fix typo
That's all.
2014-11-03 15:05:45 -05:00
Tom Christie
1925d465ae Call out 'get_value' and 'get_attribute' 2014-11-03 16:42:00 +00:00
Tom Christie
5d7b835608 Tweaks to validation notes 2014-11-03 16:17:53 +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
0da30e6d1d Add note about 3.0 being merged to master 2014-11-03 14:43:00 +00:00
Rocky Meza
9ce130d1b5 Fixed some typos in 3.0 release notes 2014-11-03 06:56:42 -07: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
37845968cd Merge master 2014-11-03 11:39:54 +00:00
Tom Christie
96bb77dc35 Version 2.4.4 2014-11-03 11:20:18 +00:00
Andy Baker
964b3401fb typo fix 2014-11-01 10:25:59 +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
Tom Christie
702f47700d Updated requirements 2014-10-24 12:12:01 +01:00
Tom Christie
c5d1be8eac .validate() can raise field errors or non-field errors 2014-10-22 10:32:32 +01:00
José Padilla
11edd01c34 Add docs regarding linking third party packages 2014-10-17 08:58:31 -04:00
Tom Christie
05cbec9dd7 Use serializers.ValidationError 2014-10-17 13:23:14 +01:00
Tom Christie
d0f610be44 Update release notes 2014-10-16 20:47:57 +01:00
konradhalas
5e89994a10 Add to main 3rd party resources list. 2014-10-16 15:16:13 +02:00
konradhalas
113a28ed8a Add djoser to authentication docs. 2014-10-16 13:48:18 +02:00
wolfe
f8f101268e Update 3.0-announcement.md
Swap order of custom field API changes so the two "and" clauses are in the same order.
2014-10-14 18:58:25 -03:00
Tom Christie
d8a8987ab1 Tweaks 2014-10-10 14:32:02 +01:00
Tom Christie
d9a199ca0d exceptions.ValidationFailed, not Django's ValidationError 2014-10-10 14:16:09 +01:00
Tom Christie
5d247a65c8 First pass on nested serializers in HTML 2014-10-09 15:11:19 +01: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
Tom Christie
a58cfe167d Update tutorial for 3.0 2014-10-09 09:38:03 +01:00
Tom Christie
4c015df28c Tweaks 2014-10-08 16:43:33 +01:00
Tom Christie
14ae52a24e More gradual deprecation 2014-10-08 16:09:37 +01:00
Tom Christie
0cbb57b40f Tweak pre/post save hooks. Return instance in .update(). 2014-10-08 12:17:30 +01:00
Kevin London
0803716ed0 Update links in 2.4-announcement.md
The links to Django Rest Framework pages were 404ing because the URLs include a slash.
2014-10-04 17:34:27 -07:00
Tom Christie
3a3e2bf57d Serializer.save() takes keyword arguments, not 'extras' argument 2014-10-03 13:42:06 +01:00
Craig de Stigter
857a8486b1 More spelling tweaks 2014-10-03 09:00:33 +13:00
Craig de Stigter
dfab9af294 Minor: fix spelling and grammar, mostly in 3.0 announcement 2014-10-03 08:41:18 +13:00
Omer Katz
770d63fb04 Fixed documentation typo. 2014-10-01 13:12:33 +03:00
Tom Christie
da4900a353 Update 3.0-announcement.md 2014-09-30 11:10:13 +01:00
Tom Christie
83a5ea8db2 Update release notes 2014-09-29 21:17:13 +01:00
Tom Christie
a8622adcd9 Update index.md 2014-09-29 16:57:40 +01:00
Tom Christie
657d1de032 Latest release notes 2014-09-29 14:12:09 +01:00
Tom Christie
4798df52df Update release notes 2014-09-29 12:57:05 +01:00
Tom Christie
ce04d59a53 Update release notes 2014-09-26 17:07:47 +01:00
Tom Christie
ac71d9aaae Merge master 2014-09-26 14:39:20 +01:00
Tom Christie
ee79b45397 Prepend some pre-release notes 2014-09-26 13:19:32 +01:00
Tom Christie
24f7db2fc1 Release notes 2014-09-26 13:12:10 +01:00
Tom Christie
0eb6a4de8a Release notes 2014-09-26 13:10:58 +01:00
Tom Christie
8b8623c5f8 Allow many, partial and context in BaseSerializer 2014-09-26 12:48:20 +01:00
Tom Christie
fde934d33c Release notes 2014-09-26 12:21:05 +01:00
Tom Christie
90311357ad Release notes 2014-09-26 12:18:27 +01:00
Tom Christie
e8af73d144 Release notes 2014-09-26 12:17:20 +01:00
Tom Christie
43e80c74b2 Release notes 2014-09-26 11:56:29 +01:00
Tom Christie
2859eaf524 request.data attribute 2014-09-26 10:46:52 +01:00
Tom Christie
630d472055 Merge branch 'master' into version-3.0 2014-09-24 14:10:00 +01:00
Collin Anderson
da385c9c1f remove patterns and strings from urls #1898 2014-09-23 17:10:02 -04:00
Tom Christie
c0150e619c Add BaseSerializer heading 2014-09-19 14:59:59 +01:00
Tom Christie
8495cd898a Drop 'No major point releases are currently planned.', cos they are. 2014-09-19 14:31:28 +01:00
Tom Christie
20424251a3 Version 2.4.3 2014-09-19 14:26:28 +01:00
Tom Christie
88008c0a68 Merge branch 'master' into version-3.0 2014-09-19 14:05:50 +01:00
Tom Christie
6d73b5969a Initial release notes 2014-09-19 14:02:17 +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
S. Andrew Sheppard
3725a1e77d add wq.db router and django-rest-pandas renderers 2014-09-15 14:46:09 -05:00
Tom Christie
cefeb23b25 Merge pull request #1871 from jpadilla/third-party-docs
Add Third Party Resources Topic section
2014-09-14 16:52:53 +01:00
José Padilla
915dfb9b3d Update third-party-resources.md 2014-09-14 10:19:54 -04:00
José Padilla
4871dbdc73 Add invitation to add new content 2014-09-13 16:20:37 -04:00
José Padilla
96c21b81f5 Add Third Party Resources Topic section 2014-09-13 13:53:40 -04: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
f08afe162c Version 2.4.2 2014-09-03 16:35:17 +01:00
Tom Christie
55e779c856 Version 2.4.1 2014-09-01 09:07:55 +01:00
Tom Christie
5490fc2700 Fix links in 2.4 release 2014-08-29 13:29:51 +01:00
Jamie Matthews
baceb528cb Fix typos in 2.4 release notes 2014-08-29 11:11:18 +01: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
572107281f Typo in 2.4 announcement name 2014-08-29 10:15:55 +01:00
Tom Christie
2a61ed8bac 2.4 Release notes 2014-08-29 10:10:17 +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
Tom Christie
bb1604674f Minor docs update 2014-08-29 09:21:10 +01:00
Tom Christie
e7e3d29de4 Sponsor fix 2014-08-28 17:35:45 +01:00
Tom Christie
2536b93c03 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2014-08-28 17:02:37 +01:00
Tom Christie
73bd408f78 Latest sponsor update 2014-08-28 17:01:58 +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
21a0a826bb Add Retry-After to release notes. Refs #1508. 2014-08-20 17:34:51 +01:00
Tom Christie
6953a5ecec Typo 2014-08-20 17:16:47 +01:00
Tom Christie
4d8c63abc9 Deprecate .model in related routers/permissions 2014-08-20 17:15:46 +01:00
Tom Christie
9372cc8c31 Deprecate .model attribute on views 2014-08-20 16:24:52 +01:00
Tom Christie
59b47eac14 Fix cache_throttle typo 2014-08-20 12:32:24 +01:00
Tom Christie
6ffc97c808 Merge pull request #1770 from tomchristie/2.4.0
2.4.0 Release.
2014-08-20 12:06:29 +01:00
Tom Christie
f7b3e1e62b Latest sponsor update 2014-08-20 11:09:04 +01:00
Tom Christie
874d2be83c Release notes 2014-08-20 00:19:03 +01:00
Tom Christie
0c65e028b6 Release notes 2014-08-19 23:25:12 +01:00
Tom Christie
63d02dbea8 Drop six from compat. 1.4.2 is now the lowest supported version. 2014-08-19 17:06:55 +01:00
Tom Christie
00c0dfc66f Documentation on runtests.py 2014-08-19 16:29:05 +01:00
Tom Christie
e385a7b8eb Merge master 2014-08-19 10:11:10 +01:00
Tom Christie
c092b4df78 Merge pull request #1641 from javins/login-title
Refactor login template to extend base.
2014-08-18 20:28:34 +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
61a1eaa485 tabs -> spaces 2014-08-18 11:55:22 +01:00
Tom Christie
92d51c813f Merge pull request #1688 from ekonstantinidis/quick-start-order
Updated quick start project set up order
2014-08-18 11:54:14 +01:00
Tom Christie
dce30207da Remove kickstarter links from homepage and README 2014-08-18 11:09:53 +01:00
Tom Christie
6edbabe0e1 Link to Django docs on widgets. Closes #1760. 2014-08-18 10:58:00 +01:00
Tom Christie
b9cb9929b9 Merge pull request #1761 from sshquack/minor-doc-updates
Trivial doc updates
2014-08-18 10:53:11 +01:00
Tom Christie
38a0e3e627 Sponsor update 2014-08-16 14:02:44 +01:00
sshquack
867e441ec0 Strip trailing spaces in tutorial 2014-08-15 20:45:28 -06:00
sshquack
14867705e9 Specify file names using standard format
+ Explicitly specify module names in the standard format similar to all
the other tutorials
+ Remove the extra quote around module name
2014-08-15 20:41:21 -06:00
Tom Christie
172b9c74f9 Latest sponsor update 2014-08-15 17:48:43 +01:00
Tom Christie
967798e832 Added compile to the sponsors 2014-08-15 17:39:51 +01:00
Tom Christie
4c60639595 Added Holvi 2014-08-15 16:19:13 +01:00
Tom Christie
e624871a68 Latest backer update 2014-08-15 15:46:26 +01:00
Tom Christie
a5561954d7 Latest sponsor updates 2014-08-15 15:36:49 +01:00
catherinedodge
bfd0b261db Fixed small typo 2014-08-14 13:39:21 -04:00
Tom Christie
63d5634c66 Minor sponsor correction 2014-08-14 16:59:40 +01:00
Tom Christie
bdb884aceb Latest sponsor update 2014-08-14 16:57:21 +01:00
Tom Christie
c52075f392 Latest sponsor update 2014-08-13 14:02:09 +01:00
Tom Christie
5d674927b8 Minor docs style change 2014-08-12 14:59:17 +01:00
Tom Christie
c716f35825 Added Cantemo 2014-08-12 14:57:27 +01:00
Tom Christie
7551db23ca Added Rob Spectre 2014-08-12 13:47:34 +01:00
Tom Christie
f46b55b75f Added OpenEye as a silver sponsor 2014-08-12 13:44: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
Kevin London
bc03d2b553 Updated links to Bootstrap components
The previous links landed on the the main page and no longer directly linked to specific areas.
2014-08-07 16:32:40 -07:00
Rob Terhaar
3217842346 minor doc fix, @api_view() needs an iterable 2014-08-06 18:55:08 -04:00
nimiq
62d0d4e5d2 Fix style for some text 2014-08-06 12:45:58 +02:00
Tom Christie
83597a4b0f Latest sponsor update 2014-08-05 15:31:39 +01:00
Tom Christie
322476c386 Latest sponsor update 2014-08-04 09:20:27 +01:00
Tom Christie
7bc9954fdb Update sponsorships 2014-08-02 15:28:34 +01:00
Tom Christie
d0fdcdfdad Added pathwright 2014-08-02 15:18:03 +01:00
Tom Christie
3ac075a227 Update Nephila sponsorship 2014-08-02 15:08:14 +01:00
Tom Christie
f58dde59c4 Sponsor updated 2014-08-02 15:05:03 +01:00
Tom Christie
9af3dc0ba5 Added ProReNata AB 2014-08-01 13:54:26 +01:00
Tom Christie
5377bda942 Fix LaterPay link 2014-08-01 13:42:51 +01:00
Tom Christie
27af7a3f4f Latest sponsor updates 2014-08-01 11:36:33 +01:00
Tom Christie
f87aadb3ce Latest sponsor updates 2014-08-01 11:35:48 +01:00
Tom Christie
18f2ca4b02 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2014-07-31 22:33:59 +01:00
Tom Christie
6677374e9b Kickstarter sponsors 2014-07-31 22:33:45 +01: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
8044416523 Add platinum sponsors 2014-07-31 20:19:28 +01: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
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