Борис Верховский
374c0d4142
Punctuation fix ( #7488 )
...
* Punctuation fix
* more punctuation
2020-08-20 13:23:59 +01:00
Masked Man
17f2b39bdb
Fix docs issue ( #7418 )
2020-08-05 15:33:30 -07:00
Paul Watts
559088463b
Update an example to not use oppressive language ( #7439 )
...
* Update an example to use less oppressive language
For reference: https://tools.ietf.org/id/draft-knodel-terminology-00.html
* Code review update
Blocklisted -> blocked.
2020-07-29 20:21:13 +01:00
Oğuzhan Çelikarslan
36bd1b30d8
drf-encrypt-content added into third party list in documentation's serializer page ( #7398 )
2020-07-06 11:56:46 +01:00
Ngô Thanh Lợi (Leonn)
19915d1917
Fix docs typo ( #7387 )
2020-06-22 14:24:50 -07:00
Carlton Gibson
e18e40d6ae
Updated Schema docs. ( #7268 )
2020-06-16 13:33:48 +02:00
Rignon Noël
b677b7b15d
Update link to dry-rest-permissions ( #7374 )
...
dry-rest-permissions was no maintain since 2018, so FJNR-inc just got a new PyPi version on their fork
2020-06-11 18:33:04 +01:00
Nikhil Kumar
9dc7021770
Fixed h4 rendering
2020-06-01 14:03:10 -04:00
Nikhil Kumar
505a69cf43
Fixed heading markdown
2020-06-01 13:49:43 -04:00
johnthagen
fccfdd21c0
Remove object inheritance in docs ( #7332 )
2020-05-13 17:54:46 -07:00
Derek
00e6079e94
Nginx basic auth tutorial moved ( #7324 )
2020-05-11 16:29:31 +01:00
Sardorbek Imomaliev
46be2ffd34
Fix schema endpoint example ( #7178 )
...
* Fix schema endpoint example
Endpoint `schema` collides with `schema` class variable `schema` which is use for specification generation
* Update metadata.md
Co-authored-by: Tom Christie <tom@tomchristie.com>
2020-05-05 14:04:35 +01:00
Mathieu Pillard
d7777ea10f
Pass custom code to PermissionDenied if permission class had one set ( #7306 )
2020-05-01 10:22:36 +01:00
ADimeo
4349ce1a54
Fix broken documentation link ( #7305 )
2020-04-30 13:14:27 +01:00
Victor Mireyev
3eef5f47f3
Fix typo in links ( #7289 )
...
Reference-style link should be enclosed in square brackets. Otherwise it is treated as an inline-style link.
2020-04-24 22:38:01 -04:00
Victor Mireyev
26cd52a461
Fix markdown lists formatting. ( #7288 )
2020-04-24 15:17:35 +01:00
Matthaus Woolard
812f254bbd
SearchFilter to support JSONField and HStoreField ( #7121 )
...
* SearchFilter to support Custom query Transforms
Since Some fields support `__` as a custom Transform for query lookups we needed to update the m2m checking code to handle search_fields that contain __ that are not relationships.
* Update documentation on SearchFilter to include references to JSON and HStore Fields.
2020-04-23 09:38:14 +01:00
Tasawar Hussain
8cba4f87ca
Updates Ruby on Rails reference link ( #7269 )
...
The cited sentences are from actually the action controller docs from ruby on rails
2020-04-13 03:58:51 +01:00
tsurutan
0c8eb91737
Fixed docs' custom render example. ( #7171 )
2020-04-06 17:09:23 +02:00
Mahmoud Adel
8b5d3437f9
Add django-rest-auth fork to docs ( #7227 )
2020-03-17 15:45:45 -07:00
0dysseas
be96939ec1
Fix serializer example in docs ( #7233 )
2020-03-17 09:49:19 -07:00
Martin Desrumaux
6a23fa0649
OpenAPI: Make operationId camelCase, matching spec examples. ( #7208 )
2020-03-03 17:51:51 +01:00
Martin Desrumaux
8aa8be7653
Implement OpenAPI Components ( #7124 )
2020-03-02 19:35:27 +01:00
Martin Desrumaux
5b16a17242
OpenAPI: Allow customizing operation name. ( #7190 )
2020-03-02 16:40:18 +01:00
Dhaval Mehta
2a5c2f3f70
Added OpenAPI tags to schemas. ( #7184 )
2020-02-28 12:06:03 +01:00
Samuel Dion-Girardeau
e32ffbb12b
Fix docs code example ( #7201 )
2020-02-24 16:33:00 -08:00
Prayash Mohapatra
764dabd29e
Update writeable nested serializer doc ( #7198 )
2020-02-20 10:55:13 +00:00
Yoo In Keun
4faa674196
Fixed docs typo. ( #7188 )
2020-02-19 20:16:42 +01:00
Dalei
39dd34f161
Update docs for OpenAPI ( #6814 ) ( #7191 )
2020-02-19 11:56:12 +00:00
Thorsten
f81ca78642
Add file option to generateschema ( #7130 )
2020-02-12 20:35:54 +01:00
Danny
442a206502
Fix full-text search docs ( #7133 )
2020-01-10 22:38:29 -08:00
Ran Benita
d985c7cbb9
Remove a few no longer needed compat checks and references ( #7092 )
...
* serializers: removes no longer needed compat checks
UUIDField and DurationField are both supported in all supported Django
versions.
IPAddressField was removed in Django 1.9, which is no longer supported.
* serializers: move related code closer together
This way it's easier to see all of the mappings in one place.
* serializers,docs: remove some DRF 2.x references
The last release of DRF 2.x was 5 years ago, it seems fine to remove
these references now.
2019-12-16 18:59:25 +00:00
Tom Christie
070cff5a03
Drop set_context() ( #7062 )
...
* Do not persist the context in validators
Fixes encode/django-rest-framework#5760
* Drop set_context() in favour of 'requires_context = True'
2019-12-03 11:16:27 +00:00
Hendrik
a73d3c309f
Elaborated on nested relationships ( #7051 )
2019-11-18 12:35:36 +00:00
brantmorton
0d6589cf45
Updated url() with re_path() in Versioning docs. ( #7043 )
2019-11-07 13:20:56 +01:00
Yann Savary
0d3d548aa5
OpenAPI: Fixed generation when title or version not provided. ( #6912 )
2019-11-06 21:54:12 +01:00
Aaron Yong
14d740d088
Update DEFAULT_SCHEMA_CLASSES default value in Settings docs ( #7014 )
...
The default value was changed to point to the OpenAPI AutoSchema class. The docs were leading users to believe that rest_framework.schemas.AutoSchema was the default. As of this commit, the root AutoSchema is in fact imported from the coreapi module.
2019-11-06 21:37:13 +01:00
Erwan Rouchet
5e8fe6edf0
Fix link to Django docs ( #7040 )
2019-11-06 09:34:28 -08:00
Chris Guo
5521eacb02
Update docs imports ( #7030 )
2019-11-01 10:56:59 -07:00
Daniel Hnyk
ab40b80fa6
Remove unmaintained django-rest-framework-bulk from docs ( #7021 )
2019-10-28 03:46:44 -07:00
Chris Guo
5ee970c090
Fix docs typos ( #7015 )
2019-10-24 11:31:12 -07:00
Aaron Yong
4d57cd31f6
Update method override example in Schemas docs ( #6887 ) ( #7013 )
...
get_link() was a method in the old CoreAPI-based AutoSchema implementation. The new OpenAPI one defines get_operation() instead: the example code block was overlooked.
2019-10-24 08:54:37 +02:00
nautikos1235
65ed7be754
Fix markdown code indent in schemas ( #7009 )
2019-10-22 11:10:15 -07:00
Braden MacDonald
3aa1089a6a
Update serializer docs to use correct param name ( #6995 )
...
Avoids a pylint warning ".to_representation: Parameters differ from overridden 'to_representation' method" if people copy these examples.
2019-10-15 15:47:05 +01:00
Law Karingithi
0e4811e9ce
Fix minor grammatical errors in docs ( #6979 )
2019-10-08 09:38:14 -07:00
Ted Stoychev
60f9c12900
Fixed broken link in documentation ( #6937 )
2019-09-27 09:47:51 -07:00
napsterv
7a3b7d2001
Fixed method signature in docs ( #6931 )
2019-09-16 10:47:29 -07:00
Yann Savary
e57c1505fc
Replaced 'TODO' hardcoded version info by a parameter with default '0.1.0' ( #6899 )
2019-09-03 16:07:30 +02:00
Ryan P Kilby
bcf196d0ac
Remove outdated note about read_only+default ( #6847 )
2019-07-29 15:10:57 -07:00
Min ho Kim
0e1c5d3132
Fix typos ( #6835 )
2019-07-25 10:04:01 -07:00
Bary Levi
ea2ebf61cb
fix quote was outside of inline code ( #6830 )
2019-07-22 13:02:17 +01:00
linchiwei123
da1c6d4129
Fix indent ( #6825 )
2019-07-18 23:09:04 -07:00
Daniel Alvarez
316526d877
Fixes import in the schemas documentation
2019-07-16 21:32:19 +01:00
Tom Christie
908516f2bd
Fix pagination docs meta information
2019-07-15 20:14:59 +01:00
Ryan P Kilby
b26db12813
Update default settings to use lists instead of tuples ( #6799 )
...
* Update default settings from tuples to lists
* Add missing trailing commas
* Use single quotes for consistency
* Update settings lists in docs
2019-07-15 11:54:46 +01:00
Luke Plant
f0dbf0a264
Update docs to use lists instead of tuples ( #6797 )
2019-07-12 18:15:36 -07:00
Carlton Gibson
7915485c0d
Update docs for OpenAPI. ( #6668 )
...
* Update schema docs for OpenAPI
* Begin v3.10 Release Announcement.
* Update docs/topics/documenting-your-api.md
Co-Authored-By: Martin Pajuste <pajusmar@users.noreply.github.com>
* Update docs/topics/documenting-your-api.md
Co-Authored-By: Martin Pajuste <pajusmar@users.noreply.github.com>
* Update docs/topics/documenting-your-api.md
Co-Authored-By: Martin Pajuste <pajusmar@users.noreply.github.com>
* Update docs/topics/documenting-your-api.md
Co-Authored-By: Martin Pajuste <pajusmar@users.noreply.github.com>
2019-07-08 13:09:05 +01:00
Tom Christie
cc88c8a6f3
Update serializers.md
2019-07-08 11:12:30 +01:00
linchiwei123
372f4fde20
Update pagination.md ( #6787 )
...
it seems like that
2019-07-05 22:30:01 -07:00
linchiwei123
373195996e
Update fields.md ( #6784 )
...
Example ==> Example
2019-07-05 14:24:52 +01:00
linchiwei123
8fbf8c3fa3
Update serializers.md ( #6783 )
2019-07-05 09:11:20 +01:00
johnthagen
989aeca205
Add link to django-filter on first reference ( #6777 )
2019-07-03 10:43:30 -07:00
Ryan P Kilby
280014fe37
Update docs for pagination settings ( #6772 )
2019-07-02 12:09:45 +01:00
Ryan P Kilby
82c2b5c3e7
Update mkdocs ( #6769 )
2019-06-30 19:04:36 -07:00
Jon Besga
9a429a1c2e
Fix custom authentication example ( #6640 )
2019-06-30 17:55:54 -07:00
Ryan P Kilby
df1d146ee7
Remove old documentation ( #6765 )
2019-06-28 16:03:00 -07:00
Florimond Manca
af2a2e6010
Update description and link to djangorestframework-api-key ( #6764 )
2019-06-28 15:40:31 -07:00
bonohubby
f76480a127
Fix typo in docs ( #6757 )
2019-06-25 10:08:46 +01:00
Robert Singer
80e89c75c7
Add DRF Access Policy to 3rd party packages ( #6723 )
2019-06-23 13:18:08 -07:00
Min ho Kim
72de94a05d
Fix typos in docs ( #6747 )
2019-06-18 12:58:01 -07:00
Ryan P Kilby
9ac9c1b2ea
Update status code docs ( #6732 )
2019-06-05 17:51:50 -07:00
Timothy Allen
8430f3e5b6
Fix typo in github.com URL. ( #6720 )
2019-05-30 12:23:37 -07:00
Raffaele Salmaso
514033815d
Allow JSONField encoder customization. ( #6713 )
2019-05-24 12:47:35 +01:00
gaetano-guerriero
a7c577cb31
Dict field allow empty ( #6583 )
...
* dict field: support allow_empty option
* document ListField allow_empty option
* document HStoreField allow_empty parameter
2019-05-09 09:18:20 +01:00
Andreu Vallbona Plazas
be5a9f78f3
Added note on serializing extra fields from Through Model ( #6652 )
...
* adding small clarification on ManyToManyFields with a Through Model
As pointed here: https://github.com/encode/django-rest-framework/pull/6585#issuecomment-490145334 I suggest to add the small clarification to work with **ManyToManyFields with a Through Model**.
* Remove blank line.
2019-05-07 20:01:24 +02:00
vu3jej
1c976f2ac8
Fix typo in docs ( #6628 )
2019-05-01 15:24:38 -07:00
Jon Dufresne
059947028b
Update docs on django-oauth-toolkit ( #6618 )
...
Since django-oauth-toolkit 1.2.0 (2018-06-03), the package requires
Python 3.4+.
https://github.com/jazzband/django-oauth-toolkit/blob/master/CHANGELOG.md#120-2018-06-03
2019-05-01 07:52:26 +02:00
Carlton Gibson
0407a0df8a
Dropped Python 2 compatibility. ( #6615 )
...
Thanks to Jon Dufresne (@jdufresne) for review.
Co-authored-by: Asif Saif Uddin <auvipy@gmail.com>
Co-authored-by: Rizwan Mansuri <Rizwan@webbyfox.com>
2019-04-30 17:53:44 +02:00
Jithesh Eriyakkadan Janardhanan
908236a576
Correct misspelled class name
2019-04-30 18:01:17 +05:30
David Sanders
95e28b2252
Fix typo in docs
2019-04-27 12:07:49 -07:00
Dmitry Alimov
1ac0f63aa9
Fix private attributes ignore in documentation ( #6601 )
2019-04-21 17:27:13 +01:00
Billy Rotich
f8c4e5079e
Minor documentation fixes ( #6581 )
2019-04-13 15:02:19 +02:00
Matt Hegarty
f34a0a4e6a
Minor documentation fixes ( #6543 )
2019-03-28 23:32:25 -07:00
Jabi
ac19c69539
Corrected typo in permissions docs. ( #6540 )
2019-03-28 11:45:13 +01:00
Ryan Siemens
d2d1888217
Document DateTimeField default_timezone argument ( #6469 )
2019-03-12 21:15:12 -07:00
SrdjanCosicPrica
ac7b20cca2
Fix get_search_fields example ( #6487 )
2019-03-04 14:46:14 +01:00
Carlton Gibson
31bf597081
Updated note on BooleanField required kwarg generation.
...
Closes #6474 .
2019-03-01 12:48:12 +01:00
Ramon de Jezus
1dc81acb4d
Fixed a typo in pagination docs. ( #6475 )
2019-02-28 15:18:58 +01:00
Adrien Brunet
2daf6f1341
Add negation ~ operator to permissions composition ( #6361 )
2019-02-25 15:33:40 +01:00
Ryan P Kilby
286cf57a8d
Update filtering docs ( #6467 )
2019-02-22 10:58:01 -08:00
Allan Reyes
d110454d4c
Added SearchFilter.get_search_fields() hook. ( #6279 )
2019-02-19 17:18:14 +01:00
Carlton Gibson
6de33effd6
Doc’d requirement to implement has_object_permission() ( #6462 )
...
…when using provided permission classes.
Closes #6402 .
2019-02-19 16:18:55 +01:00
Michael Käufl
f9401f5ff0
Fix Python 3 compat in documentation
2019-02-16 15:47:13 +01:00
johnthagen
9f66fc9a7c
Fix typo in caching docs
2019-02-13 19:00:16 -05:00
Tanner Prestegard
abf07e672e
Fix throttling documentation for specifying alternate caches ( #6446 )
2019-02-06 21:26:09 +01:00
carlfarrington
3c5c61f33b
fix for a couple of missing words ( #6444 )
2019-02-06 09:35:04 +00:00
jhtimmins
7c6e34c14f
Fix typo: 'what' to 'that' ( #6437 )
2019-02-02 14:49:58 +01:00
Daniel Roseman
7310411533
Updated example models to use __str__ in relations docs. ( #6433 )
2019-02-01 19:50:27 +01:00
Marcin Popławski
4c2af75957
Updated links to djangorestframework-api-key project. ( #6414 )
2019-01-24 16:10:11 +01:00
Carlton Gibson
0ac20a3d8e
Updated filtering docs to use filterset_fields. ( #6415 )
...
Closes #6411 .
2019-01-21 21:00:54 +01:00
