Commit Graph

177 Commits

Author SHA1 Message Date
Danilo Bargen
1b882f7281 Add drf-dynamic-fields to third party packages (#4530) 2016-09-30 17:06:36 +01:00
Jeff Willette
a68b37d8bc Update to correct location of reverse relation doc (#4481) 2016-09-13 09:31:48 +01:00
Kenneth Schnall
ff5cfe3e84 Replace "class based views" occurrences with "class-based views" (#4251) 2016-07-08 08:38:50 +01:00
Tom Christie
75751cc64e Allow relative style hyperlinked URLs 2016-06-02 15:03:17 +01:00
Adam Chainz
e3337ab4aa Convert readthedocs link for their .org -> .io migration for hosted projects
As per [their blog post of the 27th April](https://blog.readthedocs.com/securing-subdomains/) ‘Securing subdomains’:

> Starting today, Read the Docs will start hosting projects from subdomains on the domain readthedocs.io, instead of on readthedocs.org. This change addresses some security concerns around site cookies while hosting user generated data on the same domain as our dashboard.

Test Plan: Manually visited all the links I’ve modified.
2016-05-29 23:26:56 +01:00
Carlton Gibson
9d87dbc016 Remove Py2/Py3 difference from Example (#4145)
`print` is available as a function on every supported version of Python (2.7+)
2016-05-25 14:38:44 +01:00
Petros Moisiadis
788603e153 Document allow_empty argument (#4117)
ListSerializer fields or serializers that are passed many=True may also take an allow_empty=False argument to disallow empty lists as valid input.

Information about this was part of the 3.2 release announcement, but had not been part of the API docs until now.
2016-05-13 15:55:31 +01:00
S. Andrew Sheppard
101c178b8c links to html-json-forms package 2016-03-24 11:55:19 -05:00
aleontiev
3a3fd66852 documentation: add a reference to the dynamic-rest addons under the serializers guide 2016-03-11 12:43:17 -05:00
Wes
b773f03bd0 fix typo 2016-02-17 16:35:53 +08:00
Xavier Ordoquy
d738ad7ae6 Update to serialization results (closes #3881). 2016-01-27 22:23:20 +01:00
José Padilla
99a61d72a7 Fix broken link format 2016-01-20 14:04:04 -04:00
Xavier Ordoquy
6f8e0c3c07 Merge pull request #3289 from koliber/update-docs-serilaizers-multi-update
Added explicit id field in multi update example
2016-01-18 18:44:03 +01:00
Silvio J. Gutierrez
ece7973479 Updated comment. 2015-11-18 21:52:20 -05:00
Silvio J. Gutierrez
f7646627f1 Documentation fix for list serializers. 2015-11-17 19:09:49 -05:00
potpath
9634cea474 Fix broken link caused by case sensitivity 2015-10-21 18:43:07 +07:00
Zack Tanner
6fe021eea7 Various typo fixes 2015-10-14 19:09:11 -07:00
Tom Christie
a3067bea55 Merge branch 'master' into version-3.3 2015-09-17 16:24:46 +01:00
Nic Young
5c076e10bb Add link to serpy serialization, fixes #3391 2015-09-12 23:04:18 -07:00
Tom Christie
a67eed1466 Merge branch 'master' of github.com:tomchristie/django-rest-framework 2015-09-11 13:06:18 +01:00
Tom Christie
ab296ced4e Add link to django REST marshmallow 2015-09-11 13:06:09 +01:00
Nic Young
4704da9a1a Add note about field level validation, fixes #3306
The documentation added warns the user that field level validation will
be skipped if the field is declared on the model with the parameter
`required=False`.
2015-09-10 22:55:55 -07:00
José Padilla
9dd1b2516b Update ModelSerializer fields docs 2015-08-28 09:51:11 -04:00
koliber
dae5426e20 Changed formatting and updated docs 2015-08-28 15:35:32 +02:00
José Padilla
1fe8e9a0bf Add note on deprecation path 2015-08-28 08:11:07 -04:00
José Padilla
f3ef13ab59 Update to match docs on ModelForm fields 2015-08-28 08:05:20 -04:00
koliber
2946251c91 Added explicit id field in multi update example
If the id field is implicitly created, it is created as `read_only=True`. This causes the data validation step to remove the id values in the validated data.
2015-08-18 14:47:04 +02:00
Adrian Mester
d9c934debd fixed a typo in docs 2015-07-23 13:10:20 +03:00
Paweł Stiasny
22e8357a4b Update serializers documentation (removed feature)
It seems that allow_add_remove was removed from 3.x, yet the docs still mention it. Updating to avoid confusion.
2015-04-08 13:53:49 +02:00
Brett Koonce
d8a19f79ab more sp fixes 2015-04-07 22:06:25 -07:00
Tobias Preuss
49c04d7218 Fix typo. 2015-03-23 11:20:08 +01:00
José Padilla
d12de927ad Remove docs for 3.0 banners 2015-03-07 10:49:56 -04:00
Tom Christie
670723f021 Minor cleanups/improvements to ModelSerializer API 2015-02-06 15:45:02 +00:00
Tom Christie
6168f60ba8 Merge branch 'master' into version-3.1 2015-01-05 11:02:28 +00:00
Rocky Meza
5b5652594a Typo manger => manager 2014-12-26 22:24:31 -07:00
Tom Christie
2a1485e009 Final bits of docs for ModelSerializer fields API 2014-12-19 21:32:43 +00:00
Tom Christie
48d15f6ff8 Stub out the documentation 2014-12-19 16:58:35 +00:00
Tymur Maryokhin
eeb6e34064 Docs/tutorial import fixes. Refs #2296 2014-12-17 17:28:11 +01:00
Tom Christie
c6137bbf5a Serializer API restrictions. 2014-12-17 14:14:51 +00:00
Tom Christie
59b2ad5425 Minor docs tweaks 2014-12-05 13:23:14 +00:00
Tom Christie
e2587c7b4d Merge pull request #2204 from carltongibson/default-docs-fix
Clarify read-only & `unique_together` Documentation
2014-12-05 13:20:16 +00:00
Tom Christie
9fb1b396db user in example should have been instance. Closees #2191. 2014-12-05 13:07:31 +00:00
Carlton Gibson
6ee361332b Add missing definite article 2014-12-04 14:15:01 +01:00
Carlton Gibson
71e1a3942e Initial link from Serializers to Validators 2014-12-04 12:15:14 +01:00
Matías Lang
5ad22aea60 Updated serializers documentation
There was an error in the docs: the field extra_field_kwargs of the serializer's Meta doesn't work. The field must be extra_kwargs instead.
2014-12-02 12:23:25 -03:00
David Ray
84cff98fbf fix typo 2014-12-02 09:46:43 -05:00
Tom Christie
f4fc4670ca Promote 'many_init' to public API. Closes #2152. 2014-12-02 08:53:36 +00:00
Tom Christie
9ba29a88d6 Finalizing 3.0 release notes 2014-11-28 14:43:33 +00:00
Tom Christie
8e549a76ea Add 2.x notes and links 2014-11-28 14:26:03 +00:00
Tom Christie
276a2a52ee Docs on nested creates/updates and suchlike 2014-11-28 11:26:35 +00:00
Tom Christie
34ca8cd2a5 Moar docs. Amazing. 2014-11-28 09:56:44 +00:00
Tom Christie
0262262fee 3.0 serializer docs 2014-11-27 08:09:58 +00:00
José Padilla
16d442dda3 Use MkDocs meta.source to render source code links 2014-11-25 12:44:11 +00:00
Tom Christie
78ac332f18 Add docs on Meta inheritance. Closes #1926. 2014-11-03 15:08:19 +00:00
Federico Capoano
eb81c55d16 docs: added HStoreSerializer to third party serializers
added a reference to django-rest-framework-hstore in docs/api-guide/serializers.md
2014-08-25 12:32:44 +02:00
Federico Capoano
c462a43a87 docs: added reference to gis serializer
added reference to GeoFeatureModelSerializer of django-rest-framework-gis
2014-08-08 14:39:56 +02:00
Tom Christie
57d6e04ff5 Add django-rest-framework-mongoengine link. Closes #1722 Closes #1562 Closes #1545 2014-07-30 12:50:36 +01:00
Greg Barker
be84f71bc9 Fix #1614 - Corrected reference to serializers.CharField 2014-06-10 15:20:45 -07:00
Giorgos Logiotatidis
768f537dcb Typo fix. 2014-05-15 15:42:22 +03:00
Charlie Denton
c3967c08ab Minor docs example fix
Dates are smaller when they happen before.
2014-02-21 14:23:33 +00:00
Saurabh Kumar
b3aa512d35 fix(docs): fix code indentation in serializers.md
It fixes the indentation of `restore_object()` in the section "Specifying which fields should be write-only" serializers documentation.
2014-02-18 20:39:39 +05:30
Tom Christie
d20c49da4a More HyperlinkedModelSerializer docs 2014-01-14 20:34:33 +00:00
Tom Christie
85d74fc86a Added write_only and write_only_fields. Refs #1306 2014-01-14 11:25:44 +00:00
Paul Melnikow
4b8d1b66ab serializers.md: Fix typos 2014-01-10 08:22:47 -05:00
Ian
de319f3e28 Fix typo "Not" -> "Note" 2013-12-09 09:53:16 +00:00
Carlton Gibson
0bbc775b95 Merge pull request #1071 from craigds/field-transform-methods
Feature: add transform_<fieldname> methods to serializers
2013-10-09 01:11:46 -07:00
Tom Christie
f6301636fb Drop erronous left-over bit of docs. Closes #1147 2013-10-03 15:18:38 +01:00
Craig de Stigter
42bbf6907e docs: add paragraph on transform_fieldname methods 2013-10-03 12:38:42 +13:00
Tyler Hayes
c4cb26f73b Tiny typo fix 2013-09-04 03:38:34 -07:00
Tom Christie
b72a99fef2 Merge branch 'display-nested-data' into html-form-renderer 2013-08-23 14:39:52 +01:00
Tom Christie
5e40e50f2b Include import paths throughout docs.
Closes #1051.  Thanks to @pydanny for the report.
2013-08-21 19:46:09 +01:00
Veronica Lynn
4d8d2340be Fixed typos in a bunch of docs 2013-08-07 14:00:06 -04:00
Mark Aaron Shirley
b5dc6b6113 Fix docs typo 2013-07-14 18:18:39 -07:00
Mark Aaron Shirley
7815811fe3 Update nested serialization docs 2013-07-14 18:13:37 -07:00
Tom Christie
6de9b7c8ca Add note on ModelSerializer validation of both model fields and serializer fields. Refs #949 2013-07-11 21:02:47 +01:00
Tom Christie
a890116ab3 Minor docs addition 2013-07-04 13:49:28 +01:00
Tom Christie
b88bdfb9a5 Add section on dynamically modifying fields. Refs #958 2013-07-04 13:30:56 +01:00
Tom Christie
58d38d694e Merge branch 'master' into writable-nested-modelserializer 2013-06-28 09:07:09 +01:00
Toby Champion
250dfef158 Changes 'python' to 'Python' when used in prose. 2013-06-12 14:51:17 -07:00
Tom Christie
5d0aeef69e Better docs related to lookup_field and hyperlinked serializers. Closes #920. 2013-06-10 17:46:55 +01:00
gnunamed
fdb689f9b5 Update serializers.md 2013-06-05 13:53:00 -05:00
Tom Christie
de00ec95c3 Merge master 2013-06-05 13:33:19 +01:00
Stephan Groß
7a570e16e9 Fix md formatting and typos 2013-05-28 17:13:12 +02:00
Pascal Borreli
8f35ac4f93 Fixed typos 2013-05-28 15:09:23 +01:00
Mark Aaron Shirley
e550740b3d Merge remote-tracking branch 'upstream/master' into writable-nested-modelserializer
Conflicts:
	rest_framework/tests/relations_nested.py
2013-05-08 22:39:48 -07:00
Tom Christie
b70c9cc107 Merge master 2013-05-05 18:12:35 +01:00
Tom Christie
2dfd8c9697 docs, docs, docs 2013-05-05 16:48:12 +01:00
Victor Shih
8cabae22c5 Example and spelling fixes. Change "browseable" to "browsable" for consistency. 2013-05-01 21:26:40 -07:00
Tom Christie
21ae3a6691 Drop out attribute 2013-04-30 08:24:33 +01:00
Mark Aaron Shirley
c7e000e46e Merge remote-tracking branch 'upstream/master' into writable-nested-modelserializer
Conflicts:
	docs/api-guide/serializers.md
2013-04-16 09:55:47 -07:00
Mark Aaron Shirley
bda25479aa Update docs with allow_add_remove 2013-04-10 08:44:54 -07:00
Victor Shih
33ce7dfac4 Spelling/grammar fixes. 2013-03-30 20:28:27 -07:00
Tom Christie
92c929094c Version 2.2.5 2013-03-26 07:48:53 +00:00
Tom Christie
8387cb5d16 Docs fix 2013-03-25 20:28:17 +00:00
Tom Christie
7eefcf7e53 Bulk update, allow_add_remove flag 2013-03-25 20:26:34 +00:00
Tom Christie
13794baf70 Bit of extra tidying and plenty of docs 2013-03-22 17:01:06 +00:00
Tom Christie
b2dc664485 Basic bulk create and bulk update 2013-03-19 14:26:48 +00:00
Tom Christie
034c4ce408 Fix serializer restore_object example for partial updates 2013-03-17 20:06:38 +00:00
Tom Christie
ef0caf64d3 Extra note on method 2013-03-17 19:59:13 +00:00
Tom Christie
e80d3d1bdf Fix text regarding serializer error messages.
Closes #734.
2013-03-17 19:51:04 +00:00