encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-06-03 13:13:09 +03:00
Code Issues Packages Projects Releases Wiki Activity
8,821 Commits 15 Branches 133 Tags 107 MiB
a59aa2dfe1
Commit Graph

3003 Commits

Author SHA1 Message Date
Matthew Pull
3a762d9aac
Update permissions.md () 
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 () 
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 () 2021-12-08 14:30:34 +00:00
Yecine Megdiche
380ac8e79d
Remove old-style super calls () 2021-12-06 15:32:33 +00:00
Dmytro Litvinov
0d5250cffa
Fix link to installation of httpie () 
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 () 2021-11-10 16:31:15 +00:00
Sébastien Lavoie
781890b7df
docs(api-guide-testing): Fix typo 'CRSF' and plural of word () 2021-11-08 09:59:32 +00:00
rgermain
00cd4ef864
add third packages nested-multipart-parser () 2021-10-15 15:13:20 +01:00
Uzair Ali
ddc5cd7e4b
Imported Response () 2021-10-07 15:52:44 +01:00
Edmund
53a0585dac
Update permissions.md to fix garden path sentences () 2021-10-07 09:09:00 +01:00
thetarby
6ea95b6ad1
Highlight select_related and prefetch_related usage in documentation () 
* 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 () 
* Add PostHog as premium sponsors

* Adding 275x250 PostHog image
 2021-10-05 14:02:34 +01:00
Akhil Kokani
1fa5bc31c0
Update serializers.md () 
* 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 () 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 () 2021-09-10 11:32:27 +01:00
Tom Christie
9ce541e909
Revert "Fix arguments ()" () 
This reverts commit 9716b1b6b7.
 2021-09-06 12:19:20 +01:00
Ivan Trushin
9716b1b6b7
Fix arguments () 
`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 () 
* 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 () 
Fix a likely copy/paste error
 2021-08-31 14:18:49 +01:00
Aditya Mitra
6b392a46ea
[FIX] Typo in api-guide/authentication () 2021-08-31 13:57:02 +01:00
jefcolbi
c927053d4b
Replacing django-rest-auth with dj-rest-auth () 2021-08-31 12:51:47 +01:00
Mark
c5d9144aef
fix typo () 
Co-authored-by: mgold <mgold@iponweb.net>
 2021-08-11 11:30:09 +01:00
juliangeissler
cdd53c7de9
Update Tutorial - Relationships & Hyperlinked APIs () 
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 () 
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 () 
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 () 
Signed-off-by: Paul Wayper <paulway@redhat.com>
 2021-08-06 16:45:15 +01:00
Ma77heus
2942590ee3
fix: broken cite () 
Co-authored-by: MattheusHenrique <mattheushenrique@gmail.com>
 2021-08-06 16:39:58 +01:00
Nikita Sobolev
d2977cff98
Fixes inconsistent headers in serializer docs () 
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 () 2021-06-28 12:51:21 +01:00
Finn Gundlach
24a938abaa
Update documentation to include Django 3.2 as supported version () 2021-06-16 14:53:29 +01:00
Abduaziz
9d149f2317
Fixed some punctuation marks & small typos () 2021-06-02 10:02:11 +01:00
Ishu Kumar
3875d3284e
Punctuations and missing "to" preposition () 
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. () 2021-04-26 09:30:41 +01:00
Denis Orehovsky
8812394ed8
Add distinction between request and response serializers for OpenAPI () 
* 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 () 
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 () 
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 () 
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 () 
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 () 
* 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 () 2021-03-25 12:23:23 +00:00
Joe Michelini
71e6c30034
update SerializerMethodField example in docs () 
* 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. () 2021-03-22 12:07:48 +00:00
Hasan Talha Yazıcı
0cddf097ca
Fix typo in docs () 2021-03-21 09:53:09 +00:00
Yuekui
a40bce50cd
No need to explictitly set None as default () 2021-03-16 13:29:13 +00:00
Jeff Baumes
b0ca248d88
Correct the use of "to" () 2021-03-16 12:57:04 +00:00
Henryk Plötz
ff625ecff5
Document object level permissions gotchas () 
* Document the limitation that object level permissions do not apply to object creation. See for example .

* 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 () 2021-03-11 11:39:06 +00:00
Feanil Patel
c78f992176
Make the doc on overriding the default permission classes more clear. () 2021-03-10 12:44:17 +00:00
Eshaan Bansal
4f3cd8c7b0
add django-rest-durin to 3rd party auth libs [docs] () 
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 () 
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 () 
* 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 () 2021-03-09 12:00:51 +00:00
Celia Oakley
747fef6134
Add django-rest-authemail to Third Party Packages () 
* 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 () 2021-03-09 11:49:19 +00:00
Nathan Glover
a89a6427d3
adding deprecations to release notes () 
*  adding deprecations to release notes

*  - update link for gh6687
 2021-03-09 10:22:37 +00:00
Alex Cotsarelis
e32ebc4199
Docs: DjangoModelPermissions works on views with get_queryset() method. () 
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 () 
It was returning data which is not correct. Closes .

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 () 
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. () 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 () 
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 2020-11-12 09:48:18 +01:00
Xavier Ordoquy
3578683a69
Merge pull request from encode/version-3.12.2 
Version 3.12.2
 2020-11-05 23:15:45 +01:00
bhealy-indeed
80444a0afb
nit: Typo fix () 2020-11-05 22:21:30 +01:00
Megan Gross
606df83885
Update throttling.md () 
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 () 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 () () 
* Documentation: improve the action decorator documentation ()
 2020-10-13 08:32:38 +02:00
Adam Johnson
fd5e1a745a
Fixed some documentation headings to use a space () 2020-10-10 17:42:59 +01:00
zach valenta
ffde169102
Add docs link to to_internal_value() () 2020-10-10 17:36:15 +01:00
Thomas Riccardi
1ef192811c
Add missing quoting for data keyword argument in serializer doc () 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 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 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 () 
    all are related to this
 2020-10-06 13:14:11 +01:00
Xavier Ordoquy
d635bc9c71
Merge pull request from verhovsky/patch-2 
Correct indentation
 2020-10-06 13:04:08 +02:00
Xavier Ordoquy
9dc10d2af7
Merge pull request from Exifers/patch-1 
Documentation: use retrieve instead of read for Viewset
 2020-10-05 21:54:33 +02:00
Xavier Ordoquy
a849627f88 Fixes - 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 () 
* 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 () 
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. () 2020-09-14 19:46:51 +02:00
Mohammad Amin Haghpanah
04f39c42ee
Add drf-psq package to docs () 
* 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 () 2020-09-08 15:44:03 +01:00
Michael K
ddcd8b539b
Run tests against Python 3.9 () 
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() () 
* 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 () 2020-08-25 15:15:17 -07:00
Борис Верховский
374c0d4142
Punctuation fix () 
* Punctuation fix

* more punctuation
 2020-08-20 13:23:59 +01:00
Vibhu Agarwal
3d708ac700
Fix broken docs link () 2020-08-11 16:36:23 -07:00
Masked Man
17f2b39bdb
Fix docs issue () 2020-08-05 15:33:30 -07:00
Tom Christie
7d5155e0eb
Resize sponsor images for new GitHub layout () 2020-08-05 14:13:01 +01:00
Paul Watts
559088463b
Update an example to not use oppressive language () 
* 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 () 
* Adjusted token admin to map to user ID.

Closes .

* 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 () 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 () 2020-07-06 11:56:46 +01:00
Ngô Thanh Lợi (Leonn)
19915d1917
Fix docs typo () 2020-06-22 14:24:50 -07:00
w
7a04269209
Fixed docs typo () 2020-06-19 10:29:41 -07:00
Carlton Gibson
e18e40d6ae
Updated Schema docs. () 2020-06-16 13:33:48 +02:00
Rignon Noël
b677b7b15d
Update link to dry-rest-permissions () 
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 () 2020-05-13 17:54:46 -07:00
Derek
00e6079e94
Nginx basic auth tutorial moved () 2020-05-11 16:29:31 +01:00
Kamil Sampolski
f07f48a5da
Updating documentation / switching from url to path () 
* 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 () 
* 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 () 2020-05-01 10:22:36 +01:00
ADimeo
4349ce1a54
Fix broken documentation link () 2020-04-30 13:14:27 +01:00
Robert Singer
05a59095ce
Adds drf-typed-views to 3rd party packages () 2020-04-27 12:12:13 -07:00
Victor Mireyev
3eef5f47f3
Fix typo in links () 
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. () 2020-04-24 15:17:35 +01:00
Matthaus Woolard
812f254bbd
SearchFilter to support JSONField and HStoreField () 
* 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 () 
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. () 2020-04-06 17:09:23 +02:00
Rotzbua
a7a362813b
Update optional dependencies list. () 
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 () 
the truncation changes the meaning somewhat..
 2020-03-31 14:53:33 +01:00
Artur Barseghyan
5cc6ace9c4
Update third-party-packages.md () 2020-03-20 11:28:51 -07:00
Mahmoud Adel
8b5d3437f9
Add django-rest-auth fork to docs () 2020-03-17 15:45:45 -07:00
0dysseas
be96939ec1
Fix serializer example in docs () 2020-03-17 09:49:19 -07:00
Tom Christie
ddfb9672ae
Release notes for 3.11.0 () 2020-03-04 13:31:43 +00:00
Martin Desrumaux
6a23fa0649
OpenAPI: Make operationId camelCase, matching spec examples. () 2020-03-03 17:51:51 +01:00
Martin Desrumaux
8aa8be7653
Implement OpenAPI Components () 2020-03-02 19:35:27 +01:00
Martin Desrumaux
5b16a17242
OpenAPI: Allow customizing operation name. () 2020-03-02 16:40:18 +01:00
Dhaval Mehta
2a5c2f3f70
Added OpenAPI tags to schemas. () 2020-02-28 12:06:03 +01:00
Samuel Dion-Girardeau
e32ffbb12b
Fix docs code example () 2020-02-24 16:33:00 -08:00
Prayash Mohapatra
764dabd29e
Update writeable nested serializer doc () 2020-02-20 10:55:13 +00:00
Ryan P Kilby
92a4a5d423
Fix docs 404 () 
* 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. () 2020-02-19 20:16:42 +01:00
Dalei
39dd34f161
Update docs for OpenAPI () () 2020-02-19 11:56:12 +00:00
Thorsten
f81ca78642
Add file option to generateschema () 2020-02-12 20:35:54 +01:00
William S. Vincent
d21b8eb084 update Django for APIs book to 3.0 edition () 2020-01-28 14:05:32 +00:00
Jonathan Longe
62193e0378 Add permissions to quickstart tutorial () 2020-01-15 11:58:31 -08:00
Danny
442a206502 Fix full-text search docs () 2020-01-10 22:38:29 -08:00
phankiewicz
a9e55334e7 Add X-CSRFToken HTTP header in swagger-ui example () 2020-01-03 13:59:32 +00:00
Frederico Lima
25ac7ba450 Add third party lib drf-viewset-profiler () 2020-01-03 13:53:09 +00:00
Bart
07376f128c Grammar fix () 2020-01-03 13:36:43 +00:00
Jihoon Park
f3ed69374d Add missing punctuation marks and URL name () 
- 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 () 
* 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 () 
* 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
2019-12-12 14:31:40 +00:00
Kye Russell
dff9759555 Removed Eric S. Raymond quote from the release notes () 2019-12-04 09:29:01 +00:00
Tom Christie
070cff5a03
Drop set_context() () 
* Do not persist the context in validators

Fixes 

* 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 () 2019-11-18 12:35:36 +00:00
CloudCode Hungary
6196e9c8cd add djangorestframework-features to third-party () 2019-11-18 12:31:32 +00:00
James
323e1cddda Cleanup "Documenting your API" 3rd party recommendations () 2019-11-15 18:39:47 -08:00
brantmorton
0d6589cf45 Updated url() with re_path() in Versioning docs. () 2019-11-07 13:20:56 +01:00
Yann Savary
0d3d548aa5 OpenAPI: Fixed generation when title or version not provided. () 2019-11-06 21:54:12 +01:00
Aaron Yong
14d740d088 Update DEFAULT_SCHEMA_CLASSES default value in Settings docs () 
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 () 2019-11-06 09:34:28 -08:00
Chris Guo
5521eacb02 Update docs imports () 2019-11-01 10:56:59 -07:00
Daniel Hnyk
ab40b80fa6 Remove unmaintained django-rest-framework-bulk from docs () 2019-10-28 03:46:44 -07:00
Chris Guo
5ee970c090 Fix docs typos () 2019-10-24 11:31:12 -07:00
Aaron Yong
4d57cd31f6 Update method override example in Schemas docs () () 
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 () 2019-10-22 11:10:15 -07:00
Chris Guo
a734e58d44 Fix docs typos () 2019-10-21 15:11:12 -07:00
zach valenta
f98b6f3577 proper Github repo issue already resolved () 
per the ticket anyway https://github.com/encode/django-rest-framework/issues/2162
 2019-10-17 13:58:12 +01:00
Braden MacDonald
3aa1089a6a Update serializer docs to use correct param name () 
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
David Sanders
9850441e6f Fix docs typo () 2019-10-08 16:37:58 -07:00
Law Karingithi
0e4811e9ce Fix minor grammatical errors in docs () 2019-10-08 09:38:14 -07:00
Tom Christie
f9cc190177 Crop width on premium sponsor images 2019-10-07 14:31:16 +01:00
Tom Christie
f36ff9b08b
Add Retool as a new premium sponsor () 2019-10-07 14:21:58 +01:00
Ted Stoychev
60f9c12900 Fixed broken link in documentation () 2019-09-27 09:47:51 -07:00
Yezy Ilomo
5b990d4092 Add django-restql to 3rd party packages in docs () 2019-09-24 00:22:25 -07:00
Oxan van Leeuwen
2664e65019 Add djangorestframework-dataclasses to 3rd party package docs () 2019-09-18 11:21:32 -07:00
napsterv
7a3b7d2001 Fixed method signature in docs () 2019-09-16 10:47:29 -07:00
Tom Christie
89ac0a1c7e
Version 3.10.3 () 
* Version 3.10.3

* Version 3.10.3 release notes
 2019-09-04 14:28:25 +01:00
Pramod Pujara
c0cf37e35d Update tutorial links () 2019-09-03 11:21:53 -07:00
Yann Savary
e57c1505fc Replaced 'TODO' hardcoded version info by a parameter with default '0.1.0' () 2019-09-03 16:07:30 +02:00
Greg Schmit
0cc09f0c0d Add drf-action-sreializer to third party packages () 2019-07-30 12:37:49 -07:00
Ryan P Kilby
bcf196d0ac
Remove outdated note about read_only+default () 2019-07-29 15:10:57 -07:00
Max Wittig
ed7f3c55f7
docs(tutorial): add missing permission import in viewsets 2019-07-29 14:20:11 +02:00
Min ho Kim
0e1c5d3132 Fix typos () 2019-07-25 10:04:01 -07:00
Bary Levi
ea2ebf61cb fix quote was outside of inline code () 2019-07-22 13:02:17 +01:00
linchiwei123
da1c6d4129 Fix indent () 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
Tom Christie
6499378fc3 3.10 release notes tweaks 2019-07-15 12:38:28 +01:00
Tom Christie
9eaf49dab9
Version 3.10 () 
* 3.10 release notes

* Version number -> 3.10

* Update translations

* Update 3.10 release docs

* Update release notes

* Delete symlink
 2019-07-15 12:31:09 +01:00
Ryan P Kilby
b26db12813 Update default settings to use lists instead of tuples () 
* 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 () 2019-07-12 18:15:36 -07:00
Carlton Gibson
7915485c0d Update docs for OpenAPI. () 
* 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
1619d282f7
Update rollbar sponsor URL () 2019-07-08 12:27:21 +01:00
Tom Christie
cc88c8a6f3
Update serializers.md 2019-07-08 11:12:30 +01:00
linchiwei123
372f4fde20 Update pagination.md () 
it seems like that
 2019-07-05 22:30:01 -07:00
cyap
eebc579e9b Fix typo () 2019-07-05 15:46:51 +01:00
linchiwei123
373195996e Update fields.md () 
Example ==> Example
 2019-07-05 14:24:52 +01:00
linchiwei123
8fbf8c3fa3 Update serializers.md () 2019-07-05 09:11:20 +01:00
Alex Ayon
a3eeeb20e7 Update 1-serialization.md () 
Assigning a sorted list to STYLE_CHOICES by using a list comprehension.
 2019-07-04 13:41:15 +01:00