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
Xavier Ordoquy
3578683a69
Merge pull request #7593 from encode/version-3.12.2
...
Version 3.12.2
2020-11-05 23:15:45 +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
Tom Christie
3799633cde
Version 3.12.2
2020-10-13 14:17:53 +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
Xavier Ordoquy
2e721cdbc8
Merge pull request #7436 from markstory/patch-1
...
Fix broken links in documenting API section
2020-10-06 22:26:22 +02:00
Xavier Ordoquy
fdf277a782
Merge pull request #6843 from max-wittig/patch-1
...
docs(tutorial): add missing permission import in viewsets
2020-10-06 21:42:30 +02:00
स्पर्श
6a45a6a36f
Fix broken machinalis links ( #7580 )
...
#7572 #7423 #7573 all are related to this
2020-10-06 13:14:11 +01:00
Xavier Ordoquy
d635bc9c71
Merge pull request #7539 from verhovsky/patch-2
...
Correct indentation
2020-10-06 13:04:08 +02:00
Xavier Ordoquy
9dc10d2af7
Merge pull request #7577 from Exifers/patch-1
...
Documentation: use retrieve instead of read for Viewset
2020-10-05 21:54:33 +02:00
Xavier Ordoquy
a849627f88
Fixes #7538 - use retrieve action name instead of detail
2020-10-05 21:48:07 +02:00
Emmanuel Meric de Bellefon
86ec3da2da
Update 6-viewsets-and-routers.md
2020-10-05 20:56:42 +02:00
Tom Christie
be87eb43b3
Update release notes with 3.11.1, 3.11.2
2020-09-30 09:44:31 +01:00
Ali Mirlou
9edd5dfe5d
Fix typo in release notes
2020-09-28 23:15:30 +03:30
Tom Christie
05b3865838
Version 3.12.1
2020-09-28 16:18:23 +01:00
Tom Christie
68b23075a2
Add date to 3.12 release.
2020-09-28 10:54:52 +01:00
Tom Christie
6f7aad8ffa
Placeholder for 3.12 release ( #7379 )
...
* Placeholder for 3.12 release
* Updating release notes
* Updating release notes
* Updating release notes
* Update release notes
* Fix typo
* Basic structure for release announcement
* 3.12 release notes
* Version 3.12.0
2020-09-28 10:47:50 +01:00
T. Franzel
c6e24521da
Add third-party schema library drf-spectacular to docs ( #7540 )
...
Co-authored-by: T. Franzel <13507857+tfranzel@users.noreply.github.com>
2020-09-21 11:39:35 +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
Rafael Henter
327cbef299
Add Django API Client to the third party packages ( #7440 )
2020-09-08 15:44:03 +01:00
Michael K
ddcd8b539b
Run tests against Python 3.9 ( #7517 )
...
3.9.0 final is expected on Monday, 2020-10-05
See https://www.python.org/dev/peps/pep-0596/#schedule
Also mention Django 3.1 compat where missing.
2020-09-08 15:40:21 +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
Vibhu Agarwal
3d708ac700
Fix broken docs link ( #7473 )
2020-08-11 16:36:23 -07:00
Masked Man
17f2b39bdb
Fix docs issue ( #7418 )
2020-08-05 15:33:30 -07:00
Tom Christie
7d5155e0eb
Resize sponsor images for new GitHub layout ( #7465 )
2020-08-05 14:13:01 +01: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
Mark Story
30ca04df83
Fix broken links in documenting API section
...
The changed links were not working on the documentation site. I'm not 100% sure that these changes are correct but they generate working links in the GitHub previews.
2020-07-29 09:58:53 -04:00
Tom Christie
c252c3dfa5
Update sponsors ( #7434 )
...
* Adjusted token admin to map to user ID.
Closes #6131 .
* Adds a proxy model for Token that uses the user.pk, rather than it's own.
* Adjusts Admin to map back from User ID to token instance.
* Update sponsors
Co-authored-by: Carlton Gibson <carlton.gibson@noumenal.es>
2020-07-29 14:55:10 +01:00
Anirudh Bagri
1e164c5eeb
Just smalling cleaning up, causing confusion ( #7426 )
2020-07-23 17:34:34 +02: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
w
7a04269209
Fixed docs typo ( #7382 )
2020-06-19 10:29:41 -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
Kamil Sampolski
f07f48a5da
Updating documentation / switching from url to path ( #7237 )
...
* Update README.md
We should use path instead of url in urlpatterns,
* Update index.md
We should use path instead of url in urlpatterns
* Update README.md
We should use path instead of url in urlpatterns
2020-05-11 11:01:00 +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
Santos Solorzano
256f076df2
Update index.md
...
- Dropped Django 1.11, 2.0, 2.1 support
2020-05-01 14:16:18 -07: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
Robert Singer
05a59095ce
Adds drf-typed-views to 3rd party packages ( #7293 )
2020-04-27 12:12:13 -07: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
Rotzbua
a7a362813b
Update optional dependencies list. ( #7243 )
...
Co-authored-by: Ryan P Kilby <kilbyr@gmail.com>
2020-04-06 15:54:30 +02:00
David Szotten
734c534dbb
update release note to include full message ( #7251 )
...
the truncation changes the meaning somewhat..
2020-03-31 14:53:33 +01:00
Artur Barseghyan
5cc6ace9c4
Update third-party-packages.md ( #7175 )
2020-03-20 11:28:51 -07: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
Tom Christie
ddfb9672ae
Release notes for 3.11.0 ( #7214 )
2020-03-04 13:31:43 +00: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
Ryan P Kilby
92a4a5d423
Fix docs 404 ( #7197 )
...
* Use 'site_url' instead of hardcoding DRF homepage
* Use 'url' template filter instead of 'base_url'
This fixes static file loading for the 404 page.
* Only insert funding <hr> if toc is present
* Link quickstart to valid API guide page
* Fix 404 search modal link
* Use 'base_url' instead of 'site_url' on 404 page
2020-02-20 10:23:06 +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
William S. Vincent
d21b8eb084
update Django for APIs book to 3.0 edition ( #7164 )
2020-01-28 14:05:32 +00:00
Jonathan Longe
62193e0378
Add permissions to quickstart tutorial ( #7113 )
2020-01-15 11:58:31 -08:00
Danny
442a206502
Fix full-text search docs ( #7133 )
2020-01-10 22:38:29 -08:00
phankiewicz
a9e55334e7
Add X-CSRFToken HTTP header in swagger-ui example ( #6968 )
2020-01-03 13:59:32 +00:00
Frederico Lima
25ac7ba450
Add third party lib drf-viewset-profiler ( #6993 )
2020-01-03 13:53:09 +00:00
Bart
07376f128c
Grammar fix ( #6933 )
2020-01-03 13:36:43 +00:00
Jihoon Park
f3ed69374d
Add missing punctuation marks and URL name ( #7108 )
...
- trailing commas (as both Python and JavaScript allow them)
- trailing semicolons in JavaScript
- URL name `api-docs`
2020-01-03 13:28:35 +00: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
de497a9bf1
Version 3.11 ( #7083 )
...
* Version 3.11
* Added notes on OpenAPI changes for 3.11.
* Minor docs tweaking
* Update package version and supported versions
* Use a lazy import for django.test.client.encode_mutlipart. Closes #7078
2019-12-12 14:31:40 +00:00
Kye Russell
dff9759555
Removed Eric S. Raymond quote from the release notes ( #7073 )
2019-12-04 09:29:01 +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
Thomas Loiret
adaf97a739
Remove the old reference to JSONResponse
2019-11-20 14:09:49 +01:00
Hendrik
a73d3c309f
Elaborated on nested relationships ( #7051 )
2019-11-18 12:35:36 +00:00
CloudCode Hungary
6196e9c8cd
add djangorestframework-features to third-party ( #7052 )
2019-11-18 12:31:32 +00:00
James
323e1cddda
Cleanup "Documenting your API" 3rd party recommendations ( #7057 )
2019-11-15 18:39:47 -08: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
