From 91b74dab621bb8d9a8bc3e3ea21b738a2950d82a Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Thu, 23 Sep 2021 18:30:08 -0400 Subject: [PATCH 1/5] [DOCS] Document empty first line support for msearch API Adds an 8.0 breaking change for PR #41011 --- .../migration/migrate_8_0/search.asciidoc | 50 +++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/docs/reference/migration/migrate_8_0/search.asciidoc b/docs/reference/migration/migrate_8_0/search.asciidoc index f8be8708ab983..dca591db45d87 100644 --- a/docs/reference/migration/migrate_8_0/search.asciidoc +++ b/docs/reference/migration/migrate_8_0/search.asciidoc @@ -6,6 +6,56 @@ //Installation and Upgrade Guide //tag::notable-breaking-changes[] +[[msearch-empty-line-support]] +.The multi search API now parses an empty first line as action metadata in text files. +[%collapsible] +==== +*Details* + +The multi search API now supports an empty first line when you provide the +request body as a text file, such as when using curl's `--data-binary` flag. The +API parses an empty first line as empty action metadata. For example, the API +now supports a file with the following contents: + +[source,js] +---- + +{ "query": {"match": { "my-field": "foo" }}} + +{ "query": {"match_all": {}}} +---- +// NOTCONSOLE + +The API no longer supports text files that contain: + +* An empty first line followed by a line containing only `{}`. For example: ++ +[source,js] +---- + +{} +{ "query": {"match": { "my-field": "foo" }}} + +{ "query": {"match_all": {}}} +---- +// NOTCONSOLE + +* An empty first line followed by another empty line. For example: ++ +[source,js] +---- + + +{ "query": {"match": { "my-field": "foo" }}} + +{ "query": {"match_all": {}}} +---- +// NOTCONSOLE + +*Impact* + +Discontinue use of unsupported files with the multi search API. Requests +that include an unsupported file will return an error. +==== + [[remove-unmapped-type-string]] .The `unmapped_type: string` sort option has been removed. [%collapsible] From dbc078adc8fbbe9cce4f938aecd288b890278548 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Thu, 23 Sep 2021 18:58:12 -0400 Subject: [PATCH 2/5] Remove code blocks --- .../migration/migrate_8_0/search.asciidoc | 37 ++----------------- 1 file changed, 3 insertions(+), 34 deletions(-) diff --git a/docs/reference/migration/migrate_8_0/search.asciidoc b/docs/reference/migration/migrate_8_0/search.asciidoc index dca591db45d87..2a35a90af0c32 100644 --- a/docs/reference/migration/migrate_8_0/search.asciidoc +++ b/docs/reference/migration/migrate_8_0/search.asciidoc @@ -13,43 +13,12 @@ *Details* + The multi search API now supports an empty first line when you provide the request body as a text file, such as when using curl's `--data-binary` flag. The -API parses an empty first line as empty action metadata. For example, the API -now supports a file with the following contents: - -[source,js] ----- - -{ "query": {"match": { "my-field": "foo" }}} - -{ "query": {"match_all": {}}} ----- -// NOTCONSOLE +API parses an empty first line as empty action metadata. The API no longer supports text files that contain: -* An empty first line followed by a line containing only `{}`. For example: -+ -[source,js] ----- - -{} -{ "query": {"match": { "my-field": "foo" }}} - -{ "query": {"match_all": {}}} ----- -// NOTCONSOLE - -* An empty first line followed by another empty line. For example: -+ -[source,js] ----- - - -{ "query": {"match": { "my-field": "foo" }}} - -{ "query": {"match_all": {}}} ----- -// NOTCONSOLE +* An empty first line followed by a line containing only `{}`. +* An empty first line followed by another empty line. *Impact* + Discontinue use of unsupported files with the multi search API. Requests From 3dca7632f8995084767153b1c05cce79c7a01329 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Thu, 23 Sep 2021 19:02:11 -0400 Subject: [PATCH 3/5] Reword --- docs/reference/migration/migrate_8_0/search.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/migration/migrate_8_0/search.asciidoc b/docs/reference/migration/migrate_8_0/search.asciidoc index 2a35a90af0c32..7c84318d2e3f7 100644 --- a/docs/reference/migration/migrate_8_0/search.asciidoc +++ b/docs/reference/migration/migrate_8_0/search.asciidoc @@ -21,7 +21,7 @@ The API no longer supports text files that contain: * An empty first line followed by another empty line. *Impact* + -Discontinue use of unsupported files with the multi search API. Requests +Discontinue use of unsupported text files with the multi search API. Requests that include an unsupported file will return an error. ==== From 283473279c0f4e550b88fb59f7e7b11e42b90498 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Fri, 24 Sep 2021 12:57:18 -0400 Subject: [PATCH 4/5] Reword --- docs/reference/migration/migrate_8_0/search.asciidoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/reference/migration/migrate_8_0/search.asciidoc b/docs/reference/migration/migrate_8_0/search.asciidoc index 7c84318d2e3f7..f2f99057bbb89 100644 --- a/docs/reference/migration/migrate_8_0/search.asciidoc +++ b/docs/reference/migration/migrate_8_0/search.asciidoc @@ -11,9 +11,9 @@ [%collapsible] ==== *Details* + -The multi search API now supports an empty first line when you provide the -request body as a text file, such as when using curl's `--data-binary` flag. The -API parses an empty first line as empty action metadata. +The multi search API now parses an empty first line as empty action metadata +when you provide the request body as a text file, such as when using curl's +`--data-binary` flag. The API no longer supports text files that contain: From 6bf847288198bcab3cecd2ba904afa884e3bedca Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Fri, 24 Sep 2021 12:59:24 -0400 Subject: [PATCH 5/5] Reword impact --- docs/reference/migration/migrate_8_0/search.asciidoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/reference/migration/migrate_8_0/search.asciidoc b/docs/reference/migration/migrate_8_0/search.asciidoc index f2f99057bbb89..20764fe968bae 100644 --- a/docs/reference/migration/migrate_8_0/search.asciidoc +++ b/docs/reference/migration/migrate_8_0/search.asciidoc @@ -12,7 +12,7 @@ ==== *Details* + The multi search API now parses an empty first line as empty action metadata -when you provide the request body as a text file, such as when using curl's +when you provide a text file as the request body, such as when using curl's `--data-binary` flag. The API no longer supports text files that contain: @@ -21,8 +21,8 @@ The API no longer supports text files that contain: * An empty first line followed by another empty line. *Impact* + -Discontinue use of unsupported text files with the multi search API. Requests -that include an unsupported file will return an error. +Don't provide an unsupported text file to the multi search API. Requests that +include an unsupported file will return an error. ==== [[remove-unmapped-type-string]]