From a070aafe939186c58ce7c00ae8228938595ce785 Mon Sep 17 00:00:00 2001 From: Lukas Olson Date: Tue, 12 Oct 2021 15:35:49 -0700 Subject: [PATCH] Deprecate search:includeFrozen parameter (#114578) --- docs/management/advanced-options.asciidoc | 1 + src/plugins/data/server/ui_settings.ts | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc index 6fd83e8af3d1..6bac5e7940db 100644 --- a/docs/management/advanced-options.asciidoc +++ b/docs/management/advanced-options.asciidoc @@ -426,6 +426,7 @@ because requests can be spread across all shard copies. However, results might be inconsistent because different shards might be in different refresh states. [[search-includefrozen]]`search:includeFrozen`:: +**This setting is deprecated and will not be supported as of 9.0.** Includes {ref}/frozen-indices.html[frozen indices] in results. Searching through frozen indices might increase the search time. This setting is off by default. Users must opt-in to include frozen indices. diff --git a/src/plugins/data/server/ui_settings.ts b/src/plugins/data/server/ui_settings.ts index 284a381f063d..19ecde71e6a1 100644 --- a/src/plugins/data/server/ui_settings.ts +++ b/src/plugins/data/server/ui_settings.ts @@ -269,6 +269,12 @@ export function getUiSettings(): Record> { target="_blank" rel="noopener">frozen indices in results if enabled. Searching through frozen indices might increase the search time.`, value: false, + deprecation: { + message: i18n.translate('data.advancedSettings.search.includeFrozenTextDeprecation', { + defaultMessage: 'This setting is deprecated and will be removed in Kibana 9.0.', + }), + docLinksKey: 'kibanaSearchSettings', + }, category: ['search'], schema: schema.boolean(), },