Commit Graph

2390 Commits

Author SHA1 Message Date
Taranjeet
a609e4e1ca Docs: Fix repetitive word in the tutorial 2016-02-27 00:28:15 +01:00
Luke Murphy
c03c6c6e78 fix typo in relations docs 2016-02-27 00:27:41 +01:00
Tom Christie
a15e46af88 Merge pull request #3965 from ildoc/master
updated tutorial for django 1.9
2016-02-25 21:37:27 +00:00
Taranjeet
3fd6db1445 Docs: Fix repetitive word in the tutorial 2016-02-26 00:02:45 +05:30
ildoc
35036aee15 updated tutorial for django 1.9 2016-02-25 14:27:57 +01:00
Luke Murphy
f3c5802872 fix typo in relations docs 2016-02-24 14:22:24 +01:00
José Padilla
0b6f53eb98 Merge pull request #3943 from erickwilder/3937-accept-callable-as-initial-value
Closes #3937. Support callable as the value of `initial` for any `serializer.Field`
2016-02-19 10:41:23 -04:00
Erick Wilder
a32baeab0c Use datetime example for the Field.initial attribute
Just like regular Django fields, the example adopted uses a `datetiume.date.today` to
illustrate the functionality.
2016-02-19 09:53:50 +01:00
meoooh
5cda3a04dd fix typo
fix typo
2016-02-18 14:43:41 +09:00
José Padilla
bec5f3db83 Merge pull request #3941 from wesgt/master
fix typo
2016-02-17 07:11:36 -04:00
Erick Wilder
908efd6656 #3937 Update docs for the Field.initial attribute.
Add an usage example on how to pass a callable to the `Field.initial` in the docs.
2016-02-17 11:01:09 +01:00
Wes
b773f03bd0 fix typo 2016-02-17 16:35:53 +08:00
Kin
96644bd6c1 fix typo 2016-02-16 23:08:45 -08:00
Carlton Gibson
20d1fdba69 Fix None UUID ForeignKey serialization 2016-02-16 09:29:48 +01:00
Carlton Gibson
296c567645 Drop EOL Django 1.7 2016-02-15 16:07:42 +01:00
Xavier Ordoquy
c8ca3a1c05 Release notes for 3.3.3 2016-02-11 07:14:45 +01:00
Christian Berendt
ff4d7c7e07 Use 'password123' as password for new users in the tutorial
Trying to create a new user on Django 1.9.x with the password 'password'
will fail with the error message 'This password is too common.'. Because
of that it is necessary to change the used password from 'password' to
'password123'.
2016-02-04 07:26:15 +01:00
Chirag Khatri
62551bc80f typo in tutorial part 1 2016-02-03 15:25:31 +05:30
Xavier Ordoquy
d738ad7ae6 Update to serialization results (closes #3881). 2016-01-27 22:23:20 +01:00
James Beith
34901a5ffa Fix syntax errors in docs example
- Add missing comma in kwargs
- Remove spaces around keyword / parameter equals
- Replace incorrect curly brace with parenthesis
2016-01-24 13:33:18 +00:00
Emmanouil Konstantinidis
ee2861887e Mention DRF Docs - Live API Endpoints 2016-01-23 23:08:19 +00:00
José Padilla
99a61d72a7 Fix broken link format 2016-01-20 14:04:04 -04:00
Xavier Ordoquy
f1b28b4d63 Merge pull request #3605 from ryanhiebert/slug-related-field-queryset
RelatedField get_queryset and context
2016-01-20 18:17:29 +01:00
Krzysztof Szularz
2d40be5bd8 Update link to Heroku guidelines
They seem to have changed the structure of the document.
2016-01-20 16:28:30 +01:00
Xavier Ordoquy
221d6979c6 Fix the request data source. 2016-01-18 18:54:00 +01:00
Xavier Ordoquy
0051492963 Merge remote-tracking branch 'shvechikov/master' into feature/3776 2016-01-18 18:51:53 +01:00
Xavier Ordoquy
6f8e0c3c07 Merge pull request #3289 from koliber/update-docs-serilaizers-multi-update
Added explicit id field in multi update example
2016-01-18 18:44:03 +01:00
Ramon Moraes
a37a8748cc Update permissions.md
Adding additional note about the behavior of set permission classes per view as suggest on #3834
2016-01-15 11:44:25 -03:00
Nicolas Delaby
717e27c866 Document how to tweak authtoken.admin.TokenAdmin
With focus on large user base, but can be extended.
2016-01-14 14:59:31 +01:00
Tom Christie
1c5dfc9c8d Merge pull request #3821 from zwernberg/master
update copyright 2016
2016-01-11 16:25:11 +00:00
Zach Wernberg
04b2f021a6 update copyright 2016 2016-01-11 08:13:07 -06:00
Jerel Unruh
f71d8afdb0 Added documentation for the Third Party jsonapi.org package 2016-01-07 13:42:02 -06:00
m1kola
5fa8a31855 Typo fix in docs/api-guide/relations.md
`slug field` in code snippet was replaced to `slug_field`
2016-01-06 17:58:45 +03:00
craigglennie
2d7d3b79a0 Make code block consistent in serialization tutorial
All the other code blocks in the Serialization tutorial can be copied and pasted, but there is one that includes the >>> shell prompt characters. This commit removes those characters, and also makes the output consistent with other code blocks by making it a comment.
2016-01-02 13:15:25 -08:00
Luis San Pablo
183f8fad44 Class formatting 2015-12-31 21:18:41 -06:00
Luis San Pablo
ef491685a0 Initial fixes #3636 and fixes #3637 2015-12-31 21:14:57 -06:00
Leonid Shvechikov
ff0292a757 Fix update model example in html-and-forms.md 2015-12-27 17:14:33 +03:00
Robert Romano
c8915c0716 Change tab to spaces 2015-12-23 12:58:14 -08:00
Robert Romano
5fc938cbd1 The Internet Engineering Task Force approved the new HTTP status code 451. Adding to status.py and docs appropriately. 2015-12-23 12:54:17 -08:00
Emmanouil Konstantinidis
1925ec7d33 Both are highly recommended 2015-12-21 13:59:05 +00:00
Emmanouil Konstantinidis
4204557bc5 Remove title and hr 2015-12-21 13:55:11 +00:00
Emmanouil Konstantinidis
958290724c Rest is "REST" 2015-12-21 13:47:04 +00:00
Emmanouil Konstantinidis
a83cb1d2f3 Minor changes 2015-12-21 13:45:11 +00:00
Emmanouil Konstantinidis
1aedaafba4 Add DRF docs to the list 2015-12-21 13:40:23 +00:00
Atul Varma
66de876dee Update bootstrap version in browsable-api.md 2015-12-19 10:34:39 -05:00
Peter Baehr
44ae037e81 Move urls.py changes down and add necessary import
The previous location of editting urls.py did not allow migrations to be created and the default import needs to be modified
2015-12-15 21:17:52 -05:00
Tyrel Souza
8c0d736f23 Also fix usecases to use cases 2015-12-15 10:28:23 -05:00
Tyrel Souza
ffc10edd7e Fix minor typo on Pagination documentation 2015-12-15 10:24:49 -05:00
Xavier Ordoquy
5224feded4 Update the release date. 2015-12-14 07:32:50 +01:00
Xavier Ordoquy
bf18c9f6e3 3.3.2 release notes. 2015-12-14 07:22:30 +01:00
Xavier Ordoquy
dcaff71217 Merge pull request #3728 from karthik-suresh/Fixes-Issue3727
Import parser added to docs in API guide
2015-12-12 22:19:13 +01:00
Karthik Suresh
82973cfa32 Import parser added to docs in API guide
Added missing import statements in code snippet of API guide.

Closes-Issue: #3727
2015-12-12 21:59:08 +05:30
knbk
e203967e09 Add app_name to rest_framework.urls.
This allows users in Django 1.9+ to include the authentication urls
without specifying the namespace, as in:

    urlpatterns = [
        ...
        url(r'^auth/', include('rest_framework.urls'))
    ]
2015-12-08 02:25:00 +01:00
Kirill Zaborsky
85db6a681b Fixed versioning regexp
booking list regexp was fixed in 8b97bb8f68 but single booking wasn't for some reason, and `v1v2/bookings/123/` shouldn't be allowed here
2015-12-07 10:59:57 +03:00
Tom Christie
832d6322a7 Merge pull request #3631 from syphar/paginat
allow setting a custom Django Paginator class
2015-11-30 20:58:32 +00:00
Tom Christie
bd8098e31f Fix template typo.
Closes #3682.
Thanks for the report!
2015-11-30 17:21:41 +00:00
Nik Nyby
e3f62e230c Add missing link to django-crispy-forms 2015-11-30 10:48:56 -05:00
Prashant Tiwari
8b97bb8f68 Fix for Incorrect regex in URLPathVersioning documentation #3638 2015-11-26 06:23:59 +00:00
Xavier Ordoquy
d0352ae6fc Merge pull request #3621 from linovia/feature/how_to_turn_pagination_off
Document how to turn pagination off
2015-11-25 12:57:25 +01:00
Daniel Hahler
e786e4c4a1 doc: clarify that crispy-forms needs to be in INSTALLED_APPS 2015-11-23 15:05:38 +01:00
Xavier Ordoquy
f3de2146ea Merge pull request #3650 from silviogutierrez/master
Documentation fix for list serializers.
2015-11-19 07:46:01 +01:00
Silvio J. Gutierrez
ece7973479 Updated comment. 2015-11-18 21:52:20 -05:00
Xavier Ordoquy
edc5a79b85 Merge pull request #3497 from Ins1ne/feature/3340
update docs about detail page link for AdminRenderer
2015-11-18 17:38:07 +01:00
Silvio J. Gutierrez
f7646627f1 Documentation fix for list serializers. 2015-11-17 19:09:49 -05:00
Will Dady
ca0841576f Removing references to get_paginate_by() as it no longer exists. 2015-11-17 15:00:00 +11:00
Denis Cornehl
3806af3d15 allow setting a custom Django Paginator in pagination.PageNumberPagination 2015-11-13 16:04:12 +01:00
Xavier Ordoquy
23460bfa41 Add a note about how to turn pagination off 2015-11-10 11:33:54 +01:00
Ryan Hiebert
f2452936e9 Allow no queryset when get_queryset overridden
The user may wish to provide a dynamic queryset on a `RelatedField`
based on the `context`. The way to do that is to create a subclass of
`RelatedField` (or a child) and override the `get_queryset` method.
However, this is undocumented, and instantiating that field without a
`queryset` argument (because it's not needed) will raise an assertion
error.

Document `.get_queryset(self)` as an official part of the API of
`RelatedField`, and don't enforce the use of `queryset` when
`get_queryset` is overridden.
2015-11-05 17:34:02 -06:00
Vedran Karačić
ede15645e0 Typo 2015-11-05 11:51:29 +01:00
Tom Christie
d959c6337a Release notes 2015-11-04 14:59:09 +00:00
Tom Christie
bfdf795843 Merge pull request #3592 from tomchristie/request-parsing-when-post-accessed
Request parsing when .POST accessed
2015-11-04 14:17:55 +00:00
Ryan Hiebert
b86e5af878 reverse needs kwargs keyword
Since we aren't passing in any args, we must specify kwargs as a keyword
argument.
2015-11-03 21:45:21 -06:00
Travis J Morton
03cb959416 typo 2015-11-02 12:58:21 -08:00
David Szotten
9a14613f41 fix image paths 2015-11-02 15:28:02 +00:00
James Beith
0143586541 Adds import for Response 2015-10-29 15:48:45 +00:00
Matthew Hardwick
86e1d2a1e5 Actually add the link. 2015-10-29 10:43:57 -04:00
Matthew Hardwick
f7289e6392 Added django-rest-framework-version-transforms. 2015-10-29 10:37:46 -04:00
Josep Cugat
5b7de4f537 Fix announcement link typo 2015-10-29 10:21:46 +01:00
Tom Christie
bb555e6e5e Version 3.3.0 2015-10-28 11:32:15 +00:00
Tom Christie
144cff97fa Include billing addresses in funding sign ups 2015-10-28 11:20:35 +00:00
Tom Christie
eeff5a1709 Merge branch 'master' into funding 2015-10-23 16:27:30 +01:00
Tom Christie
b2fb0deb34 Add latest item to the release notes 2015-10-23 16:15:44 +01:00
Tom Christie
0fb1ebcfcf Remove unused import 2015-10-23 16:07:48 +01:00
Tom Christie
ff285cfe66 TODO placeholder in release announcement 2015-10-22 15:15:55 +01:00
Tom Christie
7bfc420dc9 Add release notes, drop deprecated test 2015-10-22 15:11:10 +01:00
Tom Christie
4e7cc68ec9 Link tweaks 2015-10-22 14:42:35 +01:00
Tom Christie
ae852b2be4 Tweak links 2015-10-22 14:08:19 +01:00
Tom Christie
cf33008571 Release notes etc 2015-10-22 14:05:52 +01:00
Tom Christie
c53c9eddfe Merge pull request #3315 from tomchristie/filters
First pass at HTML rendering for filters
2015-10-22 11:42:35 +01:00
Tom Christie
0c6d46729c Docs on the filter HTML interface 2015-10-22 11:37:27 +01:00
Tom Christie
6305ae8916 Merge pull request #3475 from tomchristie/forms-api
Forms API
2015-10-22 09:59:57 +01:00
Peter Demin
423e0de358 Fixed grammar in docs for "Writable nested serializers" 2015-10-21 09:33:34 -04:00
potpath
9634cea474 Fix broken link caused by case sensitivity 2015-10-21 18:43:07 +07:00
Tom Christie
0d1637d666 Minor docs update 2015-10-20 10:49:39 +01:00
agconti
6757da5aab docs(third-party-resources): added cookiecutter-django-rest to misc third party resources 2015-10-18 20:13:09 -04:00
Pierre Dulac
dc72fb4746 Missing the source= keyword for the URLField parameter 2015-10-16 19:43:00 +02:00
Zack Tanner
6fe021eea7 Various typo fixes 2015-10-14 19:09:11 -07:00
Aider Ibragimov
4a6d27ccbb update style of the note 2015-10-14 17:04:47 +03:00
Aider Ibragimov
5342f22009 return typo back for new pr, update docs 2015-10-14 15:54:43 +03:00
Aider Ibragimov
b19865f88d fix typo in adding jquery string, update docs about detail page link for AdminRenderer 2015-10-14 15:14:35 +03:00
Tom Christie
90247afe29 Docs on Forms API 2015-10-12 21:14:58 +01:00
demokrates
47c9d2a4d3 Update versioning.md
Changed settings attribute 'VERSION_PARAMETER' --> to 'VERSION_PARAM'.
2015-10-12 10:10:08 +02:00
Tom Christie
41182c6f06 Formns API 2015-10-06 10:58:20 +01:00
Philip Garnero
3cdd3c5f6e Added django-rest-framework-social-oauth2 to list of third party packages 2015-10-02 14:30:27 -07:00
Andrew
f60c0e99f6 Small doc typo throttles --> throttling 2015-10-01 14:25:04 +07:00
Rolf Håvard Blindheim
0e56b2ea74 Added drf-haystack to third party resources 2015-09-30 10:24:21 +02:00
Tom Christie
265ec8ac62 Handle binary or unicode with JSONField 2015-09-28 17:47:51 +01:00
Tom Christie
10dbf1316f Added JSONField. Closes #3170. 2015-09-28 17:25:52 +01:00
Tom Christie
bae47b7f36 Merge pull request #3453 from tomchristie/remove-content-overriding
Remove content overriding
2015-09-28 16:42:42 +01:00
Tom Christie
ed677f0138 Update docs for content overriding 2015-09-28 16:37:48 +01:00
Tom Christie
c64896c849 More cleanup of browser overrides 2015-09-28 15:33:55 +01:00
Tom Christie
02e1f69d2b Django 1.9 support 2015-09-28 11:44:07 +01:00
Tom Christie
2d0b54e263 Merge branch 'drop-django-16' oft https://github.com/carltongibson/django-rest-framework into carltongibson-drop-django-16
Conflicts:
	docs/topics/release-notes.md
2015-09-28 11:17:48 +01:00
Tom Christie
ca8313aeac Merge branch 'master' into version-3.3
Conflicts:
	docs/topics/release-notes.md
2015-09-28 10:57:14 +01:00
Carlton Gibson
8d740a11e4 Adjust README and Release Notes 2015-09-22 16:39:25 +02:00
Carlton Gibson
2aa33ed544 Adjust README and Release Notes 2015-09-21 20:23:39 +02:00
Xavier Ordoquy
6ee3e29460 Add #3415 to the 3.2.4 release 2015-09-21 13:28:59 +02:00
Xavier Ordoquy
1054ea559c Fix the issue link. 2015-09-21 13:28:37 +02:00
Xavier Ordoquy
26715c2dae Merge remote-tracking branch 'origin/master' into release/3.2.4 2015-09-21 13:25:49 +02:00
Xavier Ordoquy
d85e7b9ccc Update Release notes for 3.2.4. 2015-09-20 22:03:52 +02:00
Yiyo
7df11078ee Improved Serializer relations docs 2015-09-17 10:30:22 -05:00
Tom Christie
a3067bea55 Merge branch 'master' into version-3.3 2015-09-17 16:24:46 +01:00
James McMahon
6baca94830 added knox package reference to 3rd party auth apps 2015-09-14 19:34:07 +01:00
Tom Christie
b7d77d5bf2 Merge pull request #3396 from qqbuby/3395
fix issue #3395
2015-09-14 10:22:20 +01:00
qqbuby
1aa16caffe append a space after the comment mark to remain consistent with the other parts of the tutorial 2015-09-13 20:24:22 +08:00
Nic Young
5c076e10bb Add link to serpy serialization, fixes #3391 2015-09-12 23:04:18 -07:00
qqbuby
1a8f9d0a0f fix issue #3395 to correct the output text at line 184in docs/tutorial/1-serialization.md 2015-09-12 01:36:40 +08:00
Tom Christie
a67eed1466 Merge branch 'master' of github.com:tomchristie/django-rest-framework 2015-09-11 13:06:18 +01:00
Tom Christie
ab296ced4e Add link to django REST marshmallow 2015-09-11 13:06:09 +01:00
Nic Young
4704da9a1a Add note about field level validation, fixes #3306
The documentation added warns the user that field level validation will
be skipped if the field is declared on the model with the parameter
`required=False`.
2015-09-10 22:55:55 -07:00
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