Commit Graph

2260 Commits

Author SHA1 Message Date
Xavier Ordoquy
cd4c389d1f Merge pull request #3382 from outime/patch-1
Fixed typo in ScopedRateThrottle example views
2015-09-10 10:16:29 +02:00
Xavier Ordoquy
b6b33b567e Merge pull request #3360 from lubomir/improve-docs-for-default
Improve documentation of default argument for fields
2015-09-10 10:15:17 +02:00
Rubén Díaz
671de792e2 Fixed typo in ScopedRateThrottle example views 2015-09-10 10:19:40 +03:00
potpath
bb95de13bf Update 6-viewsets-and-routers.md 2015-09-04 16:07:20 +07:00
Tom Christie
7905e9f9f4 Docs tweak 2015-09-03 11:57:11 +01:00
Lubomír Sedlář
a57ad07674 Add link to validators
The `set_context` method there is the same as for the default field.
2015-09-03 10:35:28 +02:00
Lubomír Sedlář
1c049edd8c Improve documentation of default argument for fields
The documentation now not only mentions that callables are acceptable
arguments, it also tells the reader what the callable should look like.
2015-09-03 09:46:54 +02:00
Britt Dawn
7c12a988fa Replacing self.tag with self.tag_name in Generic Relationships documentation. 2015-09-02 09:25:00 -07:00
Miroslav Shubernetskiy
6926c71699 added django-url-filter to 3rd party libraries 2015-08-31 21:23:11 -04:00
José Padilla
9dd1b2516b Update ModelSerializer fields docs 2015-08-28 09:51:11 -04:00
koliber
dae5426e20 Changed formatting and updated docs 2015-08-28 15:35:32 +02:00
Tom Christie
3a0d54c7fb Fix testing example. Closes #3346 2015-08-28 13:52:18 +01:00
José Padilla
1fe8e9a0bf Add note on deprecation path 2015-08-28 08:11:07 -04:00
José Padilla
f3ef13ab59 Update to match docs on ModelForm fields 2015-08-28 08:05:20 -04:00
Tom Christie
9aca6442a7 Add to the roadmap 2015-08-27 15:31:21 +01:00
Tom Christie
f646b469d4 Copy tweaks 2015-08-26 13:22:18 +01:00
Tom Christie
eb37f90dcd Tweak buisiness case 2015-08-26 13:09:22 +01:00
Tom Christie
32946f4160 Tweaks to roadmap 2015-08-25 14:03:30 +01:00
Slava Shklyaev
49d799c454 Fix typo 2015-08-24 21:09:08 +03:00
Tom Christie
0198bce34f Release 3.2.3 2015-08-24 10:59:52 +01:00
borzdyko
f0782b9451 Doc for regex search filter 2015-08-21 18:26:23 +03:00
Tom Christie
f4412d0827 Docs for select cutoffs 2015-08-21 10:52:44 +01:00
Tom Christie
1de197aa8d Tweaks for funding page 2015-08-20 10:10:06 +01:00
Joe Simpson
a4af8cc623 Add import to example for filtering
`from rest_framework import filters` was missing from one of the examples
2015-08-19 14:44:40 +01:00
Tom Christie
c958d5d447 Redirect from www. to fund. when needed. 2015-08-19 12:35:23 +01:00
Tom Christie
0dc9f285be Paid plans title -> Funding 2015-08-19 12:16:00 +01:00
koliber
2946251c91 Added explicit id field in multi update example
If the id field is implicitly created, it is created as `read_only=True`. This causes the data validation step to remove the id values in the validated data.
2015-08-18 14:47:04 +02:00
Tom Christie
b722b3b77a Note on bus factor 2015-08-14 13:08:54 +01:00
Tom Christie
71505e675a Flesh out the funding docs 2015-08-14 12:34:47 +01:00
Tom Christie
a0602104c3 Link to correct plans in sign up 2015-08-13 17:14:19 +01:00
Tom Christie
d80acd1f1f Initial draft of funding page 2015-08-13 14:17:27 +01:00
Tom Christie
1b53e804ee 3.2.2 Release 2015-08-13 10:23:22 +01:00
ThaJay
76fedcc348 Update 2-requests-and-responses.md
just a small error, the trailing slash in the url should be omitted when adding a .suffix
2015-08-12 19:49:43 +02:00
Tom Christie
0df99a6c95 Fix erronous request.files docs, and incorrect request.FILES behavior. Closes #3261. 2015-08-11 16:21:02 +01:00
Tom Christie
e0c93c1780 Tweaking display_value docs 2015-08-10 16:37:55 +01:00
James Beith
eaf61449a8 Explain use case for display_value in docs 2015-08-10 13:02:07 +01:00
James Beith
66ae19229e Add docs for display_value 2015-08-10 12:38:27 +01:00
Tom Christie
3ea394dbff Version 3.2.1 2015-08-07 14:55:18 +01:00
Tom Christie
e88f28dbad Call out supported versions. Closes #3232. 2015-08-07 14:47:00 +01:00
Tymur Maryokhin
85e3edd7ff Update README and docs with 3.2 release 2015-08-07 12:12:01 +02:00
Simon Charette
bcc0d54f98 Fixed a small typo in the 3.2 release announcement. 2015-08-06 16:56:39 -04:00
Tom Christie
e3aaa323b7 Add 3.2 announcement 2015-08-06 14:18:23 +01:00
Tom Christie
a428d76ada Add 3.2 release notes 2015-08-06 13:18:18 +01:00
Tom Christie
9a778793f8 Adding imports to docs 2015-08-06 09:56:09 +01:00
wwj718
c099d9aac4 import permission_classes
many people don't know how to import permission_classes
2015-08-06 11:08:56 +08:00
Tom Christie
8d7c0a8474 Merge branch 'feature/filepathfield' of https://github.com/Ins1ne/django-rest-framework into Ins1ne-feature/filepathfield 2015-08-03 10:09:46 +01:00
Tom Christie
472784b70a Docs for custom hyperlinked fields. 2015-08-03 09:27:03 +01:00
Ian Foote
ed55fbe862 Fix custom HyperlinkedRelatedField example
Fix `get_object` method signature to match [`HyperlinkedRelatedField.get_object`](https://github.com/tomchristie/django-rest-framework/blob/master/rest_framework/relations.py#L227-L236).
2015-07-31 12:59:50 +01:00
Tom Christie
aa3f844b3d Merge pull request #3199 from tomchristie/remove-url-from-future
Remove 'load url from future' tags in templates.
2015-07-30 16:29:11 +01:00
David Kaplan
8d7627a079 Update third-party-resources.md
Add DRY Rest Framework reference onto the third party resources page.
2015-07-30 10:51:44 -04:00
David Kaplan
b969e9a872 Update permissions.md
Add DRY Rest Permissions info to the permissions page
2015-07-30 10:47:12 -04:00
Tom Christie
c8ad0cce19 Bump minimum Django version to 1.5 2015-07-30 15:43:39 +01:00
Tom Christie
1f55bc747b Merge pull request #2926 from tomchristie/admin-style
Admin style renderer
2015-07-30 15:01:37 +01:00
Tom Christie
a4e0f03050 Tweak quickstart to show newest users first in list view 2015-07-30 14:18:09 +01:00
Tom Christie
5c1d6a9200 Docs for AdminRenderer 2015-07-30 14:07:51 +01:00
Tom Christie
75beb6ab2d Note on ValidationError in perform_create. Closes #2791. 2015-07-27 13:32:30 +01:00
Tom Christie
99d9afc9d0 Remove out-of-date note on footer block in browsable API template. Closes #3187. 2015-07-27 09:18:41 +01:00
José Padilla
4f0220b780 Add missing link 2015-07-26 20:00:34 -04:00
Adrian Mester
d9c934debd fixed a typo in docs 2015-07-23 13:10:20 +03:00
Tom Christie
762a30dbda Merge branch 'master' of github.com:tomchristie/django-rest-framework 2015-07-22 12:36:43 +01:00
Tom Christie
f9c61e8090 Prominent notes on deprecation status of pagination settings. Closes #3173. 2015-07-22 12:36:32 +01:00
José Padilla
7f7e6b33ff Update quickstart.md
Closes #3171
2015-07-19 21:47:09 -04:00
Aider Ibragimov
d845157983 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework into feature/filepathfield 2015-07-18 23:34:07 +03:00
Tom Christie
0ccb148183 Support QueryDict list arguments with ListField. Closes #3155. 2015-07-16 15:59:15 +01:00
Tom Christie
c940f15901 Internal use warning against HTMLFormRenderer. Closes #2773. 2015-07-16 15:50:51 +01:00
Leonardo Giordani
4f6eba3ce8 Removed import of unused django.forms.widgets 2015-07-16 16:25:01 +02:00
Tom Christie
0ea64f6b33 More docs on configuring a custom metadata class. 2015-07-16 10:19:27 +01:00
Tom Christie
8d306823b4 Update docs on ALLOWED_VERSIONS and DEFAULT_VERSION. Closes #2778. 2015-07-14 15:03:33 +01:00
Tom Christie
3c57e08f62 Clarifications to read_only fields. Closes #3064. 2015-07-14 12:22:51 +01:00
Tom Christie
586c3350d4 Writable Nested Serializer example in relationships docs. Closes #2924. 2015-07-14 12:10:40 +01:00
Alexander Pitkin
6d4ae2c40f Fixed type in docs
Fixed typo in Miscellaneous notes of 3.0 release announcement docs
2015-07-13 16:46:14 +03:00
Derek Pauley
387dfd5dc3 Update rest-hypermedia-hateoas.md
There was a typo under ## What REST framework doesn't provide. 

Original: What REST framework doesn't do is give you is machine readable hypermedia formats such as [HAL][hal],

Fixed: What REST framework doesn't do is give you machine readable hypermedia formats such as [HAL][hal],
2015-07-11 13:23:57 -05:00
Yuri Hernani Heupa
c04c8808c6 Changed typo in Renderer docs
The BrowsableAPIRenderer was misspelled with an extra 'e' letter
2015-07-09 22:41:53 -03:00
Miroslav Shubernetskiy
3bb9e251d7 added django-rest-framework-braces in Misc list of 3rd party tools 2015-07-06 17:35:21 -04:00
José Padilla
f161241e07 Fix custom parser example 2015-07-05 16:48:33 -04:00
Matt Broach
b9e09e2f90 Added django-rest-multiple-models link to general Third Party resources page as well 2015-07-02 18:18:30 -04:00
Matt Broach
9e58bf6500 added link to Django Rest Multiple Models to Third Party Packages 2015-07-02 17:20:41 -04:00
Mark Skipper
b743818430 Remove unused import from docs example 2015-07-01 20:39:05 +01:00
Xavier Ordoquy
b6e46a6483 Update get_serializer signature
- remove the `files` and `allow_add_remove` arguments that were part of the 2.x API.
2015-07-01 00:26:54 +02:00
Alasdair Nicol
061cc5a42b Fixed #2900 -- Made example validator class in docs inherit from object 2015-06-30 16:33:01 +01:00
Tom Christie
632fc98f77 Fix link headers in examples, as per RFC5988. 2015-06-24 12:57:23 +01:00
Tom Christie
8329411cc3 Merge pull request #2539 from donewell/permission-detail
add message to custom permission
2015-06-24 11:32:02 +01:00
Tom Christie
e4b0273f76 Merge pull request #3063 from jpadilla/url-format-override
Document setting URL_FORMAT_OVERRIDE to None
2015-06-23 13:04:48 +01:00
José Padilla
83ef64dbf5 Document setting URL_FORMAT_OVERRIDE to None
This also hides the format dropdown from the
Browsable API if URL_FORMAT_OVERRIDE is disabled.

Closes #3057
2015-06-23 07:50:44 -04:00
José Padilla
9bdf9a510e Remove Twitter button for mobile rendering 2015-06-23 07:17:12 -04:00
José Padilla
8554980c86 Add PyPI version badge to docs. Closes #3023 2015-06-23 06:22:35 -04:00
Xavier Ordoquy
8c5fc2a94b Merge pull request #2732 from pquentin/patch-versioning
Document per-view versioning settings
2015-06-19 12:56:24 +02:00
Alexandre Cordeiro
deb2c9eb87 Fixed minor typo on viewsets.md
I'm not sure how the contribution policy for the docs is, but I thought it'd be faster to issue a pull request than reaching out to you guys/creating an issue for something so simple. Hope it's not a problem :)
2015-06-16 17:36:11 -03:00
José Padilla
0be6d87fac Fix versioning urls 2015-06-15 16:51:37 -04:00
Xavier Ordoquy
be9327ad3a Merge pull request #3025 from linovia/documentation
Replace the former `get_filter_backends` by `filter_queryset`.
2015-06-15 22:28:41 +02:00
Thomas Stephenson
a1e0bae9da Custom serialization of PrimaryKeyRelatedField values
Adds a 'pk_field' parameter which can be used to proxy serialization and
deserialization of arbitrary primary key values.
2015-06-15 04:43:49 +10:00
Xavier Ordoquy
c80796ec04 Mention filter_queryset as an alternative to former get_filter_backends 2015-06-10 23:32:52 +02:00
Nico Mandery
325789db95 set the filter_backends class variable in the DjangoFilterBackend documentation for clearness 2015-06-08 15:18:30 +02:00
malinich
4a2bad03c5 outdated method 'get_filter_backends' has been deleted from the documentation 2015-06-05 15:40:13 +03:00
Jared Petersen
2b2fbbd299 Update browsable-api.md
The Bootstrap Customizer has been discontinued and is no longer available (http://getbootstrap.com/2.3.2/customize.html), so I removed the reference to it in the page.
2015-06-04 21:28:21 -07:00
Xavier Ordoquy
8935db1be9 Merge pull request #3003 from linovia/release/3.1.3
Release 3.1.3
2015-06-04 15:04:55 +01:00
Xavier Ordoquy
886220cb70 Last minute pull request 2015-06-04 14:56:00 +01:00
Xavier Ordoquy
757e45acee Adding the last minute PR. 2015-06-04 14:37:01 +01:00
Xavier Ordoquy
dee5fb5647 Merge remote-tracking branch 'reference/master' into feature/ipaddress-fix
Conflicts:
	docs/api-guide/fields.md
2015-06-04 14:21:33 +01:00
Xavier Ordoquy
bc778732bf Release notes for 3.1.3 2015-06-03 17:27:38 +01:00
Xavier Ordoquy
0c66c7cfa6 Merge pull request #3000 from linovia/ovangle/uuid_format2
Add 'format' argument to UUIDField
2015-06-03 12:32:23 +01:00
Xavier Ordoquy
ea00fc7a85 Fix the UUID examples style. 2015-06-02 16:10:14 +01:00
Xavier Ordoquy
a61f865518 Add format examples. 2015-06-02 14:18:26 +01:00
Xavier Ordoquy
c82f6aa835 Merge remote-tracking branch 'origin/master' into documentation/include_translations_in_process 2015-06-02 13:49:24 +01:00
Xavier Ordoquy
e8e1908097 Remove the checked box and add a todo list during development cycle. 2015-06-02 13:01:17 +01:00
Xavier Ordoquy
6c1a285c83 Add the translations to the process. 2015-06-02 10:17:19 +01:00
Tom Christie
7f6fb3183f Merge pull request #2994 from linovia/documentation/add_warning_about_login
Add a warning about totally custom login views.
2015-06-02 09:51:08 +01:00
Nicolas Delaby
3f3a01b4b8 fix Typo 2015-06-02 09:18:24 +02:00
Xavier Ordoquy
4ad8c17371 Add a warning about totally custom login views. 2015-06-01 18:13:40 +01:00
Nicolas Delaby
f701ecceb7 Add DurationField 2015-06-01 18:20:53 +02:00
Marc
9d624d5b6b Update validators.md
Missing colon.
2015-05-29 16:57:13 +02:00
Arnaud Limbourg
5550f1534c removing section since package is not maintained 2015-05-28 15:52:37 +02:00
Arnaud Limbourg
2bfef08d3a THe DRF Any Permission is not maintained anymore 2015-05-28 15:12:18 +02:00
Anna Schneider
6553e253f3 Add drf-tracking to third-party-resources.md 2015-05-26 16:58:08 -07:00
Martin Di Palma
7449e29cf7 Links issues
The following items had a wrong href value:

- Dont require pk strictly for related fields. (#2745, #2754)
- Restrict integer field to integers and strings. (#2835, #2836)
2015-05-25 02:24:11 -03:00
André Ericson
e6e5a27836 Add Classy Django REST Framework(cdrf.co) to Third Party Resources 2015-05-22 17:18:59 -03:00
Xavier Ordoquy
6add1acc4e Add a few cosmetic changes to the release notes. 2015-05-14 11:18:18 +02:00
Xavier Ordoquy
475e431055 Fix the broken links. 2015-05-14 11:15:26 +02:00
Xavier Ordoquy
1a8c0b4bfc Merge pull request #2930 from linovia/release/3.1.2
Release 3.1.2
2015-05-14 10:57:33 +02:00
Xavier Ordoquy
47d36f150b Add last minute PR. 2015-05-13 18:24:06 +02:00
Tom Christie
ea1145c5aa Merge pull request #2905 from ticosax/django-object-perm-get_queryset
Allow DjangoObjectPermissions to use views that define get_queryset
2015-05-13 13:39:59 +01:00
Nicolas Delaby
031ac2a292 Allow DjangoObjectPermissions to use views that define get_queryset 2015-05-13 14:26:44 +02:00
Xavier Ordoquy
5c8df2c56b Release notes for 3.1.2 2015-05-13 09:44:04 +02:00
Don Kirkby
0b8dd906cf minor grammar fix 2015-05-08 15:28:30 -07:00
Jonathan Ellenberger
44317b4581 Adding django-versatileimagefield to DRF 3rd party docs
Closes WGBH/django-versatileimagefield#12
2015-05-07 14:23:24 -04:00
José Padilla
3a96164501 Merge pull request #2914 from trollknurr/master
Added link to djangorestframework-word-filter package
2015-05-06 12:11:04 -04:00
tony
b0b26d6b68 Added link to djangorestframework-word-filter package 2015-05-06 13:40:01 +03:00
S. Andrew Sheppard
e9b6b47872 update info about wq.db.rest router 2015-05-05 13:38:14 -05:00
Tom Christie
2e85b4ec3c Merge pull request #2890 from radyz/fixed-doc-for-get-paginated-response-method
Document correct method usage for get_paginated_response
2015-05-05 09:15:28 +01:00
lowid
5c3c4802d3 Delete imported but not used method
In 'Generating Tokens' section, the example code imported get_user_model but not used.
2015-05-04 18:15:49 +08:00
Ernesto Chavez Sanchez
2b4dd739cc Fixed description for get_paginated_response method in generic-views and example using it with @list_route decorator in viewsets. 2015-05-03 22:00:05 +00:00
Tymur Maryokhin
d19c3cc973 Remove deprecated model attribute reference. Closes #2896. 2015-05-01 20:32:52 +02:00
Ernesto Chavez Sanchez
0ffb0abe81 Document correct method usage for get_paginated_response in 3.x instead
of old get_pagination_serializer only valid in 2.x
2015-04-30 02:23:39 +00:00
José Padilla
2b6726e703 Merge pull request #2842 from frnc/patch-1
Update 5-relationships-and-hyperlinked-apis.md
2015-04-26 12:13:57 -04:00
Valentin Hăloiu
e148637d6d Frontpage example no longer uses model attribute 2015-04-23 04:44:10 +03:00
zmmachar
237c2ebc26 Update renderers.md
jsonp renderer not in the yaml package
2015-04-21 18:09:55 -07:00
Cody Scott
cbf17a5ffe Specifying module for CurrentUserDefault()
Prevents having to lookup the import
2015-04-20 19:14:58 -04:00
frnc
601cbf18d4 Update 5-relationships-and-hyperlinked-apis.md
Following  [@jpadilla](https://github.com/jpadilla)'s suggestion in issue [#2837](https://github.com/tomchristie/django-rest-framework/issues/2837), I am proposing a little addition in "Creating an endpoint for the root of our API" section in order to make it clear that the `user-list` and `snippet-list` names will be declared later in `snippets/urls.py`. Missing this clarification might lead a beginner (like me) to think that the names are somehow assigned by rest_framework under the hood and to try the code too early, getting stuck in the following errors.
2015-04-20 17:56:04 +02:00
Teddy Wing
0f5082d9b8 docs/renderers: StaticHTMLRenderer instead of TemplateHTMLRenderer
The `StaticHTMLRenderer` section referred to `TemplateHTMLRenderer`
instead of `StaticHTMLRenderer`.
2015-04-16 15:47:53 -04:00
José Padilla
3abbeadfaf Django 1.8 is no longer in beta 2015-04-14 11:32:15 -04:00
Thomas Stephenson
236b731072 Add 'format' argument to UUIDField
To allow serializations to control the representation format of a
UUID value
2015-04-12 22:07:25 +10:00
Rob Hudson
e6308155dd Update example of nested data 2015-04-08 21:38:02 -07:00
Paweł Stiasny
22e8357a4b Update serializers documentation (removed feature)
It seems that allow_add_remove was removed from 3.x, yet the docs still mention it. Updating to avoid confusion.
2015-04-08 13:53:49 +02:00
Brett Koonce
d8a19f79ab more sp fixes 2015-04-07 22:06:25 -07:00
Oleg Marshev
b0dd1fffbf Fix typo. 2015-04-07 19:40:23 +03:00
José Padilla
6333e48188 Merge pull request #2753 from johnjohndoe/patch-1
Fix typo.
2015-04-03 17:30:52 -04:00
Tom Christie
5cf8230ba1 Merge pull request #2777 from jpadilla/docs-query-params
`query_params` in favor of `QUERY_PARAMS`
2015-04-01 09:24:38 -04:00
Alex Tsai
fbd8c18abd Should use "ordering" in model Meta, not order_by 2015-03-31 17:30:04 -07:00
José Padilla
911da8a2b9 query_params in favor of QUERY_PARAMS 2015-03-29 17:04:23 -04:00
Christoffer
6cb6b02811 Reference typos in fields.md 2015-03-26 15:51:48 +01:00
José Padilla
197027c87b Fix older release notes link
Closes #2756
2015-03-23 12:15:27 -04:00
Tom Christie
98809d12c9 Typo 2015-03-23 11:45:19 +00:00
Tom Christie
bbaee714fb Fix release date 2015-03-23 11:38:17 +00:00
Tom Christie
35a0cbb911 Add 3.1.x series header 2015-03-23 11:37:12 +00:00
Tom Christie
dbb6943298 Update release notes 2015-03-23 11:24:29 +00:00
Tom Christie
e73ddddc3a Merge pull request #2726 from linovia/release/3.1.1
Release notes for 3.1.1 and version bump.
2015-03-23 11:20:23 +00:00
Tobias Preuss
49c04d7218 Fix typo. 2015-03-23 11:20:08 +01:00
Quentin Pradet
a5506610ad Put the needed import in one example 2015-03-20 15:17:49 +01:00
Quentin Pradet
8ba66e2c10 Document per-view versioning settings
That is, document the default_version, allowed_version and version_param
class variables.
2015-03-20 15:06:30 +01:00
Xavier Ordoquy
164be174ea Release notes for 3.1.1 and version bump. 2015-03-19 23:29:10 +01:00
Aaron Yong
000db8df18 Fix typo in versioning docs 2015-03-17 11:36:02 -06:00
Tom Christie
2e55d15d4d Merge pull request #2703 from kylepjohnson/master
Add necessary imports to final urls.py example
2015-03-16 15:33:00 +00:00
Kyle P. Johnson
d655a423fb Add necessary imports to final urls.py example 2015-03-16 11:17:02 -04:00
Rubén Durá Tarí
ac44bae90d Updates ducumentation DEFAULT_PAGE_SIZE left over after #2655 2015-03-16 14:53:26 +00:00
Xavier Ordoquy
a02098b855 Fix the link to the old doc (#2681). 2015-03-13 00:15:53 +01:00
Esmail
2484dbf4e1 Fix example of explicit format URL (for real).
Do what I meant to do in #2670:

The link is displayed in the tutorial as "http://example.com/api/items/4.json" but the hyperlink itself and what the example code actually works with are (in my opinion, less pretty) URLs like "http://example.com/api/items/4/.json".
2015-03-11 12:00:19 -04:00
James Rutherford
7854c939dd Fixed import statement in API docs 2015-03-11 10:44:42 +00:00
Bryan Alsdorf
69b6e26f06 Changed incorrect class name 2015-03-10 17:30:41 -05:00
Xavier Ordoquy
3e44f788b1 Fixed a typo in the documentation's link. 2015-03-09 17:28:00 +01:00
Tom Christie
e520ea0acb Merge pull request #2652 from jpadilla/master
Remove the 'docs for 3.0' banners.
2015-03-09 08:53:13 +00:00
Tom Christie
d46d860088 Merge pull request #2655 from jwbixby/patch-1
Update documentation over PAGE_SIZE
2015-03-09 08:50:29 +00:00
Deven Xie
20ba47e343 Fixed missing word in CursorPagination docs 2015-03-09 00:10:26 -04:00
jwbixby
c2cbda43b9 Update documenation over PAGE_SIZE
This replaces all locations of the old setting `DEFAULT_PAGE_SIZE` for the current setting `PAGE_SIZE`
2015-03-08 00:22:28 -05:00
José Padilla
140b94c32e Update to 3.1 release 2015-03-07 10:50:31 -04:00
José Padilla
d12de927ad Remove docs for 3.0 banners 2015-03-07 10:49:56 -04:00
José Padilla
2ddb6bfa70 Fix permissions on markdown files 2015-03-07 10:19:25 -04:00
José Padilla
d2181cc74c Fix customizing field mappings link 2015-03-06 09:41:34 -04:00
Tom Christie
7efb2fd9ed Better docs linking 2015-03-06 12:26:09 +00:00
Tom Christie
c511342047 More docs on cursor pagination 2015-03-06 11:32:03 +00:00
Tom Christie
58dfde7fcd Tweaks for cursor pagination and docs 2015-03-06 10:22:32 +00:00
Tom Christie
efb42ff7d0 Update docs 2015-03-04 16:17:30 +00:00
Tom Christie
18cc0230bf Clean up pagination attributes 2015-03-04 15:51:00 +00:00
Aider Ibragimov
c20a0250df add FilePathField, update docs 2015-03-03 14:34:06 +03:00
Aider Ibragimov
de72022f80 Merge branch 'master' of https://github.com/Ins1ne/django-rest-framework into feature/ipaddress 2015-02-28 14:29:27 +03:00
Aider Ibragimov
4d5eee04a0 add IPAddressField, update docs 2015-02-28 10:11:38 +03:00
José Padilla
700af5dab2 Merge pull request #2584 from aRkadeFR/DocFixingTypo
Documentation test fix double word
2015-02-27 12:53:10 -04:00
aRkadeFR
9c359181d7 update for that the instead of that 2015-02-27 17:38:28 +01:00
Tom Christie
dafc045c2d Merge pull request #2606 from tomchristie/1.8-beta
Formally upgrade suport to Django 1.8-beta
2015-02-26 13:49:44 +00:00
Tom Christie
8f988466a5 Docs on exception handler context. Closes #2604. 2015-02-26 13:20:26 +00:00
Tom Christie
e72428214c Formally upgrade suport to Django 1.8-beta 2015-02-26 12:53:24 +00:00
Tom Christie
03818ed004 Pagination tweaks and docs 2015-02-26 12:48:34 +00:00
Mateusz Sikora
b92d6df66a Update third-party-resources.md 2015-02-25 18:53:33 +01:00
Mateusz Sikora
e51dc1855c Update authentication.md 2015-02-25 18:51:20 +01:00
Mateusz Sikora
71619a02c5 Update third-party-resources.md 2015-02-25 17:58:54 +01:00
ludbek
f29b657798 updated outdated link at testing.md#APIClient 2015-02-21 07:52:56 +05:45
aRkadeFR
c0916c2859 Documentation test fix double word 2015-02-20 15:59:10 +01:00
Paul Hallett
d9c652813d add missing import in tests 2015-02-18 15:53:57 +00:00
Yannick PÉROUX
30e6f32f6f Fix typo in requests.md 2015-02-17 17:08:30 +01:00
Tom Christie
f1e517449a Minor docs tweak 2015-02-17 13:41:59 +00:00
Tom Christie
691ae5b646 Recommend 'pip list --outdated' instead of using pip-review 2015-02-17 13:40:59 +00:00
Tom Christie
028c477c22 Note on using pip-review in docs. 2015-02-17 12:56:19 +00:00
Tom Christie
4248a8d3fc Merge pull request #2198 from tomchristie/version-3.1
Version 3.1
2015-02-13 13:38:44 +00:00
Tymur Maryokhin
9d80335ac8 Remove '.model' shortcut from viewset docs. Refs #2486. Closes #2549. 2015-02-12 01:10:03 +01:00
Xavier Ordoquy
f6033cee87 Add release notes for 3.0.5. 2015-02-10 22:46:54 +01:00
donewell
9ea615af14 add message to custom permission
change detail to message and update text
2015-02-10 20:11:53 +00:00
Joar Leth
b18d773b51 Fix typo in 3.1 announcement 2015-02-09 22:51:49 +01:00
Tom Christie
fbb21caaaa Merge master 2015-02-09 20:43:50 +00:00
Tom Christie
407480b484 Minor docs work 2015-02-09 17:01:41 +00:00
Tom Christie
670723f021 Minor cleanups/improvements to ModelSerializer API 2015-02-06 15:45:02 +00:00
José Padilla
235b98e427 Merge pull request #2460 from mmarvick/master
Small fixes to the tutorial
2015-02-06 11:31:25 -04:00
Tom Christie
5d8c3abe72 Fix typo 2015-02-06 15:27:35 +00:00
Tom Christie
a435b1b355 Merge branch 'version-3.1' of git://github.com/jpadilla/django-rest-framework into version-3.1 2015-02-06 14:39:31 +00:00
Tom Christie
1f99612845 Upgrade pending deprecations to deprecations 2015-02-06 13:21:35 +00:00
Tom Christie
1d4956f616 Pagination images 2015-02-06 13:08:04 +00:00
Tom Christie
53716f6152 Internationalization docs 2015-02-06 11:37:29 +00:00
José Padilla
7f801b9a01 Add trim_whitespace to CharField #2517
If set to `True` then leading and trailing
whitespace is trimmed. Defaults to `True`.
2015-02-06 01:09:19 -04:00
Michael Marvick
5bf803b6ed Revert some of the changes made in 1-serialization.md 2015-02-05 19:42:36 -08:00
Tom Christie
09488ad4da Link to ModelSerializer API 2015-02-06 00:25:03 +00:00
Tom Christie
6c63ef13cd Drop 2.x announcements 2015-02-06 00:04:20 +00:00
Tom Christie
41b213414d Updating release notes 2015-02-04 23:32:25 +00:00
Xavier Ordoquy
46181341d5 Merge pull request #2512 from heywbj/docs
Add django-rest-framework-recursive to docs
2015-02-04 00:13:52 +01:00
Warren Jin
76efbdddb6 docs 2015-02-03 17:18:54 -05:00
James Cooke
f676569661 Small documentation fixes
* Remove "you you" from viewsets API-guide
* Fix link from routers API-guide to viewsets API-guide
2015-02-03 13:43:03 +00:00
Tom Christie
d015534d53 Fleshing out 3.1 announcement 2015-02-03 09:15:42 +00:00
Tom Christie
6e2ea852d0 Merge pull request #2498 from dustinfarris/update-eda-link
Update link for ember-django-adapter
2015-02-01 21:17:36 +00:00
Dustin Farris
2111a99b32 Update link for ember-django-adapter 2015-02-01 16:00:24 -05:00
José Padilla
9437d9b8ee Fix base_template name in example 2015-02-01 16:18:40 -04:00
José Padilla
aaa1fcd5d1 Fixes #2493 2015-02-01 16:18:02 -04:00
Tom Christie
2cc4cb2465 Fix error text in test. 2015-01-31 08:53:40 +00:00
Tom Christie
0d96cf2ca2 Latest translation source messages. 2015-01-30 16:27:49 +00:00
Tom Christie
4ee4b4f2dc Merge master 2015-01-30 14:00:25 +00:00
Tom Christie
7cf9dea7f9 Docs typo. Closes #2491. 2015-01-30 11:00:29 +00:00
Tymur Maryokhin
e720927b78 Removed deprecated '.model' docs 2015-01-29 17:28:18 +01:00
mareknaskret
4a2a36ef82 Update filtering.md
Updated links for django-guardian package.
2015-01-28 15:17:56 +01:00
Xavier Ordoquy
0daf160946 Fix #2476 2015-01-28 00:06:34 +01:00
Xavier Ordoquy
925ea4bdc6 Release notes for 3.0.4 2015-01-27 19:43:38 +01:00
Tom Christie
fc70c0862f Galileo Press -> Rheinwerk Verlag 2015-01-26 14:07:21 +00:00
Michael Marvick
73bd0d539f tutorial #5 incorrectly referenced 'settings.py' instead of 'tutorial/settings.py' 2015-01-25 23:47:01 -08:00
Michael Marvick
2a6937f381 tutorial #2 incorrectly showed /item.json instead of /item/.json for format suffixes 2015-01-25 23:46:27 -08:00
Michael Marvick
90c9968a70 tutorial #1 incorrectly showed string of json instead of ReturnDict type from 'serializer.data', and also has a third item in the second usage 2015-01-25 23:45:56 -08: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
8f6d7f4a5a Merge pull request #2451 from tomchristie/dict-field
Added DictField and support for HStoreField.
2015-01-23 16:33:37 +00:00
Tom Christie
35f6a82462 Added DictField and support for HStoreField. 2015-01-23 16:27:23 +00:00
Tom Christie
b07d931261 Merge pull request #2448 from tomchristie/uuid-field
Added UUIDField.
2015-01-23 15:43:21 +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
Carlton Gibson
790c92d438 Update Django-Filter references in docs and requirements. 2015-01-23 15:22:20 +01: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
Eric Theise
b0bc79ed4d correcting "it's" to "its" in Tutorial 1 2015-01-19 14:49:36 -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
Tom Christie
564f845e21 Lower header font weights for nicer docs style 2015-01-13 12:21:03 +00:00
Tom Christie
8e2dc6b26d Update internationalization docs 2015-01-13 12:07:25 +00:00
Tom Christie
2b28026fc1 Translation info -> project management 2015-01-13 10:44:40 +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
605c1fa0a8 Merge pull request #2397 from travelton/TweakTutorialDocs
Tweaked a few issues in the tutorial documentation.
2015-01-10 14:07:13 +00:00
Travis Swientek
8ccf5bcc0b Tweaked a few issues in the tutorial documentation. 2015-01-09 11:36:21 -08:00
Tom Christie
11efde8905 Merge pull request #2373 from jakul/document-translations-3.1
Document how to translate DRF error messages (version 3.1)
2015-01-09 11:57:02 +00:00
Xavier Ordoquy
ef16c546d7 Update the release note with latest fixes.
Add the link to the 3.0.3 milestone.
2015-01-08 23:29:51 +01:00
Xavier Ordoquy
02ee3871ae Merge remote-tracking branch 'origin/master' into release/3.0.3 2015-01-08 23:24:19 +01:00
Tom Christie
42c913334b Minimum 1.6.x version is 1.6.3 2015-01-08 14:51:08 +00:00
Tom Christie
f529f83d3c Minimum Django 1.5 version issue 1.5.6 2015-01-08 14:38:23 +00: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
Tom Christie
18cefad3ab Update project-management.md 2015-01-07 21:03:50 +00:00
Tom Christie
1102e22cb4 Update project-management.md 2015-01-07 21:02:42 +00:00
Xavier Ordoquy
42f1932b52 Release notes for 3.0.3 2015-01-07 19:10:22 +01:00
Craig Blaszczyk
7913947757 add config and documentation about uploading/downloading translations from Transifex 2015-01-07 11:13:03 +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
d3b2302588 Minor docs update. Refs #2375. 2015-01-05 16:31:52 +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
Craig Blaszczyk
9f169acb62 capitalise Django 2015-01-02 11:08:45 +00:00
Craig Blaszczyk
0b8a83bd62 update internationalisation instructions to prevent symlinking; add base .po file 2015-01-02 11:08:04 +00:00
Craig Blaszczyk
2781903a5a Add info about how django chooses which language to use 2015-01-02 11:07:58 +00:00
Craig Blaszczyk
7ad7dd6a42 match DRF style guide 2015-01-02 11:07:49 +00:00
Craig Blaszczyk
309b5d2641 instructions on how to translate REST framework error messages 2015-01-02 11:07:35 +00:00
Rob Terhaar
336faf5a86 fix widget style formatting 2015-01-01 21:01:16 -05:00
Tom Christie
5d8c45681a Update copryright for 2015. Closes #2247. 2014-12-28 18:48:42 +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
Tom Christie
00531ec937 Release notes on non-text detail arguments. Closes #2341. 2014-12-26 15:48:16 +00: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
8f0fef4b75 Updated documentation on url_path per suggestions. 2014-12-19 21:22:10 +05:30
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
tanwanirahul
a8a3fedb5c Add url_path documention for detail_route decorator 2014-12-19 20:16:46 +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
9c9d5bd859 Added project management docs. 2014-12-18 13:35:42 +00:00
Tom Christie
c8d88c8c8a Merge branch 'master' into version-3.1 2014-12-18 11:21:25 +00:00
Brent O'Connor
7e9aac98fe The pre_save method no longer works. This resolved issue #2306 2014-12-17 16:54:04 -06:00
Tom Christie
c87e95c239 Add missing date 2014-12-17 21:11:06 +00:00
Tom Christie
15c2001de0 Merge pull request #2297 from tomchristie/version-3.0.2
Version 3.0.2
2014-12-17 21:04:08 +00:00
Brent O'Connor
4f33cfe1a0 With httpie 0.8.0 the HTTP method has to come after the auth argument. 2014-12-17 14:38:01 -06:00
Tymur Maryokhin
eeb6e34064 Docs/tutorial import fixes. Refs #2296 2014-12-17 17:28:11 +01:00
Tom Christie
418108632c Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2014-12-17 16:23:20 +00:00
Tom Christie
90b8f9221e Use six.BytesIO in tutorial. Closes #2296. 2014-12-17 16:23:00 +00:00
Tom Christie
5f933f575e Merge pull request #2298 from epicserve/fix_typo
Fixed a typo
2014-12-17 16:20:22 +00:00
Brent O'Connor
530f7a21b3 Fixed a typo 2014-12-17 10:19:15 -06: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
2adfb6c3aa Cleanup extra newline 2014-12-17 16:00:49 +00:00
Tom Christie
bbd55fafc5 Version 3.0.2 2014-12-17 15:58:30 +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
ffc099a256 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework 2014-12-17 15:22:40 +00:00
Tom Christie
1ba822010d Highlight trailing '.' in command so it wont be missed. 2014-12-17 15:22:27 +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
Jason Spafford
b951c74df2 Made docs consistent 2014-12-15 01:24:12 -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
73a80564e2 Merge pull request #2251 from linovia/version/3.0.1
Release notes & version 3.0.1
2014-12-11 15:08:07 +00:00
Xavier Ordoquy
9c37174768 Fix the ghost backtick. 2014-12-11 15:58:02 +01:00
Xavier Ordoquy
3a69182cc9 Better link representation for the issues. 2014-12-11 15:32:52 +01:00
Xavier Ordoquy
75acdc93bc Fix the milestone link again. 2014-12-11 15:13:15 +01:00
Xavier Ordoquy
99423defd8 Add full stop to the release note items.
Add link to the issues
Fix the milestone link
2014-12-11 15:11:37 +01:00
Xavier Ordoquy
9a7b0755eb Add links to the issue id. 2014-12-11 15:06:10 +01:00
Xavier Ordoquy
ab801bb01f Release note corrections 2014-12-11 14:57:26 +01:00
Tom Christie
9b88b5db69 Field->ReadOnlyField in tutorial docs 2014-12-11 09:54:55 +00:00
Xavier Ordoquy
0188ca7306 Release notes for 3.0.1 2014-12-11 00:02:13 +01:00
Tom Christie
8ad0b83148 Minor docs tweaks 2014-12-10 14:29:21 +00:00
Tom Christie
01bb85e80a Merge pull request #2246 from d0ugal/mkdocs-theme
Syntax highlighting
2014-12-10 14:22:00 +00:00
Dougal Matthews
5fe5a93644 Move remaining sponsor 2014-12-10 14:09:47 +00:00