Commit Graph

169 Commits

Author SHA1 Message Date
Erick Wilder
908efd6656 #3937 Update docs for the Field.initial attribute.
Add an usage example on how to pass a callable to the `Field.initial` in the docs.
2016-02-17 11:01:09 +01:00
James Beith
34901a5ffa Fix syntax errors in docs example
- Add missing comma in kwargs
- Remove spaces around keyword / parameter equals
- Replace incorrect curly brace with parenthesis
2016-01-24 13:33:18 +00:00
Vedran Karačić
ede15645e0 Typo 2015-11-05 11:51:29 +01:00
Travis J Morton
03cb959416 typo 2015-11-02 12:58:21 -08:00
Tom Christie
6305ae8916 Merge pull request #3475 from tomchristie/forms-api
Forms API
2015-10-22 09:59:57 +01:00
Pierre Dulac
dc72fb4746 Missing the source= keyword for the URLField parameter 2015-10-16 19:43:00 +02:00
Tom Christie
90247afe29 Docs on Forms API 2015-10-12 21:14:58 +01:00
Tom Christie
265ec8ac62 Handle binary or unicode with JSONField 2015-09-28 17:47:51 +01:00
Tom Christie
10dbf1316f Added JSONField. Closes #3170. 2015-09-28 17:25:52 +01:00
Lubomír Sedlář
a57ad07674 Add link to validators
The `set_context` method there is the same as for the default field.
2015-09-03 10:35:28 +02:00
Lubomír Sedlář
1c049edd8c Improve documentation of default argument for fields
The documentation now not only mentions that callables are acceptable
arguments, it also tells the reader what the callable should look like.
2015-09-03 09:46:54 +02:00
Tom Christie
f4412d0827 Docs for select cutoffs 2015-08-21 10:52:44 +01:00
Aider Ibragimov
d845157983 Merge branch 'master' of https://github.com/tomchristie/django-rest-framework into feature/filepathfield 2015-07-18 23:34:07 +03:00
Tom Christie
3c57e08f62 Clarifications to read_only fields. Closes #3064. 2015-07-14 12:22:51 +01:00
Xavier Ordoquy
dee5fb5647 Merge remote-tracking branch 'reference/master' into feature/ipaddress-fix
Conflicts:
	docs/api-guide/fields.md
2015-06-04 14:21:33 +01:00
Xavier Ordoquy
0c66c7cfa6 Merge pull request #3000 from linovia/ovangle/uuid_format2
Add 'format' argument to UUIDField
2015-06-03 12:32:23 +01:00
Xavier Ordoquy
ea00fc7a85 Fix the UUID examples style. 2015-06-02 16:10:14 +01:00
Xavier Ordoquy
a61f865518 Add format examples. 2015-06-02 14:18:26 +01:00
Nicolas Delaby
3f3a01b4b8 fix Typo 2015-06-02 09:18:24 +02:00
Nicolas Delaby
f701ecceb7 Add DurationField 2015-06-01 18:20:53 +02:00
Thomas Stephenson
236b731072 Add 'format' argument to UUIDField
To allow serializations to control the representation format of a
UUID value
2015-04-12 22:07:25 +10:00
Christoffer
6cb6b02811 Reference typos in fields.md 2015-03-26 15:51:48 +01:00
José Padilla
d12de927ad Remove docs for 3.0 banners 2015-03-07 10:49:56 -04:00
Aider Ibragimov
c20a0250df add FilePathField, update docs 2015-03-03 14:34:06 +03:00
Aider Ibragimov
de72022f80 Merge branch 'master' of https://github.com/Ins1ne/django-rest-framework into feature/ipaddress 2015-02-28 14:29:27 +03:00
Aider Ibragimov
4d5eee04a0 add IPAddressField, update docs 2015-02-28 10:11:38 +03:00
Tom Christie
fbb21caaaa Merge master 2015-02-09 20:43:50 +00:00
José Padilla
7f801b9a01 Add trim_whitespace to CharField #2517
If set to `True` then leading and trailing
whitespace is trimmed. Defaults to `True`.
2015-02-06 01:09:19 -04:00
Xavier Ordoquy
46181341d5 Merge pull request #2512 from heywbj/docs
Add django-rest-framework-recursive to docs
2015-02-04 00:13:52 +01:00
Warren Jin
76efbdddb6 docs 2015-02-03 17:18:54 -05:00
Jeff Fein-Worton
0a65913fea typo in fields.md 2015-01-24 18:34:16 -08:00
Tom Christie
35f6a82462 Added DictField and support for HStoreField. 2015-01-23 16:27:23 +00:00
Tom Christie
5bb348605e UUIDField docs 2015-01-23 15:31:08 +00:00
Tom Christie
b6ca7248eb required=False allows omission of value for output. Closes #2342 2015-01-05 14:32:12 +00:00
Brian Stearns
3569674860 use of double quotes broke the code highlighting. 2014-12-21 18:53:35 -05:00
Tom Christie
3fff5cb6e0 Fix empty HTML values when a default is provided. 2014-12-17 15:13:48 +00:00
Tom Christie
f5b783af61 allow_blank in ChoiceField. Refs #2239. 2014-12-09 14:21:31 +00:00
Tom Christie
6ac79b8223 Document Field.fail(). Closes #2147. 2014-12-02 09:19:59 +00:00
Tom Christie
8e549a76ea Add 2.x notes and links 2014-11-28 14:26:03 +00:00
Tom Christie
e1b14cbe4a 3.0 docs for serializer fields 2014-11-26 10:27:29 +00:00
Tom Christie
c01c631ef2 perform_create, perform_update, perform_destroy hooks 2014-11-26 09:04:48 +00:00
Tom Christie
31536566d7 Updating fields docs 2014-11-25 17:35:27 +00:00
Tom Christie
f13c0ebe69 Merge master 2014-11-25 16:27:00 +00:00
Tom Christie
8c91e7b742 Add missing options 2014-11-25 15:52:13 +00:00
José Padilla
16d442dda3 Use MkDocs meta.source to render source code links 2014-11-25 12:44:11 +00:00
Craig de Stigter
dfab9af294 Minor: fix spelling and grammar, mostly in 3.0 announcement 2014-10-03 08:41:18 +13:00
Tom Christie
4fceceae7d DecimalField documentation 2014-09-12 20:09:08 +01:00
Federico Capoano
8e3f7700f6 docs: added drf-hstore to third party fields
added a reference to django-rest-framework-hstore in docs/api-guide/fields.md
2014-08-25 12:29:10 +02:00
Tom Christie
e385a7b8eb Merge master 2014-08-19 10:11:10 +01:00
Tom Christie
6edbabe0e1 Link to Django docs on widgets. Closes #1760. 2014-08-18 10:58:00 +01:00
Federico Capoano
5eb901cd2a docs: added reference to DRF-gis in fields
added django-rest-framework-gis to third party packages section in /docs/api-guide/fields.md
2014-08-08 14:25:02 +02:00
Xavier Ordoquy
4876bec9f5 Merge remote-tracking branch 'origin/master' into 2.4.0
Conflicts:
	rest_framework/fields.py
2014-07-26 00:06:56 +02:00
Tom Christie
299a8347e8 Merge pull request #1692 from davbo/patch-1
Update fields.md
2014-07-22 15:59:04 +02:00
Tom Christie
81d15aa9be Add link to drf-extra-fields. Closes #1698 2014-07-20 15:45:45 +01:00
Dave King
680fabe9dd Update fields.md
obj.__class__ will return the actual Class object, we want to serialise a string (accessed with obj.__class__.__name__)
2014-07-17 11:46:59 +01:00
Xavier Ordoquy
2489e38a06 Merge remote-tracking branch 'origin/master' into 2.4.0
Conflicts:
	.travis.yml
	docs/api-guide/viewsets.md
	rest_framework/serializers.py
	rest_framework/throttling.py
	tests/test_generics.py
	tests/test_serializers.py
	tox.ini
2014-06-23 14:02:45 +02:00
Ian Foote
1e7b5fd2c0 Document ChoiceField blank_display_value parameter 2014-05-20 14:55:00 +01:00
Xavier Ordoquy
d08536ad9d Merge remote-tracking branch 'origin/master' into 2.4.0
Conflicts:
	.travis.yml
	docs/api-guide/fields.md
	docs/api-guide/routers.md
	docs/topics/release-notes.md
	rest_framework/authentication.py
	rest_framework/serializers.py
	rest_framework/templatetags/rest_framework.py
	rest_framework/tests/test_authentication.py
	rest_framework/tests/test_filters.py
	rest_framework/tests/test_hyperlinkedserializers.py
	rest_framework/tests/test_serializer.py
	rest_framework/tests/test_testing.py
	rest_framework/utils/encoders.py
	tox.ini
2014-04-13 00:05:57 +02:00
Tom Christie
abe14c06f7 Minor docs tweak 2014-03-17 08:36:13 +00:00
Tom Christie
dddbff5931 Tweak DRF compound fields docs 2014-03-17 08:33:18 +00:00
Steven Cummings
c779dce3e4 Serializer fields section for 3rd-party packages
* Add new section to serializer fields page where we can list and link 3rd-party packages that provide more field types
* Add an entry for drf-compound-fields
2014-03-16 18:55:21 -05:00
Jeff Fein-Worton
a33eb4177e fixed typo (wrong "its") 2014-02-02 21:21:08 -08:00
meoooh
e437854a44 Update fields.md 2014-02-01 15:02:11 +09:00
Tom Christie
85d74fc86a Added write_only and write_only_fields. Refs #1306 2014-01-14 11:25:44 +00:00
Yuri Prezument
6e622d644c CharField - add allow_null argument 2014-01-12 10:53:54 +02:00
Yuri Prezument
052e236fde Fix URL/Slug Field signatures in docs 2014-01-09 18:12:30 +02:00
Omer Katz
c46106c961 Rephrased documentation changes according to feedback on IRC. 2013-11-27 14:47:37 +02:00
Omer Katz
2dce8d7a8a Recommend using Pillow instead of PIL. 2013-11-27 13:23:49 +02:00
Tom Christie
3765865b4b Update 'default' explanation. Closes #1239 2013-11-20 17:40:56 +00:00
Doğan Çeçen
fd2c291c4d Typo on api-guide/fields.md and serializers.py 2013-11-11 11:54:30 +02: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
Toby Champion
250dfef158 Changes 'python' to 'Python' when used in prose. 2013-06-12 14:51:17 -07:00
Tom Christie
ffa27b840f Fix ModelField docs. Closes #909. 2013-06-04 20:23:16 +01:00
Tom Christie
b15a6ccef2 Serializer field 'default' argument may be a callable 2013-06-02 20:12:49 +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
Tom Christie
78c53d530f Updating docs 2013-05-24 21:08:27 +01:00
Stephan Groß
ad436d966f Add DecimalField support 2013-04-15 13:02:18 +02:00
Tom Christie
92c929094c Version 2.2.5 2013-03-26 07:48:53 +00:00
Tom Christie
870d5c7d78 Merge pull request #744 from tomchristie/basic-bulk-edit
Basic bulk create and bulk update
2013-03-22 14:47:29 -07:00
Tom Christie
13794baf70 Bit of extra tidying and plenty of docs 2013-03-22 17:01:06 +00:00
Tom Christie
8adde506e8 Default date/time fields now return python date/time objects again by default 2013-03-21 08:41:54 +00:00
Tom Christie
1106596c80 Clean ups to datetime formatting 2013-03-06 12:19:39 +00:00
Tom Christie
4f7b028a0a Updating docs 2013-03-05 20:57:35 +00:00
Stephan Groß
a9d36d4726 Add docs update - part 1 2013-03-01 16:50:18 +01:00
Stephan Groß
9157db5da0 Add better date / datetime validation (pull 2)
addition to #631 with update to master + timefield support
2013-03-01 16:48:20 +01:00
Wiliam Souza
cd7f552540 Fixed a typo WritableField field name in docs 2013-02-26 10:43:33 -03:00
Andreas Pelme
5a5df18d18 Added a serializer TimeField 2013-02-14 21:19:51 +01:00
Tom Christie
1929159db1 Docs tweaks. 2013-01-29 09:15:16 +00:00
Tom Christie
a58145e20f Note auto_now, auto_now_add behavior. Refs #622. 2013-01-28 07:46:30 +00:00
Tom Christie
8fad0a727a Relation fields move into relations.py 2012-12-31 08:53:40 +00:00
Tom Christie
ff01ae3571 Version 2.1.8 2012-12-08 13:01:03 +00:00
Stephan Groß
6ba4df8a27 Merge remote-tracking branch 'upstream/master' into regex_field
Conflicts:
	docs/topics/release-notes.md
2012-11-21 11:56:34 +01:00
Stephan Groß
86484668f6 added RegexField 2012-11-20 15:38:50 +01:00
Jamie Matthews
5f4c385a86 Add example use of SerializerMethodField to docs 2012-11-20 13:25:21 +00:00
Jamie Matthews
3ab8c4966d Tweaks to SerializerMethodField docs 2012-11-19 17:24:08 +00:00
Jamie Matthews
de5b071d67 Add SerializerMethodField 2012-11-19 17:22:17 +00:00
Tom Christie
e801e21210 Merge pull request #422 from markotibold/max_length_for_modelserializers
Max length for modelserializers
2012-11-16 14:54:16 -08:00
Marko Tibold
f801e5d305 Simplified docs a bit for FileField and ImageField.
Added note about MultipartParser only supporting file uploads and Django's default upload handlers.
2012-11-16 23:44:55 +01:00
Marko Tibold
0076e2f462 Added brief docs for URLField and SlugField. 2012-11-16 23:23:34 +01:00