Commit Graph

2007 Commits

Author SHA1 Message Date
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