honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[Docs] add deprecation warning for `delimited_payload_filter` renaming

This commit is contained in:
Christoph Büscher 2017-11-27 13:02:23 +01:00
parent 6323bb0d97
commit c4fe7d3f72
3 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/reference/analysis/tokenfilters/delimited-payload-tokenfilter.asciidoc
View File

@ -3,6 +3,13 @@
Named `delimited_payload`. Splits tokens into tokens and payload whenever a delimiter character is found. Named `delimited_payload`. Splits tokens into tokens and payload whenever a delimiter character is found.
[WARNING]
============================================
The older name `delimited_payload_filter` is deprecated and should not be used for new indices. Use `delimited_payload` instead.
============================================
Example: "the|1 quick|2 fox|3" is split by default into tokens `the`, `quick`, and `fox` with payloads `1`, `2`, and `3` respectively. Example: "the|1 quick|2 fox|3" is split by default into tokens `the`, `quick`, and `fox` with payloads `1`, `2`, and `3` respectively.
Parameters: Parameters:

2
modules/analysis-common/src/main/java/org/elasticsearch/analysis/common/LegacyDelimitedPayloadTokenFilterFactory.java
View File

@ -32,7 +32,7 @@ public class LegacyDelimitedPayloadTokenFilterFactory extends DelimitedPayloadTo
LegacyDelimitedPayloadTokenFilterFactory(IndexSettings indexSettings, Environment env, String name, Settings settings) { LegacyDelimitedPayloadTokenFilterFactory(IndexSettings indexSettings, Environment env, String name, Settings settings) {
super(indexSettings, env, name, settings); super(indexSettings, env, name, settings);
if (indexSettings.getIndexVersionCreated().onOrAfter(Version.V_7_0_0_alpha1)) { if (indexSettings.getIndexVersionCreated().onOrAfter(Version.V_6_2_0)) {
DEPRECATION_LOGGER.deprecated("Deprecated [delimited_payload_filter] used, replaced by [delimited_payload]"); DEPRECATION_LOGGER.deprecated("Deprecated [delimited_payload_filter] used, replaced by [delimited_payload]");
} }
} }

4
modules/analysis-common/src/test/resources/rest-api-spec/test/analysis-common/40_token_filters.yml
View File

@ -1028,8 +1028,8 @@
--- ---
"delimited_payload_filter": "delimited_payload_filter":
- skip: - skip:
version: " - 6.99.99" version: " - 6.1.99"
reason: delimited_payload_filter deprecated in 7.0, replaced by delimited_payload reason: delimited_payload_filter deprecated in 6.2, replaced by delimited_payload
features: "warnings" features: "warnings"
- do: - do: