From 1aa1e83e03a32069bc5c281c1e0216cece98c419 Mon Sep 17 00:00:00 2001 From: Clinton Gormley Date: Sat, 25 Jan 2014 12:34:15 +0100 Subject: [PATCH] [DOCS] Updated the breaking changes for the fields param Closes #4888 --- docs/reference/migration/migrate_1_0.asciidoc | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/reference/migration/migrate_1_0.asciidoc b/docs/reference/migration/migrate_1_0.asciidoc index be53d64585c..269753c9d13 100644 --- a/docs/reference/migration/migrate_1_0.asciidoc +++ b/docs/reference/migration/migrate_1_0.asciidoc @@ -311,6 +311,13 @@ by disabling wildcard expansion on destructive actions. code. The only exception to this rule is when `fields` is used to retrieve metadata like the `routing` value, which are always singular. Metadata fields are always returned as scalars. ++ +The `fields` parameter is intended to be used for retrieving stored fields, +rather than for fields extracted from the `_source`. That means that it can no +longer be used to return whole objects and it no longer accepts the +`_source.fieldname` format. For these you should use the +<> +parameters instead. * Settings, like `index.analysis.analyzer.default` are now returned as proper nested JSON objects, which makes them easier to work with programatically: