Tom Christie
c05998f5dd
Add CryptAPI to docs homepage
2021-12-08 15:11:55 +00:00
Tom Christie
6e0cb8a7aa
Add CryptAPI sponsorship ( #8283 )
2021-12-08 14:53:06 +00:00
Chen Wen Kang
47ee3fc9a9
Update docs related to coreapi to include deprecation notice ( #8186 )
...
* Update docs related to coreapi to include deprecation notice
* Update docs to use reference to version 3.10 release notes instead of 3.9
2021-12-08 14:38:42 +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
Jaap Roes
dabf2216c3
Update django-cors-headers links ( #8176 )
2021-12-08 14:30:34 +00:00
Yecine Megdiche
380ac8e79d
Remove old-style super calls ( #8226 )
2021-12-06 15:32:33 +00:00
Dmytro Litvinov
0d5250cffa
Fix link to installation of httpie ( #8257 )
...
Right now httpie moved to "httpie" organization (https://github.com/httpie/httpie ) and they don't have "installation" at their GitHub. Instead of that, they have "Getting started" section with link to "Installation instructions".
2021-11-15 08:54:19 +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
rgermain
00cd4ef864
add third packages nested-multipart-parser ( #8208 )
2021-10-15 15:13:20 +01: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
Phil Leggetter
605a624da6
Add PostHog as premium sponsors ( #8193 )
...
* Add PostHog as premium sponsors
* Adding 275x250 PostHog image
2021-10-05 14:02:34 +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
Tom Christie
761f56ef40
Update stream.io link
2021-09-10 14:45:06 +01:00
Tom Christie
73f3325f80
Update stream.io link ( #8161 )
2021-09-10 11:32:27 +01:00
Tom Christie
9ce541e909
Revert "Fix arguments ( #7995 )" ( #8156 )
...
This reverts commit 9716b1b6b7
2021-09-06 12:19:20 +01:00
Ivan Trushin
9716b1b6b7
Fix arguments ( #7995 )
...
`path()` has no argument `namespace`, it has `name` argument
2021-09-06 12:18:13 +01:00
Anthony Randall
96001c5de6
Added an article - implementing rest apis with embedded privacy from doordash engineering blog ( #7956 )
...
* Update tutorials-and-resources.md
* Update tutorials-and-resources.md
2021-09-03 13:23:19 +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
jefcolbi
c927053d4b
Replacing django-rest-auth with dj-rest-auth ( #8146 )
2021-08-31 12:51:47 +01:00
Mark
c5d9144aef
fix typo ( #8122 )
...
Co-authored-by: mgold <mgold@iponweb.net>
2021-08-11 11:30:09 +01:00
juliangeissler
cdd53c7de9
Update Tutorial - Relationships & Hyperlinked APIs ( #7950 )
...
unnecessary import, because it is already added in the previous section
2021-08-08 14:45:00 +01:00
Ben Hampson
e95e91ccf2
Use correct link for httpie ( #8005 )
...
Before it was linking to a fork of a fork of httpie. I've changed it to the right URL.
2021-08-06 16:49:41 +01:00
Paul Wayper
c4404f3d5d
We now use Libera.chat rather than Freenode for IRC ( #8049 )
...
Signed-off-by: Paul Wayper <paulway@redhat.com>
Co-authored-by: Tom Christie <tom@tomchristie.com>
2021-08-06 16:46:26 +01:00
Paul Wayper
cba24464e8
Botbot has been acquired, all paths now point to startupresources ( #8050 )
...
Signed-off-by: Paul Wayper <paulway@redhat.com>
2021-08-06 16:45:15 +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
Finn Gundlach
24a938abaa
Update documentation to include Django 3.2 as supported version ( #8037 )
2021-06-16 14:53:29 +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
Terence Honles
1c494e3d94
Update references to Travis CI after moving to Github Actions ( #7909 )
...
x-ref: https://github.com/encode/django-rest-framework/pull/7903
2021-04-12 13:14:26 +01:00
Lalit Suthar
9bdd6125a1
fix broken article link ( #7918 )
...
Co-authored-by: lalit97 <lalit.suthar@redhuntlabs.com>
2021-04-12 11:59:58 +01:00
Adam Johnson
37ef62b0e6
Remove link to third party cookiecutter template ( #7902 )
...
The template has not been maintained for six years, so it's out of date on versions and various "best practices" (e.g. pre-commit). I also think any template should be documented on its own repo rather than here, especially if it's not an official maintained project.
2021-04-05 18:18:35 +01:00
Adam Johnson
aa12a5f967
Lint with pre-commit ( #7900 )
...
Following [my comment here](https://github.com/encode/django-rest-framework/pull/7589#issuecomment-813301322 ) and [Django's own move to pre-commit](https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/#pre-commit-checks ).
* Add pre-commit config file to run flake8 and isort.
* Add extra "common sense" hooks.
* Run pre-commit on GitHub actions using the [official action](https://github.com/pre-commit/action/ ). This is a good way to get up-and-running but it would be better if we activated [pre-commit.ci](https://pre-commit.ci/ ), which is faster and will auto-update the hooks for us going forwards.
* Remove `runtests.py` code for running linting tools.
* Remove `runtests.py --fast` flag, since that would now just run `pytest -q`, which can be done with `runtests.py -q` instead.
* Remove tox configuration and requirements files for linting.
* Update the contributing guide to mention setting up pre-commit.
2021-04-05 12:08:52 +01:00
Tom Christie
f83620dcc9
Version 3.12.4 ( #7873 )
...
* Version 3.12.4
* Tweak release notes
2021-03-26 09:27:01 +00:00
Tom Christie
dffa612134
Fix release notes typo
2021-03-25 12:30:45 +00:00
Tom Christie
83ad265e13
Version 3.12.3 ( #7866 )
2021-03-25 12:23:23 +00:00
Joe Michelini
71e6c30034
update SerializerMethodField example in docs ( #7858 )
...
* update SerializerMethodField example
* fix formatting
2021-03-22 12:08:19 +00:00
Mohammad Ashraful Islam
7e3dd9cd1b
Added fast-drf as a thirdparty package for making API development faster. ( #7857 )
2021-03-22 12:07:48 +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
Jeff Baumes
b0ca248d88
Correct the use of "to" ( #7696 )
2021-03-16 12:57:04 +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
Ömer Faruk Abacı
883f6fe814
Rename django-extra-fields to drf-extra-fields ( #7833 )
2021-03-11 11:39:06 +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
John Alexis Munera
cef74d1726
Add rest-framework-actions to Third Party Packages ( #7688 )
...
This pull request adds rest-framework-actions to Third Party Packages, under Views
rest-framework-actions can be found on PyPi here: https://pypi.org/project/rest-framework-actions/
Co-authored-by: Tom Christie <tom@tomchristie.com>
2021-03-10 12:37:06 +00:00
PaulGilmartin
c69e2e4eaa
Add graphwrap to third-party-packages.md ( #7819 )
...
* Add graphwrap to third-party-packages documentation
* Fix typo in third party packages docs
* Remove additional newline
Co-authored-by: Paul Gilmartin <paulgilmartin@Pauls-MacBook-Pro.local>
Co-authored-by: Tom Christie <tom@tomchristie.com>
2021-03-10 09:02:38 +00:00
Romain Rigaux
750bad0a58
Actually use the loginUser arguments in the example ( #7714 )
2021-03-09 12:00:51 +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
Nathan Glover
a89a6427d3
#7703 adding deprecations to release notes ( #7716 )
...
* #7703 adding deprecations to release notes
* #7703 - update link for gh6687
2021-03-09 10:22:37 +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
Jean-Pierre Merx
234527959d
Have options example in documenting-your-api.md to return a Response ( #7639 )
...
It was returning data which is not correct. Closes #7638 .
Co-authored-by: Jean-Pierre Merx <jean-pierre.merx@aictivate.com>
2021-03-08 12:08:26 +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
Tom Christie
8351747d98
Update index.md
2020-12-21 16:41:12 +00: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
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
