Osvaldo Santana Neto
02a81d3362
Fix SwaggerRenderer implementation example
2016-07-19 14:15:49 -03:00
Marc Gibbons
d80b0eaead
Update schema generator example ( #4267 )
...
1. The returns from the views needs to be a Response
2. I found that instantiating the generator at the module level caused an import error when starting Django, likely because it is executing before all the app load magic happened. Moving it into the view method solved this.
2016-07-18 16:04:23 +01:00
Germán Larraín
1a65f72f71
docs.settings: fix name of VERSION_PARAM
2016-07-15 14:34:27 -04:00
Tom Christie
8385ae42c0
3.4.0 Release ( #4258 )
...
* 3.4.0 Release
* Version 3.4 release
* Full release notes
* Update translation files
* Update release documentation
* Update release notes
* Docs on supporting alternate schema formats
* Add schema_renderers to DefaultRouter
2016-07-13 16:30:41 +01:00
Mads Jensen
6defb8da47
lookup_type is deprecated in favor of lookup_expr ( #4259 )
...
* lookup_type is deprecated in favor of lookup_expr
* assertEquals is deprecated in favor of assertEqual
* app_name is a required keyword as of Django 1.10
2016-07-13 14:40:42 +01:00
Kenneth Schnall
ff5cfe3e84
Replace "class based views" occurrences with "class-based views" ( #4251 )
2016-07-08 08:38:50 +01:00
kiyoqoko
6338ce80ab
Add localize keyword argument to DecimalField ( #4233 )
...
Add `localize` keyword argument for DecimalField
2016-07-06 16:07:16 +01:00
Tom Christie
6ff9840bde
Schemas & client libraries. ( #4179 )
...
* Added schema generation support.
* New tutorial section.
* API guide on schema generation.
* Topic guide on API clients.
2016-07-04 16:38:17 +01:00
decore
1037a2742e
Update pagination.md
2016-06-28 10:15:42 +08:00
Ken Lewerentz
57122f0422
Added missing colon in extra_kwargs documentation
2016-06-25 22:05:28 +07:00
Tom Christie
c3b7fba918
Exclude read_only=True fields from unique_together validation & add docs. ( #4192 )
...
* Exclude read_only=True fields from unique_together validation
* Test to ensure that unique_together validators can be removed
* Do not add uniquness_extra_kwargs when validators are explicitly declared.
* Add docs on validation in complex cases
2016-06-13 13:31:12 +01:00
Tom Christie
2712d4e5fe
Note on obtain_auth_token and throttles/permissions. Closes #4128 . [ci skip] ( #4173 )
2016-06-06 11:03:56 +01:00
Tom Christie
d404597e0b
Update FileUploadParser docs. Closes #4167 . [ci skip] ( #4169 )
2016-06-03 09:37:09 +01:00
Tom Christie
75751cc64e
Allow relative style hyperlinked URLs
2016-06-02 15:03:17 +01:00
sohopro
20e3a9a006
Update filtering.md
2016-06-02 16:12:35 +09:00
Adam Chainz
e3337ab4aa
Convert readthedocs link for their .org -> .io migration for hosted projects
...
As per [their blog post of the 27th April](https://blog.readthedocs.com/securing-subdomains/ ) ‘Securing subdomains’:
> Starting today, Read the Docs will start hosting projects from subdomains on the domain readthedocs.io, instead of on readthedocs.org. This change addresses some security concerns around site cookies while hosting user generated data on the same domain as our dashboard.
Test Plan: Manually visited all the links I’ve modified.
2016-05-29 23:26:56 +01:00
Carlton Gibson
9d87dbc016
Remove Py2/Py3 difference from Example ( #4145 )
...
`print` is available as a function on every supported version of Python (2.7+)
2016-05-25 14:38:44 +01:00
Tom Christie
9b56dda918
Update requests.md
...
Drop out-of-date paragraph on `request.content`
2016-05-18 08:38:18 +01:00
Joe Simpson
5cf7d4a90d
Add LaTeX renderer to documentation ( #4131 )
2016-05-17 12:09:25 +01:00
Petros Moisiadis
788603e153
Document allow_empty argument ( #4117 )
...
ListSerializer fields or serializers that are passed many=True may also take an allow_empty=False argument to disallow empty lists as valid input.
Information about this was part of the 3.2 release announcement, but had not been part of the API docs until now.
2016-05-13 15:55:31 +01:00
Graham R. Jeffries
dbbf79be64
minor docs indentation fix ( #4101 )
...
Fixes a minor indentation typo.
2016-05-06 11:58:58 +01:00
Miro Hrončok
ffdac0d936
TokenAuthentication: Allow custom keyword in the header ( #4097 )
...
This allows subclassing TokenAuthentication and setting custom keyword,
thus allowing the Authorization header to be for example:
Bearer 956e252a-513c-48c5-92dd-bfddc364e812
It doesn't change the behavior of TokenAuthentication itself,
it simply allows to reuse the logic of TokenAuthentication without
the need of copy pasting the class and changing one hardcoded string.
Related: #4080
2016-05-04 10:53:34 +01:00
Taylor Edmiston
c355cdc585
Fix typo in permissions docs
2016-05-03 14:20:45 -04:00
Kyle Hornberg
399e1c1dcf
Typo fix ( #4094 )
2016-05-03 15:53:55 +01:00
Xavier Ordoquy
a9bbb502cb
Remove references to South as we don't need it any longer. ( #4085 )
...
* Remove references to South as we don't need it any longer.
* Add a note about auth_token including Django migrations.
2016-04-29 14:16:03 +01:00
Xavier Ordoquy
bff3bebdbe
Merge remote-tracking branch 'reference/stable/3.3.x' into merge_test
...
# Conflicts:
# docs/topics/release-notes.md
2016-04-08 15:46:17 +02:00
Anthony Lukach
3fdd6e1db5
Add .partial_update to ModelViewSet documentation
...
The ModelViewSet inherits from the UpdateModelMixin, which provides the `.partial_update` method. This should be reflected in the documentation.
2016-03-29 10:50:12 -06:00
S. Andrew Sheppard
101c178b8c
links to html-json-forms package
2016-03-24 11:55:19 -05:00
Stephan Groß
0056703fe8
Fix code sample indention
2016-03-21 10:23:34 +00:00
aleontiev
3a3fd66852
documentation: add a reference to the dynamic-rest addons under the serializers guide
2016-03-11 12:43:17 -05:00
Xavier Ordoquy
c91229aaab
PAGINATE_BY_PARAM and MAX_PAGINATE_BY removed in 3.3
2016-03-08 06:41:08 +01:00
Xavier Ordoquy
c90cf828ae
PAGE_SIZE addition in 3.1
2016-03-08 06:40:33 +01:00
Xavier Ordoquy
180137300f
PAGINATE_BY removed in 3.3
2016-03-08 06:39:58 +01:00
Xavier Ordoquy
a0aac166bc
DEFAULT_PAGINATION_SERIALIZER_CLASS removed in 3.1
2016-03-08 06:39:08 +01:00
Xavier Ordoquy
9208619362
Those are now fully removed.
2016-03-08 06:38:03 +01:00
Xavier Ordoquy
cac1ecb250
paginate_by removed in 3.3
2016-03-08 06:37:46 +01:00
Krzysztof Szularz
cfd681dc73
Add /en to Heroku guidelines link
2016-03-07 21:01:04 +01:00
meoooh
0a2a01d05a
fix typo
...
fix typo
2016-03-07 20:58:47 +01:00
Wes
0e1dcb7323
fix typo
2016-03-07 20:58:24 +01:00
Luke Murphy
ef8e7f168f
add rest-framework-generic-relations link to docs
2016-03-07 19:37:30 +01:00
José Padilla
b3582cd36b
Merge pull request #3973 from lwm/docs-generic-relations
...
add rest-framework-generic-relations link to docs
2016-03-01 13:54:44 -04:00
Luke Murphy
66e86dc483
add rest-framework-generic-relations link to docs
2016-03-01 18:44:17 +01:00
Krzysztof Szularz
2ddd30be90
Add /en to Heroku guidelines link
2016-03-01 14:52:07 +01:00
Rex Kerr
f3b4cb5951
Fixes incorrect references to URLPathVersioning
2016-03-01 10:36:05 +01:00
Rex Kerr
88320b8a61
Fixes incorrect references to URLPathVersioning
2016-02-27 12:41:56 -08:00
Luke Murphy
c03c6c6e78
fix typo in relations docs
2016-02-27 00:27:41 +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
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
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
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
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
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
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
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
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
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
Kirill Zaborsky
85db6a681b
Fixed versioning regexp
...
booking list regexp was fixed in 8b97bb8f68
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
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
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
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
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
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
c64896c849
More cleanup of browser overrides
2015-09-28 15:33:55 +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
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
Nic Young
5c076e10bb
Add link to serpy serialization, fixes #3391
2015-09-12 23:04:18 -07: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
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
Slava Shklyaev
49d799c454
Fix typo
2015-08-24 21:09:08 +03: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
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
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
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
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
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
1f55bc747b
Merge pull request #2926 from tomchristie/admin-style
...
Admin style renderer
2015-07-30 15:01:37 +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
Adrian Mester
d9c934debd
fixed a typo in docs
2015-07-23 13:10:20 +03:00
Tom Christie
f9c61e8090
Prominent notes on deprecation status of pagination settings. Closes #3173 .
2015-07-22 12:36:32 +01: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
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
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
José Padilla
f161241e07
Fix custom parser example
2015-07-05 16:48:33 -04:00
Matt Broach
9e58bf6500
added link to Django Rest Multiple Models to Third Party Packages
2015-07-02 17:20:41 -04: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
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
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
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
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
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
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
Don Kirkby
0b8dd906cf
minor grammar fix
2015-05-08 15:28:30 -07: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
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
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
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
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
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
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
Aaron Yong
000db8df18
Fix typo in versioning docs
2015-03-17 11:36:02 -06:00
Rubén Durá Tarí
ac44bae90d
Updates ducumentation DEFAULT_PAGE_SIZE left over after #2655
2015-03-16 14:53:26 +00: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
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
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
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
8f988466a5
Docs on exception handler context. Closes #2604 .
2015-02-26 13:20:26 +00:00
Tom Christie
03818ed004
Pagination tweaks and docs
2015-02-26 12:48:34 +00:00
Mateusz Sikora
e51dc1855c
Update authentication.md
2015-02-25 18:51:20 +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
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
donewell
9ea615af14
add message to custom permission
...
change detail to message and update text
2015-02-10 20:11:53 +00: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
Tom Christie
5d8c3abe72
Fix typo
2015-02-06 15:27:35 +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
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
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
Jeff Fein-Worton
0a65913fea
typo in fields.md
2015-01-24 18:34:16 -08:00
Jeff Fein-Worton
39da9c7c86
minor typo in viewsets docs
2015-01-24 12:53:21 -08:00
Tom Christie
35f6a82462
Added DictField and support for HStoreField.
2015-01-23 16:27:23 +00:00
Tom Christie
5bb348605e
UUIDField docs
2015-01-23 15:31:08 +00:00
Tom Christie
39f26c9eca
Merge master
2015-01-23 14:28:59 +00:00
Duncan Maitland
6e471ad8f4
fix link to Django CSRF docs
2015-01-22 18:29:20 +11:00
Tom Christie
9ec08ce578
Merge master
2015-01-21 13:12:14 +00:00
soooooot
3ca8f85a5b
correcting unclosed quote in routers.md
...
correcting unclosed quote in routers.md
2015-01-20 22:24:58 +08:00
Tom Christie
6065cdbd93
Merge master
2015-01-19 15:16:57 +00:00
Tom Christie
53edd37df5
Tests for LimitOffsetPagination
2015-01-15 21:07:05 +00:00
Tom Christie
313aa727e3
Tweaks
2015-01-14 17:46:41 +00:00
Tom Christie
1bcec3a0ac
API tweaks and pagination documentation
2015-01-13 17:14:13 +00:00
Carlton Gibson
41e13d73fa
Merge pull request #2407 from philipn/filters_link_fix
...
Fix link to `django-rest-framework-filters`
2015-01-13 09:04:33 +01:00
Philip Neustrom
7f9a62a5bf
Fix link to django-rest-framework-filters (formerly
...
`django-rest-framework-chain`)
2015-01-13 15:22:08 +08:00
Tom Christie
f0ad0a88c4
Link to Roy Fielding versioning interview.
2015-01-08 12:31:51 +00:00
Tom Christie
3dbcefb3c7
Merge branch 'master' of https://github.com/tomchristie/django-rest-framework
2015-01-08 11:07:52 +00:00
Tom Christie
e61ef3d39f
Minor docs updates
2015-01-08 11:07:47 +00:00
JocelynDelalande
fe92a2cfee
fixed doc : DEFAULT_AUTHENTICATION_CLASSES -> DEFAULT_AUTHENTICATION
...
+ It is consistent with docs about DEFAULT_PERMISSION_CLASSES
2015-01-07 10:42:11 +01:00
Tom Christie
271b638df1
Update exception docs. Closes #2378 .
2015-01-06 11:21:58 +00:00
Tom Christie
949e3b7507
Merge branch 'master' into version-3.1
2015-01-05 15:04:23 +00:00
Tom Christie
b6ca7248eb
required=False allows omission of value for output. Closes #2342
2015-01-05 14:32:12 +00:00
Tom Christie
17665aa52a
Add docs for OAuth, XML, YAML, JSONP packages. Closes #2179 .
2015-01-05 12:26:15 +00:00
Tom Christie
6168f60ba8
Merge branch 'master' into version-3.1
2015-01-05 11:02:28 +00:00
Tom Christie
d8e66970a1
Note on using i18n_patterns with format_suffix_patterns. Closes #2278 .
2014-12-28 12:14:07 +00:00
Tom Christie
8dc95ee221
Add notes on include and namespacing. Closes #2335 .
2014-12-28 11:24:49 +00:00
Tom Christie
27f84aa0f3
Merge branch 'master' of https://github.com/tomchristie/django-rest-framework
2014-12-28 11:02:36 +00:00
Tom Christie
a636320ff3
Add import notes in docs. Closes #2357
2014-12-28 11:02:19 +00:00
Rocky Meza
5b5652594a
Typo manger => manager
2014-12-26 22:24:31 -07:00
Matías Lang
18687f075d
Documented an optional argument of HyperlinkedIdentityField
...
lookup_url_kwarg argument of HyperlinkedIdentityField wasn't documented
2014-12-23 12:22:10 -03:00
Brian Stearns
3569674860
use of double quotes broke the code highlighting.
2014-12-21 18:53:35 -05:00
Tom Christie
2a1485e009
Final bits of docs for ModelSerializer fields API
2014-12-19 21:32:43 +00:00
Tom Christie
48d15f6ff8
Stub out the documentation
2014-12-19 16:58:35 +00:00
Tom Christie
d109ae0a2e
Merge pull request #2010 from tanwanirahul/master
...
Ability to customize method names without creating a custom router
2014-12-19 16:09:01 +00:00
Rahul
b4a3e7f640
Updates url_path info per suggestion
2014-12-19 21:20:19 +05:30
Rahul
6aa0e307c9
Added documentation about url_path parameter for custom actions.
2014-12-19 20:31:21 +05:30
Tom Christie
435aef7738
Merge branch 'master' into version-3.1
2014-12-19 11:53:05 +00:00
Tom Christie
7105c1308e
Add OPTIONS/metadata to docs index
2014-12-18 15:42:27 +00:00
Tom Christie
c8d88c8c8a
Merge branch 'master' into version-3.1
2014-12-18 11:21:25 +00:00
Tymur Maryokhin
eeb6e34064
Docs/tutorial import fixes. Refs #2296
2014-12-17 17:28:11 +01:00
Tom Christie
265ed9377e
Merge branch 'master' of https://github.com/tomchristie/django-rest-framework
2014-12-17 16:19:13 +00:00
Tom Christie
c9a2ce0703
Expand permissions docs. Closes #2223 .
2014-12-17 16:19:02 +00:00
Tom Christie
ad6533e554
Merge pull request #2294 from tomchristie/fix-empty-html-values-with-default
...
Fix empty HTML values when a default is provided.
2014-12-17 15:24:01 +00:00
Tom Christie
3fff5cb6e0
Fix empty HTML values when a default is provided.
2014-12-17 15:13:48 +00:00
Tom Christie
c6137bbf5a
Serializer API restrictions.
2014-12-17 14:14:51 +00:00
Tom Christie
05a6eaec8a
More docs, plus 'ALLOWED_VERSIONS' setting.
2014-12-17 12:41:46 +00:00
Tom Christie
6e51e4f5cd
Versioning first pass
2014-12-16 15:34:19 +00:00
José Padilla
d71ef9c6d8
Closes #2281
2014-12-15 21:48:31 -04:00
Tom Christie
b6ee784240
Merge master
2014-12-15 12:18:55 +00:00
Jason Spafford
56c09cc1f2
Doc typo
2014-12-15 02:41:39 -08:00
Tom Christie
d232c5739e
Merge branch 'exception-handler-context' of git://github.com/jpadilla/django-rest-framework into version-3.1
2014-12-15 09:19:53 +00:00
Tom Christie
4778463e32
Merge branch 'master' into version-3.1
2014-12-15 09:18:11 +00:00
José Padilla
478c8d724b
Update docs
2014-12-14 10:16:52 -04:00
Brian Jacobel
2d470eef80
Change serializers.Field to serializers.ReadOnlyField for 3.x compatibility
...
Using this code snippet as-is on DRF 3.0.1 results in a NotImplementedError
being raised for to_representation due to 3.0's changed behavior with
serializers.Field. The code snippet should be updated to use
serializers.ReadOnlyField instead.
Further discussion here:
https://groups.google.com/forum/?fromgroups=#!topic/django-rest-framework/aX8mLT_v3yc
2014-12-13 14:47:11 -05:00
Jeff Fein-Worton
00da241482
documentation typo
...
base-name -> base_name
2014-12-12 22:14:22 -08:00
Tom Christie
baaa356489
Merge master
2014-12-12 15:37:43 +00:00
Tom Christie
f5b783af61
allow_blank in ChoiceField. Refs #2239 .
2014-12-09 14:21:31 +00:00
Mark Henwood
9b468fba60
Amend ViewSet docs to warn of potential problem
...
I went through this exact problem and so thought the docs might
benefit from a small hint at the appropriate point.
2014-12-07 12:02:43 +00:00
Tom Christie
59b2ad5425
Minor docs tweaks
2014-12-05 13:23:14 +00:00
Tom Christie
e2587c7b4d
Merge pull request #2204 from carltongibson/default-docs-fix
...
Clarify read-only & `unique_together` Documentation
2014-12-05 13:20:16 +00:00
Tom Christie
9fb1b396db
user in example should have been instance. Closees #2191 .
2014-12-05 13:07:31 +00:00
Carlton Gibson
6ee361332b
Add missing definite article
2014-12-04 14:15:01 +01:00
Carlton Gibson
71e1a3942e
Initial link from Serializers to Validators
2014-12-04 12:15:14 +01:00
Tom Christie
3d6620c72a
Merge
2014-12-03 23:24:06 +00:00
Tom Christie
f74e52b31e
Merge
2014-12-03 23:14:58 +00:00
Tom Christie
6369f92125
Merge
2014-12-03 23:12:52 +00:00
Matías Lang
5ad22aea60
Updated serializers documentation
...
There was an error in the docs: the field extra_field_kwargs of the serializer's Meta doesn't work. The field must be extra_kwargs instead.
2014-12-02 12:23:25 -03:00
David Ray
84cff98fbf
fix typo
2014-12-02 09:46:43 -05:00
Tom Christie
6ac79b8223
Document Field.fail(). Closes #2147 .
2014-12-02 09:19:59 +00:00
Tom Christie
f4fc4670ca
Promote 'many_init' to public API. Closes #2152 .
2014-12-02 08:53:36 +00:00
Tom Christie
555c450497
Add missing 'validators.py' link. Closes #2166 .
2014-12-01 14:46:47 +00:00
José Padilla
7f9dc73672
Remove XML support from core
2014-11-29 14:57:51 -04:00
José Padilla
fe745b9616
Remove JSONP support from core
2014-11-29 14:55:33 -04:00
José Padilla
731c8421af
Remove YAML support from core
2014-11-29 14:43:05 -04:00
José Padilla
0cc990792c
Merge branch 'version-3.1' into oauth_as_package
...
Conflicts:
requirements-test.txt
rest_framework/compat.py
tests/settings.py
tox.ini
2014-11-28 12:14:40 -04:00
Tom Christie
08c727add3
@api_view defaults to allowing GET
2014-11-28 15:55:02 +00:00
Tom Christie
9ba29a88d6
Finalizing 3.0 release notes
2014-11-28 14:43:33 +00:00
Tom Christie
8e549a76ea
Add 2.x notes and links
2014-11-28 14:26:03 +00:00
Tom Christie
276a2a52ee
Docs on nested creates/updates and suchlike
2014-11-28 11:26:35 +00:00
Tom Christie
34ca8cd2a5
Moar docs. Amazing.
2014-11-28 09:56:44 +00:00
Tom Christie
0262262fee
3.0 serializer docs
2014-11-27 08:09:58 +00:00
Tom Christie
786cab705a
Tweak to 3.0 relationship docs
2014-11-26 11:38:48 +00:00
Tom Christie
5a5a73c7fe
3.0 docs and tidy-up for serializer relationships
2014-11-26 11:30:49 +00:00
Tom Christie
e1b14cbe4a
3.0 docs for serializer fields
2014-11-26 10:27:29 +00:00
Tom Christie
0f5338ada9
Call out removal of pre_save/post_save more strongly
2014-11-26 09:06:15 +00:00
Tom Christie
c01c631ef2
perform_create, perform_update, perform_destroy hooks
2014-11-26 09:04:48 +00:00
Tom Christie
31536566d7
Updating fields docs
2014-11-25 17:35:27 +00:00
Tom Christie
f13c0ebe69
Merge master
2014-11-25 16:27:00 +00:00
Tom Christie
8c91e7b742
Add missing options
2014-11-25 15:52:13 +00:00
José Padilla
16d442dda3
Use MkDocs meta.source to render source code links
2014-11-25 12:44:11 +00:00
Tom Christie
c4dff54ecc
Docs on ValidationError
2014-11-25 12:04:46 +00:00
Tom Christie
a3c0c8fb90
Add missing period.
2014-11-25 12:04:35 +00:00
Tom Christie
2e726e22a3
request.DATA, request.FILES -> request.data
2014-11-25 11:42:43 +00:00
Matthew Dapena-Tretter
8e940a22fb
Clarify how permission classes are composed
...
all/every/AND or any/OR? all/every/AND!
2014-11-21 16:04:45 -05:00
Tom Christie
0f508c5821
Docs for advanced default argument usage. Closes #1945
2014-11-17 18:36:32 +00:00
Eleni Lixourioti
1aa7783095
Merge branch 'version-3.1' of github.com:tomchristie/django-rest-framework into oauth_as_package
...
Conflicts:
.travis.yml
2014-11-15 14:27:41 +00:00
Tom Christie
fd7db776ad
Bring UniqueValidator implementation in line with other uniquness validators.
2014-11-10 12:32:03 +00:00
Tom Christie
f387cd89da
Uniqueness constraints imply a forced 'required=True'. Refs #1945
2014-11-10 12:21:27 +00:00
Brett Koonce
b44def4650
minor spelling tweaks
2014-11-06 23:19:26 -08:00
Tom Christie
5250700659
Add docs on request.accepted_renderer and .accepted_media_type
2014-11-05 11:14:41 +00:00
Tom Christie
571440e143
Stronger calling out of 'DjangoObjectPermissionsFilter'. Closes #1934 .
2014-11-05 10:53:46 +00:00
Tom Christie
09f3eedb23
Add notes re view-level and instance-level permissions checks. Closes #1819 .
2014-11-03 15:23:16 +00:00
Tom Christie
78ac332f18
Add docs on Meta inheritance. Closes #1926 .
2014-11-03 15:08:19 +00:00
Tom Christie
21d06a4103
Added NON_FIELD_ERRORS_KEY to serializer docs. Closes #1971 .
2014-11-03 15:03:10 +00:00
Tom Christie
d27b8cc09b
PUT as create docs, and move mixin out to external gist
2014-11-03 12:00:19 +00:00
Tom Christie
0e59c27e2f
Merge branch 'master' into version-3.0
2014-10-31 15:19:40 +00:00
Tom Christie
159c3de9fc
Merge master
2014-10-31 15:19:15 +00:00
Tom Christie
254701230d
Fix up validators docs
2014-10-31 13:58:40 +00:00
Tom Christie
2762205887
Validator documentation and tweaks
2014-10-31 13:47:36 +00:00
Andrew Conti
f25f05dde5
Update authentication.md
...
Based on the [new documentation](https://docs.djangoproject.com/en/dev/topics/auth/customizing/#django.contrib.auth.get_user_model ) for Django 1.7 we should now use:
```python
@receiver(post_save, sender=settings.AUTH_USER_MODEL)
```
instead of:
```python
@receiver(post_save, sender=get_user_model())
```
because `get_user_model()` only works once Django has imported all models. Otherwise you'll get:
```python
django.core.exceptions.AppRegistryNotReady: Models aren't loaded yet.
```
When trying to start your sever after adding token authentication.
From the Docs, ( linked above as well ) :
>New in Django 1.7:
>When connecting to signals sent by the User model, you should specify the custom model using the AUTH_USER_MODEL setting.
2014-10-29 16:31:36 -04:00
konradhalas
113a28ed8a
Add djoser to authentication docs.
2014-10-16 13:48:18 +02:00
Tom Christie
babdc78e61
Typo
2014-10-09 11:39:01 +01:00
Tom Christie
6637b2fae0
Document the Metadata API
2014-10-09 11:08:26 +01:00
Craig de Stigter
dfab9af294
Minor: fix spelling and grammar, mostly in 3.0 announcement
2014-10-03 08:41:18 +13:00
Tom Christie
ac71d9aaae
Merge master
2014-09-26 14:39:20 +01:00
Collin Anderson
da385c9c1f
remove patterns and strings from urls #1898
2014-09-23 17:10:02 -04:00
Tom Christie
88008c0a68
Merge branch 'master' into version-3.0
2014-09-19 14:05:50 +01:00
Matthew J Morrison
764366b2e1
Fixed code formatting
2014-09-17 11:29:15 -05:00
Matthew J Morrison
e5af0bbb35
Clarify "raised inside REST framework"
...
I ran into an issue today where I was not seeing the rest_framework.views.exception_handler do what I thought it should be doing. It turned out that I had imported View from rest_framework.views rather than importing APIView from rest_framework.views. The phrase "raised inside REST framework" was confusing as I was debugging this issue. I was unsure if that meant that I could raise those exceptions in my code or if it had to originate from within framework code.
I'm not sure if the proposed wording is ideal, I just wanted to point out what I found to be confusing.
2014-09-17 07:49:54 -05:00
Tom Christie
4fceceae7d
DecimalField documentation
2014-09-12 20:09:08 +01:00
Tom Christie
f95e7fae38
Updating docs
2014-09-12 12:40:53 +01:00
Tom Christie
19b8f779de
Throttles now use Retry-After header and no longer support the custom style
2014-09-11 20:43:44 +01:00
Tom Christie
de301f3b66
Merge master
2014-09-11 13:20:44 +01:00
S. Andrew Sheppard
e76f56a3d6
add django rest pandas
2014-09-10 11:55:43 -05:00
Darren Maki
fe06d96dec
Fixing quotes in filtering.md
...
Incorrect quotes used in examples.
2014-09-07 12:53:21 -04:00
Jharrod LaFon
baa518cd89
Moved OAuth support out of DRF and into a separate package, per #1767
2014-09-05 15:30:01 -07:00
Tom Christie
0f8fdf4e72
Remove allow_empty.
...
Closes #1774 .
2014-08-29 10:57:24 +01:00
Tom Christie
d8eb9e6d45
Docs whitespace fix.
2014-08-29 10:48:16 +01:00
Tom Christie
8f4ae06b3b
Merge pull request #1784 from tomchristie/remove-model-attribute
...
Deprecate `.model` attribute on views
2014-08-29 10:03:07 +01:00
Nathan Hubbell
be21cafd2b
Update generic-views.md
...
Small grammar changes.
2014-08-27 17:57:40 -07:00
Nathan Hubbell
19076510f4
Update generic-views.md
2014-08-26 17:31:08 -07:00
Carlton Gibson
c29c75da28
Merge pull request #1789 from nemesisdesign/patch-5
...
docs: added drf-hstore to third party fields
2014-08-26 11:19:48 +02:00
Federico Capoano
eb81c55d16
docs: added HStoreSerializer to third party serializers
...
added a reference to django-rest-framework-hstore in docs/api-guide/serializers.md
2014-08-25 12:32:44 +02:00
Federico Capoano
8e3f7700f6
docs: added drf-hstore to third party fields
...
added a reference to django-rest-framework-hstore in docs/api-guide/fields.md
2014-08-25 12:29:10 +02:00
Tom Christie
8b2052172c
Add .model deprecation to release notes
2014-08-21 12:25:20 +01:00
Tom Christie
4d8c63abc9
Deprecate .model in related routers/permissions
2014-08-20 17:15:46 +01:00
Tom Christie
0c65e028b6
Release notes
2014-08-19 23:25:12 +01:00
Tom Christie
e385a7b8eb
Merge master
2014-08-19 10:11:10 +01:00
Tom Christie
2aad8e4b35
Merge pull request #1654 from carltongibson/1559-take-2
...
Allow use of native migrations in 1.7 — Take 2
2014-08-18 18:54:43 +01:00
Carlton Gibson
556948661a
Improve wording.
2014-08-18 13:54:46 +02:00
Carlton Gibson
db4426fc35
Alter other reference to migrations.
2014-08-18 13:52:57 +02:00
Carlton Gibson
ae2ab496c2
Updated docs for South v1.0
2014-08-18 13:48:46 +02:00
Tom Christie
8244c7cc33
Merge pull request #1711 from kdazzle/ModelViewSet-queryset-static-property
...
Issue #1707 : Add documentation to api-docs.viewsets
2014-08-18 12:25:03 +01:00
Tom Christie
6edbabe0e1
Link to Django docs on widgets. Closes #1760 .
2014-08-18 10:58:00 +01:00
Tom Christie
c6326d0a67
Merge pull request #1745 from nemesisdesign/patch-4
...
docs: add reference to gis serializer
2014-08-09 07:41:37 +01:00
Federico Capoano
c462a43a87
docs: added reference to gis serializer
...
added reference to GeoFeatureModelSerializer of django-rest-framework-gis
2014-08-08 14:39:56 +02:00
Federico Capoano
5eb901cd2a
docs: added reference to DRF-gis in fields
...
added django-rest-framework-gis to third party packages section in /docs/api-guide/fields.md
2014-08-08 14:25:02 +02:00
Rob Terhaar
3217842346
minor doc fix, @api_view() needs an iterable
2014-08-06 18:55:08 -04:00
Kevin London
c0f002b09d
Updated Permissions doc link to Django docs
...
The previous link went to version 1 docs so it was a dead link.
2014-07-31 12:41:15 -07:00
Tom Christie
57d6e04ff5
Add django-rest-framework-mongoengine link. Closes #1722 Closes #1562 Closes #1545
2014-07-30 12:50:36 +01:00
Kyle
fc8eb76c22
Issue #1707 - Add info about queryset property caching to get_queryset() docs.
...
Add documentation to the get_queryset() method of generic-views.md regarding
the caching of the queryset property.
2014-07-28 10:19:42 -07:00
Kyle
e40ffd60d4
Issue #1707 - Add documentation about the caching of GenericAPIView.queryset
...
to the `queryset` property, `get_queryset()`, and do generic-views.md; remove
changes to the viewsets.md documentation from my last commit.
2014-07-28 10:11:40 -07:00
Kyle Valade
48b02f016a
Issue #1707 : Add documentation to api-docs.viewsets notifying users
...
that they should use the get_queryset() method when overriding a
ModelViewSet method, such as list(). Otherwise, since queryset is
a static property, the value will be cached for every instance of
that ViewSet.
2014-07-27 14:01:43 -07:00
Xavier Ordoquy
4876bec9f5
Merge remote-tracking branch 'origin/master' into 2.4.0
...
Conflicts:
rest_framework/fields.py
2014-07-26 00:06:56 +02:00
Tom Christie
299a8347e8
Merge pull request #1692 from davbo/patch-1
...
Update fields.md
2014-07-22 15:59:04 +02:00
Tom Christie
81d15aa9be
Add link to drf-extra-fields. Closes #1698
2014-07-20 15:45:45 +01:00
Dave King
680fabe9dd
Update fields.md
...
obj.__class__ will return the actual Class object, we want to serialise a string (accessed with obj.__class__.__name__)
2014-07-17 11:46:59 +01:00
Tom Christie
b519018125
Docs on object level permissions and filters. Closes #1683
2014-07-07 09:51:23 +01:00
Tom Christie
91eabd54bb
Docs tweak
2014-07-01 14:34:23 +01:00
Chibisov Gennady
c1426d1078
Fixes #1651 . Add link to drf-extensions nested routers to docs
2014-06-26 23:29:00 +04:00
Carlton Gibson
d98245ac22
Merge branch '2.4.0' of github.com:tomchristie/django-rest-framework into #1559
...
Conflicts:
docs/topics/release-notes.md
2014-06-24 10:30:08 +02:00
Carlton Gibson
3f727ce738
Added (first pass) notes to docs & release notes. Backed out SOUTH_MIGRATION_MODULES setting from rest_framework.settings
2014-06-24 09:02:44 +02:00
Xavier Ordoquy
2489e38a06
Merge remote-tracking branch 'origin/master' into 2.4.0
...
Conflicts:
.travis.yml
docs/api-guide/viewsets.md
rest_framework/serializers.py
rest_framework/throttling.py
tests/test_generics.py
tests/test_serializers.py
tox.ini
2014-06-23 14:02:45 +02:00
Greg Barker
be84f71bc9
Fix #1614 - Corrected reference to serializers.CharField
2014-06-10 15:20:45 -07:00
Rodolfo Carvalho
31f63e1e55
Fix typo in docs
2014-06-02 11:06:03 +02:00
Tom Christie
a7ff51118f
Note on configuring TokenAuthentication
2014-05-29 14:33:16 +01:00
khamaileon
eab5933070
Add the allow_add_remove parameter to the get_serializer method
2014-05-26 18:43:50 +02:00
Tom Christie
218b94e606
Merge pull request #1536 from Ian-Foote/choicefield_blank_display_value
...
Allow customising ChoiceField blank display value
2014-05-20 16:03:51 +01:00
Ian Foote
1e7b5fd2c0
Document ChoiceField blank_display_value parameter
2014-05-20 14:55:00 +01:00
Giorgos Logiotatidis
768f537dcb
Typo fix.
2014-05-15 15:42:22 +03:00
Xavier Ordoquy
56b4390316
Merge remote-tracking branch 'origin/master' into 2.4.0
...
Conflicts:
.travis.yml
rest_framework/serializers.py
rest_framework/tests/test_authentication.py
2014-04-30 22:21:26 +02:00
Xavier Ordoquy
d8fb81ceb1
Merge pull request #1391 from kaygorodov/master
...
Turning off pagination
2014-04-30 20:14:16 +02:00
Laurent Bristiel
d8cb85ef8f
typo
2014-04-28 22:00:36 +02:00
dpetzel
5e8f05a8de
very minor typo in code example
2014-04-28 13:51:50 -04:00
Xavier Ordoquy
d08536ad9d
Merge remote-tracking branch 'origin/master' into 2.4.0
...
Conflicts:
.travis.yml
docs/api-guide/fields.md
docs/api-guide/routers.md
docs/topics/release-notes.md
rest_framework/authentication.py
rest_framework/serializers.py
rest_framework/templatetags/rest_framework.py
rest_framework/tests/test_authentication.py
rest_framework/tests/test_filters.py
rest_framework/tests/test_hyperlinkedserializers.py
rest_framework/tests/test_serializer.py
rest_framework/tests/test_testing.py
rest_framework/utils/encoders.py
tox.ini
2014-04-13 00:05:57 +02:00
Miro Hrončok
f68596a732
Document new UnicodeYAMLRenderer
2014-04-10 01:58:06 +02:00
Craig
3234a5dd6b
Fix python syntax in filtering docs
2014-04-08 22:56:07 -04:00
Tom Christie
abe14c06f7
Minor docs tweak
2014-03-17 08:36:13 +00:00
Tom Christie
dddbff5931
Tweak DRF compound fields docs
2014-03-17 08:33:18 +00:00
Steven Cummings
c779dce3e4
Serializer fields section for 3rd-party packages
...
* Add new section to serializer fields page where we can list and link 3rd-party packages that provide more field types
* Add an entry for drf-compound-fields
2014-03-16 18:55:21 -05:00
Peter Inglesby
2353878951
Add SEARCH_PARAM and ORDERING_PARAM to settings
...
Fixes #1434
2014-03-06 21:39:44 +00:00
Kumar McMillan
c2cd610b15
Adds HawkREST to 3rd party auth docs
2014-02-28 16:52:47 -06:00
Kumar McMillan
a4470c4276
Fix trailing whitespace
...
Sorry, my editor does this automatically
2014-02-28 16:51:32 -06:00
Charlie Denton
c3967c08ab
Minor docs example fix
...
Dates are smaller when they happen before.
2014-02-21 14:23:33 +00:00
Tom Christie
9841069373
Link to DRF-extensions. Refs #1430
2014-02-20 14:54:17 +00:00
Elvio Toccalino
1a4c6f075b
include djangorestframework-httpsignature in the docs
2014-02-20 01:07:39 -03:00
Saurabh Kumar
b3aa512d35
fix(docs): fix code indentation in serializers.md
...
It fixes the indentation of `restore_object()` in the section "Specifying which fields should be write-only" serializers documentation.
2014-02-18 20:39:39 +05:30
Bo Peng
6f4c2c6f05
Update throttling.md
...
Added comma to make DEFAULT_THROTTLE_CLASSES a tuple in example, for copy&paste to work nicely.
2014-02-14 13:47:06 -06:00
Vita Smid
821f848802
Minor typos fixed in api-guide/testing.md (request -> response).
2014-02-14 10:44:02 +01:00
Hassan Shamim
97b7c25987
Replace 'detail' with 'default_detail' in Exceptions guide and APIException class docstring.
2014-02-10 12:54:56 -06:00
Andrey Kaygorodov
2d20512d25
#1390 , docs, turning of pagination
2014-02-05 21:10:51 +08:00
Andrey Kaygorodov
d48ba1cff7
turn of pagination
2014-02-05 05:47:27 +08:00
RicterZ
ba8a0bac53
Fixed a bug backticks
...
fix
you may optionally exclude the ``self.check_object_permissions, and simply return the object from the `get_object_or_404` lookup.
to
you may optionally exclude the `self.check_object_permissions`, and simply return the object from the `get_object_or_404` lookup.
2014-02-04 23:41:13 +08:00
Charlie Denton
40b148a2e4
Viewsets docs typo
...
The docstring in the example said "update" instead of "create".
2014-02-03 14:54:44 +00:00
Jeff Fein-Worton
a33eb4177e
fixed typo (wrong "its")
2014-02-02 21:21:08 -08:00
meoooh
e437854a44
Update fields.md
2014-02-01 15:02:11 +09:00
Tom Christie
fab531961b
Merge pull request #1379 from bodylabs/exception_example
...
Fix doc for custom exception sample
2014-01-31 09:52:47 -08:00
Paul Melnikow
77ced39e6c
Fix doc for custom exception sample
...
The way to provide a default detail for APIException is to define a `default_detail` attribute on the subclass.
Defining a `detail` attribute without `default_detail` will not work, and will result in empty detail instead.
2014-01-31 12:26:45 -05:00
Tom Christie
e3c5a13451
Drop django-rest-framework-bulk API descriptions
2014-01-19 21:09:49 +00:00
Tom Christie
96e6565be8
Merge pull request #1363 from miki725/master
...
Added docs for bulk views from django-rest-framework-bulk.
2014-01-19 13:08:12 -08:00
José Padilla
1c34051f5e
Include the djangorestframework-jwt package
2014-01-18 23:51:18 -05:00
Miroslav Shubernetskiy
37cd49cac9
Added docs for bulk views from django-rest-framework-bulk.
2014-01-18 22:31:36 -05:00
Tom Christie
71c03b9db9
Security update to OrderingFilter
2014-01-15 14:27:41 +00:00
