Carlton Gibson
7b1582e00e
Allow schema = None
. Deprecate exclude_from_schema
( #5422 )
...
* Add tests for schema exclusions
* Move exclusion check to should_include_endpoint
* Update docs
* Switch to using `schema = None`
* Test PendingDeprecationWarnings
* Add note to release notes.
* s/deprecated/pending deprecation/
* Add PR link to release notes
* Correct typo in test class name
* Test 'exclude_from_schema' deprecation warning message (#1 )
* Correct deprecation warning message
2017-09-20 11:29:47 +02:00
Carlton Gibson
d54df8c438
Refactor schema generation to allow per-view customisation ( #5354 )
...
* Initial Refactor Step
* Add descriptor class
* call from generator
* proxy back to generator for implementation.
* Move `get_link` to descriptor
* Move `get_description` to descriptor
* Remove need for generator in get_description
* Move get_path_fields to descriptor
* Move `get_serializer_fields` to descriptor
* Move `get_pagination_fields` to descriptor
* Move `get_filter_fields` to descriptor
* Move `get_encoding` to descriptor.
* Pass just `url` from SchemaGenerator to descriptor
* Make `view` a property
Encapsulates check for a view instance.
* Adjust API Reference docs
* Add `ManualSchema` class
* Refactor to `ViewInspector` plus `AutoSchema`
The interface then is **just** `get_link()`
* Add `manual_fields` kwarg to AutoSchema
* Add schema decorator for FBVs
* Adjust comments
* Docs: Provide full params in example
Ref feedback b52e372f8f (r137254795)
* Add docstring for ViewInstpector.__get__ descriptor method.
Ref https://github.com/encode/django-rest-framework/pull/5354#discussion_r137265022
* Make `schemas` a package.
* Split generators, inspectors, views.
* Adjust imports
* Rename to EndpointEnumerator
* Adjust ManualSchema to take `fields`
… and `description`.
Allows `url` and `action` to remain dynamic
* Add package/module docstrings
2017-09-14 09:46:34 +01:00
Jozef
7037ce88e9
Fix throttling documentation about Remote-Addr ( #5414 )
...
Clarify in docs that REMOTE_ADDR is part of the WSGI environ, not an HTTP header.
2017-09-12 12:08:32 +01:00
Sanjuro Jogdeo
0e341c24b4
Update get_object() example in permissions.md ( #5401 )
...
* Update get_object() example in permissions.md
I'm a bit confused about the example that's provided in the 'Object level permissions' section. Other examples (e.g. Tutorial 3 - Class Based Views) provided a pk to get_object(). It doesn't seem like this example has any way of identifying a specific object.
Just in case I'm correct, I've prepared this pull request. But if I'm wrong, would it be possible for you to explain the example I modified?
Many Thanks...
* Adjust patch
2017-09-08 18:51:16 +02:00
ersel-ionova
13222e45bc
Make status_code documentation more readable. ( #5400 )
...
* Make status_code documentation more readable.
* Update status-codes.md
2017-09-08 16:53:17 +01:00
Irvan
b11f37eaf3
Fixed the MultipleFieldLookupMixin example to properly check for object level permission.
2017-09-07 11:06:44 +08:00
Vadim Laletin
c0475d059d
Update link to drf-writable-nested repository in third-party serializers
2017-08-29 10:39:52 +07:00
Scott Kelly
807b9c716c
Fix doc Response data attribute description
2017-08-23 21:30:56 -05:00
Carlton Gibson
43c7af0bb5
Adjust ListField & DictField signature docs ( #5333 )
...
Closes #5301
2017-08-17 10:06:09 +01:00
Oliver Eidel
bf4b3ff0d5
Fix token param in force_authenticate example ( #5284 )
...
related_name for Token is `auth_token`, not `token`.
2017-08-14 13:09:47 +01:00
Andrea Grandi
1799b569d8
Add documentation to create user token with the new command
2017-08-13 11:08:44 +01:00
Alexander Dutton
e80b78d1cb
RemoteUserAuthentication, docs, and tests ( #5306 )
...
RemoteUserAuthentication, docs, and tests
2017-08-11 10:35:00 +01:00
Steven Johns
9b5a6bea67
Fix typo on fields.md
( #5320 )
...
> keeps you error messages
to
> keeps your error messages
and
> more cleanly separated from your code
to
> cleaner and more separated from your code
2017-08-09 15:21:23 -04:00
Didi Hoffmann
1368d3677c
Added the separator line back
...
Accidentally also deleted a line.
2017-07-31 15:00:26 +02:00
Didi Hoffmann
ad501d41f5
Added the django user model
...
So it is possible to copy paste the example and it will work out of the box.
2017-07-31 14:50:36 +02:00
Tommy Beadle
2a1fd3b45a
Add link to third-party package for LinkHeaderPagination. ( #5270 )
2017-07-12 16:45:41 +01:00
David Sanders
4091607d94
Add information in docs about djangorestframework-simplejwt package
2017-07-05 14:48:54 -06:00
Neftalí Acosta
900cae1507
Link broken
...
The link to the Python Exception Handling Techniques article written by Doug Hellmann is broken.
I could find the article in the URL I proposed.
2017-06-23 08:09:10 +01:00
Michael Hrivnak
5fe984b657
typo fix
...
removes an extraneous word
2017-06-20 15:07:45 -04:00
Aristóbulo Meneses
5002d1a9ae
Update DOT docs
...
DOT renamed `ext` to `contrib` on their new release `1.0.0`
2017-06-17 15:02:22 +02:00
Matt Broach
e4ec1d744e
Updated DjangoRestMulipleModel documentation to point to new repo location
2017-05-30 23:39:18 -04:00
Tom Christie
5267fcc8c6
Merge pull request #5159 from carltongibson/docs/get_schema_view_params
...
Add `generator_class` parameter to `get_schema_view` docs.
2017-05-29 12:53:49 +01:00
Tom Christie
7de34cf187
Merge pull request #5163 from khakulov/patch-2
...
Added documentation from where to import get_schema_view
2017-05-29 11:55:02 +01:00
Azim Khakulov
d1093b5326
Added documentation from where to import get_schema_view
2017-05-23 02:08:20 +02:00
Carlton Gibson
53b3b83b04
Add generator_class
parameter to docs.
...
`get_schema_view` accepts `generator_class` parameter
2017-05-22 11:55:19 +02:00
Xavier Ordoquy
6831472a62
Remove ambiguous reference to former DjangoFilterBackend.
2017-05-19 23:50:13 +02:00
Xavier Ordoquy
703655bc65
Non model Viewset
requires base_name
when registering to router.
2017-05-19 23:35:25 +02:00
Ryan P Kilby
7322aa6b68
Simplify django-filter docs, add drf integration link
2017-05-03 11:03:11 -04:00
Xavier Ordoquy
a1e6d83533
Add missing pk keyword argument to the detail_route.
2017-05-03 02:19:30 +02:00
Rodney Folz
971bc066c5
Improve grammar in .force_authenticate() docs
...
* Remove unnecessary comma
* Remove the "and simple" copied from the line above.
* Add "entirely" to emphasize that this function bypasses the authentication step.
2017-04-27 15:44:06 -07:00
Tom Christie
aafd0a644f
Merge pull request #4979 from linovia/feature/improve_schema_shortcut
...
Restrict doc & schema shortcuts to a subset of urls
2017-04-27 16:58:01 +01:00
Mike Lissner
b8520a1f2e
Updates the core json media type in the docs
...
Per: http://www.django-rest-framework.org/topics/3.5-announcement/#corejson-media-type
(I was *wondering* why this didn't seem to work!)
2017-04-20 11:37:46 -07:00
Xavier Ordoquy
36e5759498
Add documentation for the get_schema_view
new argument: patterns
2017-04-19 07:49:13 +02:00
Azim Khakulov
613aa61ada
Clarify get_schema_fields signature
...
I had to look for the signature of `get_schema_fields()`in source code.
2017-04-12 12:25:27 +02:00
Tom Christie
20c7a24c14
Merge pull request #5025 from aaronn/thirdparty
...
Add drfpasswordless to Third Party Packages and Authentication pages
2017-03-27 20:12:38 +01:00
aaronykng
0400cbbc4c
Added drfpasswordless to Authentication docs
2017-03-27 12:08:07 -07:00
Jack Evans
73bd709813
Document adding django_filters to installed apps
...
Reminds users to add `django_filters` to their `INSTALLED_APPS` as detailed in the django-filter documentation https://django-filter.readthedocs.io/en/develop/guide/install.html
2017-03-27 16:13:50 +01:00
aaronykng
aa92736d72
Added drfpasswordless to authentication topic page.
2017-03-27 07:19:11 -07:00
Nick Timkovich
51c6d23a05
Mention where the mixins live
...
Ctrl-F on the ViewSets page doesn't show where the `mixins.SomeMixin...` classes come from.
2017-03-19 17:17:37 -05:00
Tibo Beijen
cf5d401a0e
Allow required false and default ( #4692 )
...
* Default value will now be used when serializing if key or attribute is missing.
2017-03-07 13:19:19 +00:00
Md. Al-Amin
8a14b39e7d
Added doc for removing pagination in generic-view. ( #4940 )
2017-03-06 18:33:27 +00:00
Vadim
d390762e18
Add drf-writable-nested package to third-party serializers ( #4913 )
2017-02-20 15:16:27 +00:00
Akhil Lawrence
963cb4cdc6
Corrected documentation
2017-02-18 13:20:03 +05:30
Eduard Iskandarov
de8fcbf696
Refs: #4256 delete unrelevant documentation
2017-02-14 13:27:33 +03:00
Michael Borisov
176831e22b
Missing comma ( #4889 )
2017-02-08 15:17:58 +00:00
李扬
cbad236f6d
Add max_length and min_length arguments for ListField ( #4877 )
2017-02-06 09:36:03 +00:00
Luca
635dc03529
Parametrizable viewset custom views reverse name ( #4821 )
2017-01-19 15:20:34 +00:00
Emmanouil Konstantinidis
81195aabbf
Include a link to the django-rest-framework-api-key package
2017-01-18 14:36:43 +00:00
Artem Muterko
b352c8a24c
Fix some typos in documentation
2017-01-08 15:34:52 +02:00
wim glenn
e2c35920d1
fix a spelling error in api-guide ( #4788 )
2017-01-06 22:46:56 +00:00
Roman Vasilyev
64e801e479
get view for django 'virtual hosts' ( #4776 )
...
Brill, thanks! 👍
2017-01-06 22:46:36 +00:00
wim glenn
718764f591
add links to djangorestframework-queryfields to docs ( #4786 )
2017-01-06 06:40:50 +00:00
Ian Clark
eddc34f4c8
Add Serializer Extensions documentation ( #4777 )
2017-01-04 08:40:42 +00:00
Ryan P Kilby
11fd3bf108
Add disabling of declared fields on serializer subclasses ( #4764 )
...
* Add test for disabling declared fields on child
* Check that declared base field is not in attrs
* Update meta inheritance docs to include serializer
* Test that meta fields cannot be declared as None
* Add docs example for declarative field disabling
2017-01-03 21:14:19 +00:00
robert
492444eb2e
added drf-flexfields addon info
2017-01-02 17:03:03 -06:00
Emmanuelle Delescolle
d98a0772d0
Add DRF-Base64 to third-party serializers
...
Add DRF-Base64, which provides serializers to handle base64-encoded files, to third-party serializers packages
2016-12-31 08:16:45 +01:00
Emmanuelle Delescolle
f1cbf51b43
Add drf-schema-adapter to 3rd party metadata mods
2016-12-25 10:06:47 +01:00
Masashi SHIBATA
c2367fb017
Fix documentation's sample code in API Guide ( #4756 )
2016-12-17 13:00:29 +00:00
Eduard Iskandarov
ebe174c0d7
add per-view custom exception handler support ( #4753 )
2016-12-15 12:36:40 +00:00
Tom Christie
89d22942a6
Add missing docs on RequestsClient. Closes #4747 .
2016-12-12 10:08:54 +00:00
Daniel Rech
761d53e923
Updated Link ti Django Docs
...
The Url to the settings/#caches Link changed in Django documentation.
2016-12-05 11:36:03 +01:00
Carlton Gibson
16f5d42cbc
Add additional link to HTML & Forms topic page ( #4726 )
...
Just makes the topic page easier to find.
Closes #1673
2016-12-01 09:11:25 +00:00
Xavier Ordoquy
22578525ef
Documentation update ( #4717 )
2016-11-30 12:58:34 +00:00
Jeff Fein-Worton
a5c8a8c226
typo
2016-11-29 18:00:10 -08:00
Germán Larraín
aed8387e05
docs: Fix description of DecimalField
's max_digits
( #4714 )
...
As of PR #4377 , `max_digits=None` is allowed for `DecimalField`.
2016-11-29 15:35:43 +00:00
Xavier Ordoquy
1e0988686c
Update the Python doc links to use https and point to Python 3 ( #4713 )
2016-11-29 12:27:00 +00:00
Nik Nyby
abc62afddb
docs typo fix ( #4701 )
...
Remove unnecessary "a"
2016-11-24 09:39:18 +00:00
Nik Nyby
eaec60ae1d
docs: grammar fix - it's -> its ( #4698 )
2016-11-23 16:10:39 +00:00
Nik Nyby
a13b8d5560
docs: grammar fix
2016-11-23 10:13:03 -05:00
Vinay Anantharaman
8030f5b74f
Edit to the import in Setting filter backends
...
`django_filters` doesn't export `rest_framework` by default so it's required to import it.
2016-11-22 14:50:47 -08:00
Bruno Alla
0c02bbbfa7
Correct a small typo in exceptions documentation
2016-11-14 16:58:16 +00:00
Tom Christie
24791cb353
Invalidate any existing prefetch cache on PUT requests. ( #4668 )
2016-11-11 09:44:35 +00:00
Aaron Lelevier
0b9304014d
Add documentation link for single 'field-level validation' to the Validator docs page ( #3772 ) ( #4657 )
2016-11-07 11:30:46 +00:00
Carlos de la Torre
d55e176a1e
Fix documentation error: removed unused variable ( #4647 )
2016-11-02 14:03:53 +00:00
Josep Cugat
46f837a9d1
Fix APIException full_details() typo in documentation ( #4633 )
...
APIException has a get_full_details() method but the documentation refers to full_details().
2016-10-28 12:05:32 +01:00
Phil Krylov
72dc6d1d5c
Add drf-proxy-pagination
reference to Pagination docs
2016-10-23 04:36:36 +03:00
Mads Jensen
8ac524915c
added on_delete=models.CASCADE to models.ForeignKey in the documentation ( #4614 )
2016-10-22 16:37:23 +01:00
Tom Christie
3b9afb571b
Version 3.5.0 ( #4596 )
2016-10-20 16:25:40 +01:00
Tom Christie
2395fb5386
Deprecate DjangoFilter backend ( #4593 )
...
Deprecate the built-in `rest_framework.filters.DjangoFilterBackend` in favour of the third-party `django_filters.rest_framework.DjangoFilterBackend`.
2016-10-20 10:47:09 +01:00
Alex Poleha
a83997e1ed
Removed incorrect line from generic-views.md ( #4583 )
2016-10-14 11:29:48 +01:00
Tom Christie
a3802504a0
Error codes ( #4550 )
...
Add error codes to `APIException`
2016-10-11 10:25:21 +01:00
Steven Johns
072d14c2e1
Corrected artist
and album_name
...
`The Roots` are the band: https://en.wikipedia.org/wiki/The_Roots
`Undun` is their album: https://en.wikipedia.org/wiki/Undun
2016-10-11 11:20:48 +11:00
Tom Christie
0dec36eb41
Version 3.5 ( #4525 )
...
* Start test case
* Added 'requests' test client
* Address typos
* Graceful fallback if requests is not installed.
* Add cookie support
* Tests for auth and CSRF
* Py3 compat
* py3 compat
* py3 compat
* Add get_requests_client
* Added SchemaGenerator.should_include_link
* add settings for html cutoff on related fields
* Router doesn't work if prefix is blank, though project urls.py handles prefix
* Fix Django 1.10 to-many deprecation
* Add django.core.urlresolvers compatibility
* Update django-filter & django-guardian
* Check for empty router prefix; adjust URL accordingly
It's easiest to fix this issue after we have made the regex. To try
to fix it before would require doing something different for List vs
Detail, which means we'd have to know which type of url we're
constructing before acting accordingly.
* Fix misc django deprecations
* Use TOC extension instead of header
* Fix deprecations for py3k
* Add py3k compatibility to is_simple_callable
* Add is_simple_callable tests
* Drop python 3.2 support (EOL, Dropped by Django)
* schema_renderers= should *set* the renderers, not append to them.
* API client (#4424 )
* Fix release notes
* Add note about 'User account is disabled.' vs 'Unable to log in'
* Clean up schema generation (#4527 )
* Handle multiple methods on custom action (#4529 )
* RequestsClient, CoreAPIClient
* exclude_from_schema
* Added 'get_schema_view()' shortcut
* Added schema descriptions
* Better descriptions for schemas
* Add type annotation to schema generation
* Coerce schema 'pk' in path to actual field name
* Deprecations move into assertion errors
* Use get_schema_view in tests
* Updte CoreJSON media type
* Handle schema structure correctly when path prefixs exist. Closes #4401
* Add PendingDeprecation to Router schema generation.
* Added SCHEMA_COERCE_PATH_PK and SCHEMA_COERCE_METHOD_NAMES
* Renamed and documented 'get_schema_fields' interface.
2016-10-10 13:03:46 +01:00
Manjit Kumar
d49e26f127
add drf-url-filters in third party filtering resources and fixed typo ( #4548 )
2016-10-10 12:35:38 +01:00
Rowan Seymour
883efbc19f
Case insensitive uniqueness validation ( #4534 )
2016-10-04 13:44:50 +01:00
Danilo Bargen
1b882f7281
Add drf-dynamic-fields to third party packages ( #4530 )
2016-09-30 17:06:36 +01:00
Manjit Kumar
73fd1ff4e7
add drf-url-filters app to django-rest-framework in filtering docs ( #4528 )
...
- enabling validtions on incoming query params with the ease of adding new filters as easy as adding a new key in a dict.
2016-09-30 12:02:23 +01:00
Tom Christie
e7fd166048
Docs tweaks
2016-09-29 21:29:21 +01:00
Jozef Knaperek
76cc2f0319
Rename an invalid reference to BasicToken in the docs
2016-09-19 21:52:06 +02:00
Jeff Willette
a68b37d8bc
Update to correct location of reverse relation doc ( #4481 )
2016-09-13 09:31:48 +01:00
Xavier Ordoquy
e91ffc87cb
Ignore empty args in the MultipleFieldLookupMixin
definition - Closes #4484
2016-09-13 07:21:10 +02:00
Jakub Moliński
80bd3b9722
[documentation] Throttling random request code example fix ( #4451 )
2016-08-30 10:37:48 +01:00
Robert Jensen
59ca61abcd
Add django-rest-framework-roles to third party packages in permissions docs ( #4417 )
2016-08-19 11:44:31 +01:00
Wim Glenn
0a48d21e09
fix a b0rked code example in the permissions section of api guide
2016-08-12 14:33:35 -05:00
Kyle Hornberg
3698d9ea2e
Update permissions.md ( #4381 )
2016-08-10 17:23:10 +01:00
Daniel Hahler
378b04eeaa
Fix handling of ALLOWED_VERSIONS and no DEFAULT_VERSION ( #4370 )
...
When only `ALLOWED_VERSIONS` but no `DEFAULT_VERSION` is specified, a
version should be enforced.
2016-08-10 15:19:56 +01:00
Tom Christie
febaa4db00
Add import in docs. [ci skip]
2016-08-08 09:28:15 +01:00
Marlon
672e5a0f96
Fix minor typo
2016-08-05 11:57:43 -07:00
Corentin Smith
54096dc22f
Add imports in validators docs ( #4355 )
2016-08-04 22:06:35 +01:00
Tom Christie
e37619f741
Serializer defaults should not be included in partial updates. ( #4346 )
...
Serializer default values should not be included in partial updates
2016-08-02 13:05:12 +01:00
Jaap Roes
5b071ab35e
Remove note about Django 1.3 ( #4334 )
...
Remove note about Django 1.3
2016-08-01 12:05:47 +01:00
Tom Christie
e407dc7f01
Added root_renderers argument ( #4323 )
2016-07-28 12:50:51 +01:00
Tom Christie
306726d9e8
Improve datetime format docs ( #4322 )
2016-07-28 12:25:21 +01:00
Tom Christie
061e0ed084
Added url and schema_url arguments ( #4321 )
2016-07-28 12:08:34 +01:00
Tom Christie
351e0a4a99
Fix json indent parameter. Closes #4281 ( #4313 )
2016-07-27 11:49:01 +01:00
Tom Christie
19b415ec25
Improve pagination docs. Refs #4304 [ci skip]
2016-07-26 16:45:27 +01:00
Gustavo Pantuza
da2ff1bc4a
Adding support for RFC 4918 status codes ( #4291 )
...
* Added HTTP status codes from RFC 4918
* Updated documentation about status codes
* Added reference to RFC 4918
2016-07-26 11:09:12 +01:00
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
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
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