|
| 1 | +* [UPGRADING](#upgrading) |
| 2 | + * [Upgrading from 2.x to 3.0](#upgrading-from-2x-to-30) |
| 3 | + * [Upgrading from 3.x to UNRELEASED](#upgrading-from-3x-to-unreleased) |
| 4 | + |
1 | 5 | # UPGRADING
|
2 | 6 |
|
3 |
| -## Upgrading 2.x to 3.0 |
| 7 | +## Upgrading from 2.x to 3.0 |
4 | 8 | ### URL Path Encoding
|
5 | 9 | - The default URL path encoding has been changed to be more conservative. Previously the `!`, `$`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `;`, `=`, `@` and `:` characters were left un-encoded, they will now be percent-encoded. If you require the previous behavior you can specify the `org.opensearch.path.encoding=HTTP_CLIENT_V4_EQUIV` system property.
|
6 | 10 |
|
@@ -704,4 +708,73 @@ After:
|
704 | 708 | - The `tBucketSerializer` property has been removed as it is unused.
|
705 | 709 |
|
706 | 710 | ### ExplainResponse
|
707 |
| -- The `explanation` property is now of type `Explanation` instead of `ExplanationDetail`. |
| 711 | +- The `explanation` property is now of type `Explanation` instead of `ExplanationDetail`. |
| 712 | + |
| 713 | +## Upgrading from 3.x to UNRELEASED |
| 714 | +### ExplainRequest |
| 715 | +- The `routing` property is now of type `List<String>` instead of `String`. |
| 716 | + |
| 717 | +### ExplainResponse |
| 718 | +- The `tDocumentSerializer` property has been removed as it is unused. |
| 719 | + |
| 720 | +### GetRequest |
| 721 | +- The `refresh` property has been corrected to be of type `Refresh` instead of `Boolean`. |
| 722 | +- The `routing` property is now of type `List<String>` instead of `String`. |
| 723 | + |
| 724 | +### GetResponse |
| 725 | +- The `GetResponse` class now extends a `GetResultBase` class instead of `GetResult`. |
| 726 | + |
| 727 | +### GetSourceRequest |
| 728 | +- The `refresh` property has been corrected to be of type `Refresh` instead of `Boolean`. |
| 729 | +- The `routing` property is now of type `List<String>` instead of `String`. |
| 730 | +- The `storedFields` property has been removed as it is not supported by OpenSearch. |
| 731 | + |
| 732 | +### ScrollResponse |
| 733 | +- The `ScrollResponse` class now extends `SearchResult` directly instead of via `SearchResponse`. |
| 734 | + |
| 735 | +### SearchResult |
| 736 | +- The `documents` property has been removed as it is not supported by OpenSearch. |
| 737 | +- The `maxScore` property has been removed as it is not supported by OpenSearch. |
| 738 | +- The `numReducePhases` property has been corrected to be of type `Integer` instead of `Long`. |
| 739 | +- The `tDocumentSerializer` property has been removed as it is unused. |
| 740 | + |
| 741 | +### CompletionSuggestOption |
| 742 | +- The `score` property has been corrected to be of type `Float` instead of `Double`. |
| 743 | + |
| 744 | +### SuggestVariant |
| 745 | +- The `_suggestionKind` method's naming has been corrected to `_suggestKind`. |
| 746 | +- The `_toSuggestion` method's naming has been corrected to `toSuggest`. |
| 747 | + |
| 748 | +### SuggestOptionBuilders |
| 749 | +- The `SuggestOptionBuilders` class has been removed. |
| 750 | + |
| 751 | +### SearchRequest |
| 752 | +- The `batchedReduceSize` property has been corrected to be of type `Integer` instead of `Long`. |
| 753 | +- The `indicesBoost` property is now of type `List<Map<String, Float>>` instead of `List<Map<String, Double>>`. |
| 754 | +- The `maxConcurrentShardRequests` property has been corrected to be of type `Integer` instead of `Long`. |
| 755 | +- The `minCompatibleShardNode` property has been removed as it is not supported by OpenSearch. |
| 756 | +- The `minScore` property has been corrected to be of type `Float` instead of `Double`. |
| 757 | +- The `preFilterShardSize` property has been corrected to be of type `Integer` instead of `Long`. |
| 758 | +- The `routing` property is now of type `List<String>` instead of `String`. |
| 759 | +- The `runtimeMappings` property has been removed as it is not supported by OpenSearch. |
| 760 | +- The `terminateAfter` property has been corrected to be of type `Integer` instead of `Long`. |
| 761 | + |
| 762 | +### core.search.Pit renamed to PointInTimeReference |
| 763 | +- The `Pit` class has been renamed to `PointInTimeReference`, this affects: |
| 764 | + - `SearchRequest`'s `pit` field. |
| 765 | +- The `keepAlive` property has been corrected to be of type `Time` instead of `String`. |
| 766 | + |
| 767 | +### SearchTemplateRequest |
| 768 | +- The `routing` property is now of type `List<String>` instead of `String`. |
| 769 | + |
| 770 | +### LifecycleOperationMode |
| 771 | +- The `LifecycleOperationMode` enum has been removed as it is no longer used. |
| 772 | + |
| 773 | +### RuntimeField |
| 774 | +- The `RuntimeField` class has been removed as it is not supported by OpenSearch. |
| 775 | + |
| 776 | +### RuntimeFieldType |
| 777 | +- The `RuntimeFieldType` class has been removed as it is not supported by OpenSearch. |
| 778 | + |
| 779 | +### MultiSearchItem |
| 780 | +- The `MultiSearchItem` class now extends `SearchResult` directly instead of via `SearchResponse`. |
0 commit comments