1
1
mirror of https://github.com/encode/django-rest-framework.git synced 2025-07-04 12:23:17 +03:00
Commit Graph

1252 Commits

Author SHA1 Message Date
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
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
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
Danny
442a206502 Fix full-text search docs () 2020-01-10 22:38:29 -08: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
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
Hendrik
a73d3c309f Elaborated on nested relationships () 2019-11-18 12:35:36 +00: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
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
Law Karingithi
0e4811e9ce Fix minor grammatical errors in docs () 2019-10-08 09:38:14 -07:00
Ted Stoychev
60f9c12900 Fixed broken link in documentation () 2019-09-27 09:47:51 -07:00
napsterv
7a3b7d2001 Fixed method signature in docs () 2019-09-16 10:47:29 -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
Ryan P Kilby
bcf196d0ac
Remove outdated note about read_only+default () 2019-07-29 15:10:57 -07: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
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
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
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
johnthagen
989aeca205 Add link to django-filter on first reference () 2019-07-03 10:43:30 -07:00
Ryan P Kilby
280014fe37 Update docs for pagination settings () 2019-07-02 12:09:45 +01:00
Ryan P Kilby
82c2b5c3e7
Update mkdocs () 2019-06-30 19:04:36 -07:00
Jon Besga
9a429a1c2e Fix custom authentication example () 2019-06-30 17:55:54 -07:00
Ryan P Kilby
df1d146ee7
Remove old documentation () 2019-06-28 16:03:00 -07:00
Florimond Manca
af2a2e6010 Update description and link to djangorestframework-api-key () 2019-06-28 15:40:31 -07:00
bonohubby
f76480a127 Fix typo in docs () 2019-06-25 10:08:46 +01:00
Robert Singer
80e89c75c7 Add DRF Access Policy to 3rd party packages () 2019-06-23 13:18:08 -07:00