Backward compatible change for implemented query types RegexpQuery, WildcardQuery, PrefixQuery, MultiMatchQuery, MatchQuery, MatchBoolPrefixQuery, FuzzyQuery and ErrorCause (opensearch-project#325)

* Backward Incompatible change for implemented query types RegexpQuery, WildcardQuery, PrefixQuery, MultiMatchQuery, MatchQuery, MatchBoolPrefixQuery, FuzzyQuery and ErrorCause

Signed-off-by: xil <fridalu66@gmail.com>

* change suffix from enum to deprecated

Signed-off-by: xil <fridalu66@gmail.com>

---------

Signed-off-by: xil <fridalu66@gmail.com>

Author: lucy66hw

CHANGELOG.md

@@ -10,7 +10,8 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Preprocessing - Support x-protobuf-required to enforce required protobuf field and convert oneOf properties pattern to min/max Properties = 1 ([#318](https://github.com/opensearch-project/opensearch-protobufs/pull/318))
 
 ### Changed
-- Backward Incompatible change for unimplemented query types `ScriptScoreQuery`, `SimpleQueryStringQuery`, `DisMaxQuery`, `IntervalsQuery`, `QueryStringQuery` and `TermsAggregation`
+- Backward Incompatible change for unimplemented query types `ScriptScoreQuery`, `SimpleQueryStringQuery`, `DisMaxQuery`, `IntervalsQuery`, `QueryStringQuery` and `TermsAggregation` ([#324](https://github.com/opensearch-project/opensearch-protobufs/pull/324))
+- Backward Incompatible change for implemented query types `RegexpQuery`, `WildcardQuery`, `PrefixQuery`, `MultiMatchQuery`, `MatchQuery`, `MatchBoolPrefixQuery`, `FuzzyQuery` and `ErrorCause` ([#325](https://github.com/opensearch-project/opensearch-protobufs/pull/325))
 
 ### Removed
 - Removed unused messages ([#319](https://github.com/opensearch-project/opensearch-protobufs/pull/319))

protos/schemas/common.proto

@@ -193,13 +193,6 @@ message StringArray{
   repeated string string_array = 1;
 }
 
-message StringOrStringArray {
-  oneof string_or_string_array{
-    string string = 1;
-    StringArray string_array = 2;
-  }
-}
-
 message SourceConfig {
 
   oneof source_config{
@@ -240,7 +233,7 @@ message ErrorCause {
   optional ObjectMap metadata = 7;
 
   // [optional]
-  map<string, StringOrStringArray> header = 8;
+  map<string, StringArray> header = 8;
 }
 message ShardStatistics {
   // [required] Number of shards that failed to execute the request. Note that shards that are not allocated will be considered neither successful nor failed. Having failed+successful less than total is thus an indication that some of the shards were not allocated.
@@ -1131,14 +1124,16 @@ message WildcardQuery {
   // [optional] Allows case insensitive matching of the pattern with the indexed field values when set to `true`. Default is `false` which means the case sensitivity of matching depends on the underlying field's mapping.
   optional bool case_insensitive = 4;
 
-  optional MultiTermQueryRewrite rewrite = 5;
+  optional MultiTermQueryRewrite rewrite_deprecated = 5 [deprecated = true];
 
   // [optional] Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set.
   optional string value = 6;
 
   // [optional] Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set.
   optional string wildcard = 7;
 
+  optional string rewrite = 8;
+
 }
 
 enum MultiTermQueryRewrite {
@@ -1249,7 +1244,7 @@ message MatchQuery {
   // [optional] The number of character edits (insertions, deletions, substitutions, or transpositions) that it takes to change one word to another when determining whether a term matched a value. For example, the distance between wined and wind is 1. Valid values are non-negative integers or AUTO.
   optional Fuzziness fuzziness = 7;
   // [optional] Determines how OpenSearch rewrites the query. Default is constant_score.
-  optional MultiTermQueryRewrite fuzzy_rewrite = 8;
+  optional MultiTermQueryRewrite fuzzy_rewrite_deprecated = 8 [deprecated = true];
   // [optional] Setting fuzzy_transpositions to true (default) adds swaps of adjacent characters to the insert, delete, and substitute operations of the fuzziness option. For example, the distance between wind and wnid is 1 if fuzzy_transpositions is true (swap “n” and “i”) and 2 if it is false (delete “n”, insert “n”). If fuzzy_transpositions is false, rewind and wnid have the same distance (2) from wind, despite the more human-centric opinion that wnid is an obvious typo. The default(true) is a good choice for most use cases.
   optional bool fuzzy_transpositions = 9;
   // [optional] Setting lenient to true ignores data type mismatches between the query and the document field. For example, a query string of "8.2" could match a field of type float. Default is false.
@@ -1264,6 +1259,8 @@ message MatchQuery {
   optional int32 prefix_length = 14;
   // [optional] In some cases, the analyzer removes all terms from a query string. For example, the stop analyzer removes all terms from the string an but this. In those cases, zero_terms_query specifies whether to match no documents (none) or all documents (all). Valid values are none and all. Default is none.
   optional ZeroTermsQuery zero_terms_query = 15;
+  // [optional] Determines how OpenSearch rewrites the query. Default is constant_score.
+  optional string fuzzy_rewrite = 16;
 }
 
 message BoolQuery {
@@ -1593,9 +1590,11 @@ message PrefixQuery {
   // [optional] Query name for query tagging.
   optional string x_name = 4;
   // [optional] Determines how OpenSearch rewrites the query. Default is constant_score.
-  optional MultiTermQueryRewrite rewrite = 5;
+  optional MultiTermQueryRewrite rewrite_deprecated = 5 [deprecated = true];
   // [optional] Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`. Default is `false` which means the case sensitivity of matching depends on the underlying field's mapping.
   optional bool case_insensitive = 6;
+  // [optional] Determines how OpenSearch rewrites the query. Default is constant_score.
+  optional string rewrite = 7;
 }
 
 enum TermsQueryValueType {
@@ -1675,7 +1674,10 @@ message RegexpQuery {
   optional int32 max_determinized_states = 7;
 
   // [optional] Determines how OpenSearch rewrites and scores multi-term queries. Valid values are constant_score, scoring_boolean, constant_score_boolean, top_terms_N, top_terms_boost_N, and top_terms_blended_freqs_N. Default is constant_score.
-  optional MultiTermQueryRewrite rewrite = 8;
+  optional MultiTermQueryRewrite rewrite_deprecated = 8 [deprecated = true];
+
+  // [optional] Determines how OpenSearch rewrites and scores multi-term queries. Valid values are constant_score, scoring_boolean, constant_score_boolean, top_terms_N, top_terms_boost_N, and top_terms_blended_freqs_N. Default is constant_score.
+  optional string rewrite = 9;
 }
 
 message TermQuery {
@@ -1932,11 +1934,13 @@ message FuzzyQuery {
   // [optional] The number of leading characters that are not considered in fuzziness. Default is 0.
   optional int32 prefix_length = 6;
   // [optional] Determines how OpenSearch rewrites the query. Default is constant_score.
-  optional MultiTermQueryRewrite rewrite = 7;
+  optional MultiTermQueryRewrite rewrite_deprecated = 7 [deprecated = true];
   // [optional] Specifies whether to allow transpositions of two adjacent characters (ab to ba) as edits. Default is true.
   optional bool transpositions = 8;
   // [optional] The number of character edits (insert, delete, substitute) needed to change one word to another when determining whether a term matched a value.
   optional Fuzziness fuzziness = 9;
+  // [optional] Determines how OpenSearch rewrites the query. Default is constant_score.
+  optional string rewrite = 10;
 }
 
 message Fuzziness{
@@ -2035,7 +2039,7 @@ message MatchBoolPrefixQuery {
   // [optional] The number of character edits (insert, delete, substitute) that it takes to change one word to another when determining whether a term matched a value. For example, the distance between wined and wind is 1. The default, AUTO, chooses a value based on the length of each term and is a good choice for most use cases.
   optional Fuzziness fuzziness = 6;
   // [optional] Determines how OpenSearch rewrites the query. Default is constant_score.
-  optional MultiTermQueryRewrite fuzzy_rewrite = 7;
+  optional MultiTermQueryRewrite fuzzy_rewrite_deprecated = 7 [deprecated = true];
   // [optional] Setting fuzzy_transpositions to true (default) adds swaps of adjacent characters to the insert, delete, and substitute operations of the fuzziness option. For example, the distance between wind and wnid is 1 if fuzzy_transpositions is true (swap “n” and “i”) and 2 if it is false (delete “n”, insert “n”). If fuzzy_transpositions is false, rewind and wnid have the same distance (2) from wind, despite the more human-centric opinion that wnid is an obvious typo. The default(true) is a good choice for most use cases.
   optional bool fuzzy_transpositions = 8;
   // [optional] The maximum number of terms to which the query can expand. Fuzzy queries “expand to” a number of matching terms that are within the distance specified in fuzziness. Then OpenSearch tries to match those terms. Default is 50.
@@ -2046,6 +2050,8 @@ message MatchBoolPrefixQuery {
   optional Operator operator = 11;
   // [optional] The number of leading characters that are not considered in fuzziness. Default is 0.
   optional int32 prefix_length = 12;
+  // [optional] Determines how OpenSearch rewrites the query. Default is constant_score.
+  optional string fuzzy_rewrite = 13;
 }
 
 message MatchNoneQuery {
@@ -2122,7 +2128,7 @@ message MultiMatchQuery {
   repeated string fields = 6;
 
   // [optional] Determines how OpenSearch rewrites the query. Valid values are constant_score, scoring_boolean, constant_score_boolean, top_terms_N, top_terms_boost_N, and top_terms_blended_freqs_N. If the fuzziness parameter is not 0, the query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default. Default is constant_score.
-  optional MultiTermQueryRewrite fuzzy_rewrite = 7;
+  optional MultiTermQueryRewrite fuzzy_rewrite_deprecated = 7 [deprecated = true];
 
   // [optional] The number of character edits (insert, delete, substitute) that it takes to change one word to another when determining whether a term matched a value.
   optional Fuzziness fuzziness = 8;
@@ -2157,6 +2163,8 @@ message MultiMatchQuery {
 
   // [optional] In some cases, the analyzer removes all terms from a query string. For example, the stop analyzer removes all terms from the string an but this. In those cases, zero_terms_query specifies whether to match no documents (none) or all documents (all). Valid values are none and all. Default is none.
   optional ZeroTermsQuery zero_terms_query = 18;
+  // [optional] Determines how OpenSearch rewrites the query. Valid values are constant_score, scoring_boolean, constant_score_boolean, top_terms_N, top_terms_boost_N, and top_terms_blended_freqs_N. If the fuzziness parameter is not 0, the query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default. Default is constant_score.
+  optional string fuzzy_rewrite = 19;
 }
 
 message FieldValueFactorScoreFunction {