encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-14 13:46:59 +03:00
Code Issues Packages Projects Releases Wiki Activity
8,734 Commits 18 Branches 132 Tags 104 MiB
21bb21b65b
Commit Graph

2959 Commits

Author SHA1 Message Date
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
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
Chris Guo
a734e58d44 Fix docs typos (#7006) 2019-10-21 15:11:12 -07:00
zach valenta
f98b6f3577 proper Github repo issue already resolved (#6999) 
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 (#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
David Sanders
9850441e6f Fix docs typo (#6974) 2019-10-08 16:37:58 -07:00
Law Karingithi
0e4811e9ce Fix minor grammatical errors in docs (#6979) 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 (#6977) 2019-10-07 14:21:58 +01:00
Ted Stoychev
60f9c12900 Fixed broken link in documentation (#6937) 2019-09-27 09:47:51 -07:00
Yezy Ilomo
5b990d4092 Add django-restql to 3rd party packages in docs (#6947) 2019-09-24 00:22:25 -07:00
Oxan van Leeuwen
2664e65019 Add djangorestframework-dataclasses to 3rd party package docs (#6939) 2019-09-18 11:21:32 -07:00
napsterv
7a3b7d2001 Fixed method signature in docs (#6931) 2019-09-16 10:47:29 -07:00
Tom Christie
89ac0a1c7e
Version 3.10.3 (#6908) 
* Version 3.10.3

* Version 3.10.3 release notes
 2019-09-04 14:28:25 +01:00
Pramod Pujara
c0cf37e35d Update tutorial links (#6890) 2019-09-03 11:21:53 -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
Greg Schmit
0cc09f0c0d Add drf-action-sreializer to third party packages (#6845) 2019-07-30 12:37:49 -07:00
Ryan P Kilby
bcf196d0ac
Remove outdated note about read_only+default (#6847) 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 (#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
Tom Christie
6499378fc3 3.10 release notes tweaks 2019-07-15 12:38:28 +01:00
Tom Christie
9eaf49dab9
Version 3.10 (#6802) 
* 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 (#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
1619d282f7
Update rollbar sponsor URL (#6791) 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 (#6787) 
it seems like that
 2019-07-05 22:30:01 -07:00
cyap
eebc579e9b Fix typo (#6785) 2019-07-05 15:46:51 +01: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
Alex Ayon
a3eeeb20e7 Update 1-serialization.md (#6781) 
Assigning a sorted list to STYLE_CHOICES by using a list comprehension.
 2019-07-04 13:41:15 +01:00
johnthagen
989aeca205 Add link to django-filter on first reference (#6777) 2019-07-03 10:43:30 -07:00
Étienne Noss
f5470ab9e2 docs: update http method override middleware example (#6776) 2019-07-03 10:23:35 +01: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
Tanner Rollefson
a1921b1adb Add djangorestframework-mvt to third party packages (#6756) 2019-06-24 15:44:22 -07: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
Alan Crosswell
4d228257ac Retain declared path ordering in OpenAPI YAML output. (#6680) 
* Add pyyaml.dump(..., sort_keys=False) to not sort openapi keys alphabetically
* Retain ordering of paths as provided in urlconf in OpenAPI schemas.
 2019-06-09 14:58:02 +02:00
Alan Crosswell
819c46ea80 Add --generator_class CLI option to generateschema (#6735) 
* add --generator_class CLI option to generateschema
* Add test for generateschema —generator_class flag.
 2019-06-09 14:43:54 +02:00
Ryan P Kilby
9ac9c1b2ea
Update status code docs (#6732) 2019-06-05 17:51:50 -07:00
Tom Christie
6a8575b042
Sponsor update (#6727) 
* Sponsor updates

* Sponsor Update
 2019-06-04 12:03:31 +01:00
Ryan P Kilby
3e210ae48d
Update markdown preprocessor registration (#6722) 2019-05-31 14:11:58 -07:00
Adam
6aac9d2be1 Remove references to django-crispy-forms (#6600) 2019-05-30 19:47:30 -07:00
Timothy Allen
8430f3e5b6 Fix typo in github.com URL. (#6720) 2019-05-30 12:23:37 -07:00
Dani Hodovic
10a0b42b74 Add more DRF job sites (#6691) 2019-05-24 12:50:15 +01:00
Raffaele Salmaso
514033815d Allow JSONField encoder customization. (#6713) 2019-05-24 12:47:35 +01:00
Ryan P Kilby
c3a13916d2
Update release notes (#6671) 
* Add 3.9.4 release notes to master
* Add top-level symlink to release notes
 2019-05-14 10:13:14 -07: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
Tim Gates
564faddb0f Make Markdown 2.6 the minimum compatible version (#6576) 2019-05-08 19:34:38 -07: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
Serkan Hosca
680ed8aa8b Add django-rest-witchcraft to third party packages (#6587) 2019-05-06 16:19:51 -07:00
Asif Saif Uddin
50a24d6d7f Drop Python 3.4 support (#6620) 2019-05-06 11:35:58 -07:00
Aart Goossens
0f819d844d Remove recommendation for DRF Docs (#6580) 
Since DRF Docs is not compatible with the latest version of DRF (or Django?; related issue: https://github.com/manosim/django-rest-framework-docs/issues/180) and the latest release is almost 3 years ago I suggest to remove the recommendation for this package.
 2019-05-03 15:26:06 -07:00
Jimmy Merrild Krag
14fad0d690 Fix capitalization, markdown syntax link in docs (#6621) 
The `Pygments` and `Markdown` python packages have first letter capital.
Fixed link to markdown syntax to go directly to the syntax page.
 2019-05-02 18:17:33 -07: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
Jon Dufresne
565794bedc Replace virtualenv references with venv in the docs (#6636) 
On Python 3, creating virtual environments is available through the
stdlib module venv.

https://docs.python.org/3/library/venv.html
 2019-05-01 07:51:02 +02:00
Jon Dufresne
8687f6135f Remove references to Python 2 from the docs (#6635) 2019-05-01 07:50:28 +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
Carlton Gibson
7f16ed7727 Correct version number in release notes. 2019-04-29 16:35:17 +02:00
Carlton Gibson
83d09c7bc5
Update version and release notes for v3.9.3. 2019-04-29 16:30:44 +02:00
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
jozo
cceb416098 Link DRF Condition (cache headers) third party package. (#6557) 2019-04-04 11:31:08 +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
Matt Hegarty
6f24c21cfb Fixed typo: /Janurary/January/ (#6506) 2019-03-12 12:46:02 +01:00
Tom Christie
bcdfcf7e49
Sponsor updates (#6495) 2019-03-07 11:00:50 +00:00
Luoxzhg
dfc277cce6 Corrected tutorial 1 example renderer output to bytes. (#6486) 2019-03-05 11:50:13 +01:00
SrdjanCosicPrica
ac7b20cca2 Fix get_search_fields example (#6487) 2019-03-04 14:46:14 +01:00
Carlton Gibson
0ab527a3df Updated release notes for v3.9.2 2019-03-03 20:16:16 +01:00
Carlton Gibson
94593b3a50
Introduce RemovedInDRF…Warning classes to simplify deprecations. (#6480) 
Closes #6290.
 2019-03-03 09:20:45 +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
Carlton Gibson
d932baa646
Corrected link to ajax-form library. 
Closes #6465.
 2019-02-22 11:11:52 +01: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
Carlton Gibson
65f5c11a5b Document support for Django 2.2. 2019-02-14 15:57:20 +01:00
johnthagen
9f66fc9a7c
Fix typo in caching docs 2019-02-13 19:00:16 -05:00
briwa
dc6b3bf42e Fix tutorial instruction to also add pyyaml (#6443) 2019-02-07 09:10:11 +01: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
Carlton Gibson
9ff0092061 Added release note stub for v3.9.2. 2019-01-24 16:25:47 +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
Tom Christie
c049777dc7 Add missing item in 3.9.1 release notes 2019-01-16 13:39:36 +00:00
Tom Christie
453196e9c3
Version 3.9.1 (#6405) 
* Version 3.9.1

* Upgrade bootstrap

* Release notes for 3.9.1
 2019-01-16 13:27:35 +00:00
johnthagen
9c408b296b Remove reference to deprecated drf-openapi package (#6398) 2019-01-08 12:47:09 +00:00
Matt Wiens
e0ae975e5c Fix a badly formatted title in docs (#6089) 
While having code blocks in a title is valid Markdown, MkDocs does not
render it as expected. This removes a code block placed in a title.
 2019-01-08 12:07:00 +00:00
johnthagen
a49d744d5e Fix OpenAPI links (#6382) 2019-01-08 11:56:42 +00:00
johnthagen
0860ef9eee Update quickstart to Django 2.0 routing syntax (#6385) 
* Update quickstart to Django 2.0 routing syntax

* Remove uneccessary raw string identifiers

* Correctly import path function

* Fix import path to use django.urls

This is what is prescribed in the Django 2.1 tutorial
 2019-01-08 11:53:51 +00:00
Adrien Brunet
4863a24451 Fix links 404/302/303 in docs/community (#6387) 
* Fix links 404/302/303

* Fix machinalis links in docs

* Fix kickstarter links in documentation

* Fix kickstarter links in documentation

* Fix kickstarter links in documentation - dropping links when broken
 2019-01-08 11:15:53 +00:00
johnthagen
7749e4e3be Make code snippet Python 3 compatible (#6377) 2019-01-04 18:00:38 -08:00
Adrien Brunet
1e2fd25f54 Fix #3387: Documentation - Remove leading '.' before format option (#6388) 2019-01-04 14:45:08 +00:00
Phil Ratcliffe
1a9548db4f Fix missing import in example code 2018-12-28 16:10:08 +00:00
Anuvrat Parashar
97a47958c0 correct grammar, remove common noun after proper noun. (#6383) 
`MultipartParser` is enough to denote that it is a parser.
 2018-12-24 15:54:27 +00:00
johnthagen
f0712aa78a
Fix example to be Python 3.x and 2.7 compatible 2018-12-22 15:29:02 -05:00
Carlton Gibson
86aa7768a7 Update quote in relations.md (#6373) 
Fixes #6372.
 2018-12-21 11:39:01 +00:00
Carlton Gibson
63e6bbfd36 Note that only latest patches of Python & Django are supported. (#6370) 
Fixes #6367.
 2018-12-20 13:41:54 +00:00
Dario Cangialosi, Coder
fa57fb8aeb Use HTTPS URL example for git clone commands. (#6134) 2018-12-19 19:28:03 +01:00
Cyrus Ghazanfar
7ad5bdb669 Adjusted login template override example (#6265) 2018-12-19 15:25:34 +01:00
Jonathan Berger
1348bdc48a Fixed quickstart.md typos (#6348) 2018-12-19 14:50:14 +01:00
Xavier Ordoquy
a52087b1b8
Merge pull request #6362 from adrienbrunet/typo 
docs: typo in permissions (double space)
 2018-12-19 14:34:18 +01:00
Adrien Brunet
c4a021185f docs: typo in permissions (double space) 2018-12-18 13:03:03 +01:00
Tom Christie
2aecef3460 Update kloudless logo 2018-12-18 11:23:08 +00:00
Tom Christie
3453d65655 Update Kloudless logo 2018-12-18 11:18:40 +00:00
Dan Wilson
ef61288d77 Remove mention of djangorestframework-jwt (#6353) 
Follow-up to https://github.com/encode/django-rest-framework/pull/6138
 2018-12-13 21:01:10 +00:00
JerzySpendel
627eeb8202 Add missing comma in documentation of permission composition (#6336) 2018-12-07 16:44:57 -05:00
Josh Smith
facb433c89 Remove unmaintained digest authentication package (#6347) 
https://github.com/juanriaza/django-rest-framework-digestauth has not been updated in 5 years and is currently incompatible with the latest DRF ecosystem.
 2018-12-06 16:26:40 +00:00
Tom Christie
2084555fbe Update Lights On logo 2018-11-16 15:41:38 +00:00
Mice Pápai
d0369b27cd update docs/api-guide/serializers.md: consistency (#6320) 2018-11-15 14:44:54 +00:00
Tom Christie
2c0b2bd44e
Add 'Lights On Software' (#6319) 
* Add 'Lights On Software'

* Fix link
 2018-11-15 13:52:24 +00:00
Tom Christie
588c6976d4
Delete lightson.png 2018-11-15 12:06:47 +00:00
Tom Christie
bc36cf5e2b
Lights On 2018-11-15 12:06:18 +00:00
Tom Christie
f73b4896b8
Lights On Software 2018-11-15 12:04:06 +00:00
Stan Fateev
f7d2839562 Typo fix in the release announcement (#6318) 2018-11-14 07:50:28 +01:00
Stephen Finucane
fae7e91728 docs: Remove references to drf-openapi (#6272) 
This has been EOL'd in favour of drf-yasg [1].

[1] https://github.com/limdauto/drf_openapi/commit/1673c6e0

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-11-03 15:57:47 +01:00
Tom Snee
d59a130168 Fixes an import statement in chapter 5 of the tutorial. (#6267) 2018-11-02 08:48:39 -07:00
ilmucio
40da2a21ef Update authentication.md (#6291) 2018-10-29 15:43:06 -07:00
Zach Wernberg
67e99a29b8 Fix typo in release-notes.md (#6285) 2018-10-29 10:03:34 -07:00
Tano Abeleyra
9d001cd84c Fix typo in testing.md (#6257) 2018-10-18 15:42:52 -07:00
Tom Christie
2c9c0f1b7f
Version 3.9 (#6247) 
* Release notes to 5174a26ec9

* Update version for v3.9.0

* Removed exclude_from_schema per deprecation policy.

* Updated list_route() and detail_route() deprecations.

* Weakened to PendingDeprecationWarning for `base_name`

cc @rpkilby.

* Add (beginning of) 3.9 release announcement.

@tomchristie: Input on OpenAPI and What’s Next very welcome! :)

* Add announcement section for Extra Actions in Browsable API

* Update release notes and add deprecation note for Django Guardian backend.

* Add release note for #6073

* Add release notes to dd19a44583

* Adding release notes

* Update 3.9 announcement

* Add Oct 18 release date
 2018-10-18 10:38:46 +01:00
Tom Christie
28040b3bda
Upgrade Auklet to premium (#6244) 2018-10-15 17:31:36 +01:00
Tom Christie
1c3f796219
Add kloudless as a new premium sponsor (#6241) 2018-10-11 14:48:05 +01:00
Tom Christie
ebc5393776 Add spacing around kloudless logo 2018-10-11 14:06:33 +01:00
Tom Christie
317d2489e4 Add Kloudless logo 2018-10-11 14:03:02 +01:00
Daniel Bate
5feb835929 Feature/action docs sections (#6060) 
* added ability to add sections to custom action documentation

* added tests to cover docs sections in custom actions

* added method specific docs test for action mapping

* added docs for custom action documentation
 2018-10-10 10:29:29 +02:00
Tom Christie
6522d4ae20
Add OpenAPIRenderer by default, and add schema docs. (#6233) 
* Add OpenAPIRenderer as a default for get_schema_view, and start adding schema docs

* Add optional pyyaml

* Updating schema docs
 2018-10-04 14:05:55 +01:00
Jufe Brown-Tsai
18ad3290ef Documentation fix for django-admin commands (#6232) 
* fix django-admin commands on quickstart doc

* fix django-admin commands on tutorial/1-serialization doc

* fix django-admin command on readme

* fix django-admin command on docs/community/project-management.md
 2018-10-03 16:16:52 +01:00
Xavier Ordoquy
b41a6cfa38 permissions: Allow permissions to be composed (#5753) 
* permissions: Allow permissions to be composed

Implement a system to compose permissions with and / or.
This is performed by returning an `OperationHolder` instance that keeps the
permission classes and type of composition (and / or).
When called it will return a AND/OR instance that will then delegate the
permission check to the operands.

* permissions: Add documentation about composed permissions

* Fix documentation typo in permissions
 2018-10-03 15:36:24 +01:00
Ryan P Kilby
66183389f6 Deprecate DjangoObjectPermissionsFilter (#6075) 2018-10-02 16:34:25 +02:00
Ryan P Kilby
903204cd79 Fix action support for ViewSet suffixes (#6081) 
* Add suffix support for actions

Removes the newly introduced `action.name` in favor of leveraging the
View's `.get_view_name()` method, which supports both name and suffix.

* Fix view description func docstrings

* Test action decorator name & suffix kwargs

* Adjust 'extra action' docs
 2018-10-02 16:22:21 +02:00
Tom Christie
20a7734dce Bring docs license text up to date 2018-10-02 11:12:31 +01:00
Lewis M. Kabui
d0995fac70 Remove dot character from "pagination_class" (#6137) 2018-10-02 08:49:31 +02:00
Matheus Cansian
9ecce21044 Update JWT docs. (#6138) 
* Remove mentions to djangorestframework-jwt in docs
* Remove links for blimp and djangorestframework-jwt
 2018-10-02 08:43:45 +02:00
Jon Dufresne
878f9d2783 Prefer https:// for URLs when available throughout project (#6208) 2018-10-02 08:28:58 +02:00
Anish Shrestha
2e8ccfd883 Fix typo in docs (#6212) 2018-09-25 12:11:13 -07:00
Anish Shrestha
d976ac56b0 Fix spelling error (#6198) 2018-09-21 08:55:32 +02:00
Melissa Lewis
b090ae9d30 Fix docs typos (#6195) 2018-09-18 15:32:32 -07:00
Tom Christie
5f1f2b1003 Higher res. load impact logo 2018-09-11 12:55:53 +01:00
Tom Christie
4033f0c6b3
Add Load Impact to premium sponsors (#6176) 2018-09-11 11:40:47 +01:00
Ryan P Kilby
7f77340b33
Add Python 3.7 support (#6141) 2018-09-10 21:44:23 -07:00
Jon Dufresne
4d57d46bf8 Prefer io.BytesIO over six; available on all supported Pythons (#6168) 
On all supported Pythons, the io.BytesIO is always a stream
implementation using an in-memory bytes buffer.

Makes code slightly more forward compatible by reducing use of the six
module and promotes more forward compatible practices in the docs.
 2018-09-09 11:53:41 +01:00
David Sanders
69f605f30e
Fix validate_my_field signature 2018-09-06 18:16:06 -07:00
Timothy Allen
bc573d8096 Add drf-renderer-xlsx package. (#6147) 
* Add drf-renderer-xlsx package.

* Gah, tabs creeped in; never leave your default editor environment. :)
 2018-09-06 11:01:57 +01:00
Michael
2c992f09da Mention Django 2.1 compat where missing (#6158) 2018-09-04 11:33:42 -07:00
Craig Johnson
90ed2c1ef7 Small grammar correction in quickstart. (#6121) 
Just felt the sentence could use some improving.
 2018-08-13 10:32:17 +01:00
Shabda Raaj
8f9b875456 Add building with drf book (#6102) 
* Added building APIs with Django and DRF book

* Added book cover
 2018-08-01 16:43:09 +01:00
dengshilong
0484d01aae Fix typo error, Link to Field (#6078) 2018-07-10 11:03:39 +02:00
Eze Sunday
a0277919f0 Fix grammar mistake in html-and-forms.md (#6070) 2018-07-08 16:11:05 -04:00
Ryan P Kilby
a628a2dbce Drop Django 1.10 support (#5657) 
* Remove Django 1.10 from CI

* Remove Django 1.10 compat code
 2018-07-06 12:14:31 +02:00
Ryan P Kilby
99ca078ebb Add "Community" section to docs, minor cleanup (#5993) 
* Add 'Community' tab to navigation, move articles

* Drop DRF 2.x announcements and the docs note

* Drop embedded tutorial/guide/topics links

* Conver mixture of tabs/spaces => spaces

* Fix topics/community links
 2018-07-06 11:28:18 +02:00
Ryan P Kilby
7095021db7 Rename base_name => basename for consistency's sake (#5990) 
* Rename base_name => basename for consistency

* Update tests to use basename
 2018-07-06 11:03:12 +02:00
Ryan P Kilby
6511b52cca Fix schemas for extra actions (#5992) 
* Add failing test for extra action schemas

* Add ViewInspector setter to store instances

* Fix schema disabling for extra actions

* Add docs note about disabling schemas for actions
 2018-07-06 10:35:36 +02:00
Ryan P Kilby
0148a9f8da Improvements to ViewSet extra actions (#5605) 
* View suffix already set by initializer

* Add 'name' and 'description' attributes to ViewSet

ViewSets may now provide their `name` and `description` attributes
directly, instead of relying on view introspection to derive them.
These attributes may also be provided with the view's initkwargs.

The ViewSet `name` and `suffix` initkwargs are mutually exclusive.

The `action` decorator now provides the `name` and `description` to
the view's initkwargs. By default, these values are derived from the
method name and its docstring. The `name` may be overridden by providing
it as an argument to the decorator.

The `get_view_name` and `get_view_description` hooks now provide the
view instance to the handler, instead of the view class. The default
implementations of these handlers now respect the `name`/`description`.

* Add 'extra actions' to ViewSet & browsable APIs

* Update simple router tests

Removed old test logic around link/action decorators from `v2.3`. Also
simplified the test by making the results explicit instead of computed.

* Add method mapping to ViewSet actions

* Document extra action method mapping
 2018-07-06 10:33:10 +02:00
Chris Shyi
d9f541836b Update to Django 2.0 Routing Syntax (#6049) 2018-06-22 10:28:59 +02:00
Çağıl
8f55cd8db5 Fix url for group_names action example (#6036) 2018-06-21 04:29:05 -04:00
William S. Vincent
feffa109a8 Add REST APIs with Django book (#6033) 
Just published book dedicated to DRF.
 2018-06-20 00:24:26 +01:00
Tom Eastman
be2bcf7e3f Documentation: Correct the signature for HyperlinkedRelatedField.get_object() 2018-06-13 16:39:28 +12:00
Emeka Icha
a21484d90e (fix) link to disqus article on cursor pagination (#6020) 2018-06-12 10:34:28 +01:00
Jon Dufresne
89fb0b0f99 Update incorrect PyPI URL to register an account 
To register an account on PyPI, the URL is
https://pypi.org/account/register/, which changed after the move to
pypi.org.
 2018-06-09 19:09:31 -07:00
Teppei Fukuda
fe54575e6a Fix exceptions.md (#6003) 2018-05-25 10:42:22 +01:00