Tom Christie
0e3bc2b1e0
Throttling disclaimer ( #8403 )
...
* Throttling disclaimer
* Expand throttling disclaimer.
2022-03-11 10:58:59 +00:00
Timothy Allen
a53e523f93
We've renamed the drf-renderer-xlsx package to drf-excel. ( #8396 )
2022-03-08 10:39:16 +00:00
Josh
efc7c1d664
Update accepted_media_type argument in Renderer docs ( #8364 )
2022-02-12 16:21:59 +00:00
Shivendra Pratap Kushwaha
94eb804abe
Update filtering.md ( #8331 )
2022-01-17 09:41:23 +00:00
kaushik kothiya
5b2abbed25
Correct variable name ( #8306 )
...
urlpatterns name variable name in space remove.
2021-12-22 15:17:57 +00:00
Guilouf
45082b3936
Fixed missing "fields" meta argument in docs ( #8243 )
...
* Fixed missing "fields" meta argument in docs, leading to an assertion error
* Update docs/api-guide/serializers.md
Co-authored-by: Tom Christie <tom@tomchristie.com>
Co-authored-by: Tom Christie <tom@tomchristie.com>
2021-12-17 15:20:14 +00:00
Abhineet
f3bb5b9cdc
Add missing commas in pagination response samples ( #8185 )
2021-12-13 14:04:04 +00:00
Matthew Pull
3a762d9aac
Update permissions.md ( #8260 )
...
I might just be misunderstanding something (always a strong possibility!), but it seems to me that the table on the Permissions page is slightly inaccurate.
For `permission_classes`, wouldn't it have global-level permissions for list actions (rather than no permission control, as is currently listed)?
2021-12-08 14:35:06 +00:00
Jeremy Langley
37b73ef46e
IsAdmin permissions changed to IsAdminUser ( #8227 )
...
Documentation change to keep up with the code permission changes.
Co-authored-by: Jeremy Langley <jlangley2code@gmail.com>
2021-12-08 14:33:41 +00:00
Yecine Megdiche
380ac8e79d
Remove old-style super calls ( #8226 )
2021-12-06 15:32:33 +00:00
Anton Burnashev
060a3b632f
Docs: fix broken link ( #8245 )
2021-11-10 16:31:15 +00:00
Sébastien Lavoie
781890b7df
docs(api-guide-testing): Fix typo 'CRSF' and plural of word ( #8238 )
2021-11-08 09:59:32 +00:00
Uzair Ali
ddc5cd7e4b
Imported Response ( #8207 )
2021-10-07 15:52:44 +01:00
Edmund
53a0585dac
Update permissions.md to fix garden path sentences ( #8206 )
2021-10-07 09:09:00 +01:00
thetarby
6ea95b6ad1
Highlight select_related and prefetch_related usage in documentation ( #7610 )
...
* docs updated to highlight use of select_related and prefetch related to avoid n+1 problems
* Apply suggestions from code review
cosmetic changes
Co-authored-by: Xavier Ordoquy <xordoquy@linovia.com>
* cosmetic changes
Co-authored-by: Xavier Ordoquy <xordoquy@linovia.com>
2021-10-05 15:33:55 +01:00
Akhil Kokani
1fa5bc31c0
Update serializers.md ( #8189 )
...
* Update serializers.md
Removed unwanted word, "neither".
* Update docs/api-guide/serializers.md
Co-authored-by: Tom Christie <tom@tomchristie.com>
2021-09-27 10:01:47 +01:00
Carlton Gibson
f651878df3
Adjusted DateTimeField docs for zoneinfo.
2021-09-22 10:23:46 +02:00
Dan Lousqui
f0a5b958a1
Add max_length and min_length options to ListSerializer ( #8165 )
2021-09-14 13:45:55 +01:00
Ryan Nowakowski
4632b5daae
Fix subtitle of schemas for filtering ( #8145 )
...
Fix a likely copy/paste error
2021-08-31 14:18:49 +01:00
Aditya Mitra
6b392a46ea
[FIX] Typo in api-guide/authentication ( #8144 )
2021-08-31 13:57:02 +01:00
Mark
c5d9144aef
fix typo ( #8122 )
...
Co-authored-by: mgold <mgold@iponweb.net>
2021-08-11 11:30:09 +01:00
Ma77heus
2942590ee3
fix: broken cite ( #8086 )
...
Co-authored-by: MattheusHenrique <mattheushenrique@gmail.com>
2021-08-06 16:39:58 +01:00
Nikita Sobolev
d2977cff98
Fixes inconsistent headers in serializer docs ( #8056 )
...
Some headers were using `.`, some - were not.
Now, all of them are the same with `.`, because it was easier to fix.
2021-06-28 13:07:41 +01:00
Burak Kadir Er
c8a9c856c2
fix a small typo ( #8060 )
2021-06-28 12:51:21 +01:00
Abduaziz
9d149f2317
Fixed some punctuation marks & small typos ( #8015 )
2021-06-02 10:02:11 +01:00
Ishu Kumar
3875d3284e
Punctuations and missing "to" preposition ( #7966 )
...
Changes made in lines 221, 222, 223, and 224 for better readability.
2021-05-10 12:26:26 +01:00
Julien Palard
a0083f7f98
FIX: Broken cite. ( #7951 )
2021-04-26 09:30:41 +01:00
Denis Orehovsky
8812394ed8
Add distinction between request and response serializers for OpenAPI ( #7424 )
...
* Add distinction between request and response serializers
* Add docs
* document new functions in schemas.md
* add a test case for different request vs response objects
* Correct formatting for flake8
Co-authored-by: Shaun Gosse <shaun.gosse@emburse.com>
2021-04-20 15:03:16 +01:00
Joe Michelini
71e6c30034
update SerializerMethodField example in docs ( #7858 )
...
* update SerializerMethodField example
* fix formatting
2021-03-22 12:08:19 +00:00
Hasan Talha Yazıcı
0cddf097ca
Fix typo in docs ( #7853 )
2021-03-21 09:53:09 +00:00
Yuekui
a40bce50cd
No need to explictitly set None as default ( #7373 )
2021-03-16 13:29:13 +00:00
Henryk Plötz
ff625ecff5
Document object level permissions gotchas ( #7446 )
...
* Document the limitation that object level permissions do not apply to object creation. See for example #6409 .
* Add overview of three different ways to restrict access
2021-03-15 10:28:45 +00:00
Feanil Patel
c78f992176
Make the doc on overriding the default permission classes more clear. ( #7661 )
2021-03-10 12:44:17 +00:00
Eshaan Bansal
4f3cd8c7b0
add django-rest-durin to 3rd party auth libs [docs] ( #7615 )
...
Co-authored-by: Tom Christie <tom@tomchristie.com>
2021-03-10 12:40:45 +00:00
Celia Oakley
747fef6134
Add django-rest-authemail to Third Party Packages ( #7679 )
...
* Add django-rest-authemail to Authentication
* Add django-rest-authemail to Third Party Packages
2021-03-09 11:51:52 +00:00
Chris Guo
82b8a64a02
docs: add example for caching ( #7118 )
2021-03-09 11:49:19 +00:00
Alex Cotsarelis
e32ebc4199
Docs: DjangoModelPermissions works on views with get_queryset() method. ( #7693 )
...
Sentinel querysets not needed after v3.1.2
2021-03-08 12:09:17 +00:00
arcanemachine
ef112f5017
Provide example for dict in ValidationError detail ( #7788 )
...
Added a sentence describing the use of a dictionary as the `detail` argument of a ValidationError, and how it can be used to add field-level errors during object-level validation.
2021-03-08 11:46:35 +00:00
Usoof Mansoor
8f6d2d2f9c
Update docs link to Django OAuth Toolkit. ( #7737 )
2021-03-02 08:26:31 +01:00
Adrian Coveney
3db8877889
Clarify documentation for TemplateHTMLRenderer
...
Clarify that the response from a view may need to be modified to provide TemplateHTMLRenderer with a dict for it to use.
2020-12-30 09:11:38 +01:00
Erwin Junge
bb133522ef
Small documentation fix
2020-11-22 12:21:30 +01:00
babaroga
3ab8d4706e
changed unicode to str
2020-11-21 18:25:55 +01:00
Karol Onyśko
96993d817a
Changed url to django docs so it points to the stable version ( #7628 )
...
Co-authored-by: Karol Onyśko <karol.onysko@cic.com>
2020-11-12 18:42:42 +01:00
Georg Lukas
6da94e5700
docs: outline the difference between JSON and form parsers. Fix #7633
2020-11-12 09:48:18 +01:00
bhealy-indeed
80444a0afb
nit: Typo fix ( #7629 )
2020-11-05 22:21:30 +01:00
Megan Gross
606df83885
Update throttling.md ( #7606 )
...
There were recent updates to the `@action` decorator calling a little more attention to the kwargs it accepts.
I thought it would be useful to also provide an example in the throttling section of how those kwargs can be used to define/override throttle_classes through the action decorator as well.
2020-11-05 09:43:45 +01:00
James S Blachly, MD
56e4508123
Fix #7612 ( #7622 )
2020-11-02 09:45:43 +01:00
Pawel
95f0b0867a
Documentation: improve the action decorator documentation ( #7316 ) ( #7380 )
...
* Documentation: improve the action decorator documentation (#7316 )
2020-10-13 08:32:38 +02:00
Adam Johnson
fd5e1a745a
Fixed some documentation headings to use a space ( #7364 )
2020-10-10 17:42:59 +01:00
zach valenta
ffde169102
Add docs link to to_internal_value() ( #7476 )
2020-10-10 17:36:15 +01:00
Thomas Riccardi
1ef192811c
Add missing quoting for data keyword argument in serializer doc ( #7587 )
2020-10-10 17:34:39 +01:00
Mopsan
5e23b559f8
Fix example override of SchemaGenerator.get_schema()
2020-10-09 09:38:11 +01:00
Борис Верховский
98761e4ebb
Correct indentation
2020-09-16 09:43:27 -04:00
johnthagen
e17779c47b
Make it more clear to add django_filters to INSTALLED_APPS in docs. ( #7535 )
2020-09-14 19:46:51 +02:00
Mohammad Amin Haghpanah
04f39c42ee
Add drf-psq package to docs ( #7451 )
...
* Add drf-psq to third party packages
* Add drf-psq to permissions.md
this package is an extension that gives support for having action-based **permission_classes**, **serializer_class**, and **queryset** dependent on permission-based rules.
Co-authored-by: Salar Nasiri <salarnasiri@users.noreply.github.com>
2020-09-09 08:54:05 +01:00
Adam Johnson
410575dace
Replace all url() calls with path() or re_path() ( #7512 )
...
* url() is deprecated in Django 3.1
* update given feedbacks on url() is deprecated in Django 3.1
* Fix test_urlpatterns.py to continue testing mixed re_path() and path()
* Fix one missed reference
Co-authored-by: sanjusci <sanju.sci9@gmail.com>
2020-09-08 15:32:27 +01:00
johnthagen
7f3a3557a0
Add drf_ujson2 reference ( #7494 )
2020-08-25 15:15:17 -07:00
Борис Верховский
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
