Deprecate search:includeFrozen parameter (#114578)

This commit is contained in:
Lukas Olson 2021-10-12 15:35:49 -07:00 committed by GitHub
parent 3a8eb8a6e4
commit a070aafe93
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 0 deletions

View file

@ -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. be inconsistent because different shards might be in different refresh states.
[[search-includefrozen]]`search:includeFrozen`:: [[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 Includes {ref}/frozen-indices.html[frozen indices] in results. Searching through
frozen indices might increase the search time. This setting is off by default. frozen indices might increase the search time. This setting is off by default.
Users must opt-in to include frozen indices. Users must opt-in to include frozen indices.

View file

@ -269,6 +269,12 @@ export function getUiSettings(): Record<string, UiSettingsParams<unknown>> {
target="_blank" rel="noopener">frozen indices</a> in results if enabled. Searching through frozen indices target="_blank" rel="noopener">frozen indices</a> in results if enabled. Searching through frozen indices
might increase the search time.`, might increase the search time.`,
value: false, 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'], category: ['search'],
schema: schema.boolean(), schema: schema.boolean(),
}, },