diff --git a/CHANGELOG-9.x.md b/CHANGELOG-9.x.md deleted file mode 100644 index ac6004d0f8..0000000000 --- a/CHANGELOG-9.x.md +++ /dev/null @@ -1,29 +0,0 @@ -# CHANGELOG 9.x - -## Gem - -The size of both `elasticsearch` and `elasticsearch-api` gems will be smaller, since some unnecessary files that were being included in the gem have been removed. There's also been a lot of old code cleanup for `9.x`. - -The required Ruby version is set to `2.6` to keep compatiblity wit JRuby 9.3. However, we only test the code against currently supported Ruby versions. - -## Elasticsearch Serverless - -The CI build now runs tests to ensure compatibility with Elasticsearch Serverless. You can use this gem for your Serverless deployments. - -## Elasticsearch API - -* The source code is now based on `elasticsearch-specification`, so the API documentation is much more detailed and extensive. -* Scroll APIs: Since sending the `scroll_id` as a parameter was deprecated, now it needs to be sent in the body for `clear_scroll`, `scroll`. -* `indices.get_field_mapping` - `:fields` is a required parameter. -* The functions in `utils.rb` that had names starting with double underscore have been renamed to remove the underscores. - -### Development - -#### Testing - -The gem migrated away from the Elasticsearch REST API tests and test runner in CI. We now run the [Elasticsearch Client tests](https://github.com/elastic/elasticsearch-clients-tests/) with the [Elasticsearch Tests Runner](https://github.com/elastic/es-test-runner-ruby). This gives us more control on what we're testing and makes the Buildkite build way faster in Pull Requests and scheduled builds. - -#### Rake tasks - -* Some old rake tasks that were not being used have been removed. The rest were streamlined, the `es` namespace has been streamlined to make it easier to run Elasticsearch with Docker during development. The `docker` namespace was merged into `es`. -* Elasticsearch's REST API Spec tests can still be ran with `rake test:deprecated:rest_api` and setting the corresponding value for the environment variable `TEST_SUITE` ('platinum' or 'free'). diff --git a/docs/reference/transport.md b/docs/reference/transport.md index fa38c71f2d..24cecadde4 100644 --- a/docs/reference/transport.md +++ b/docs/reference/transport.md @@ -21,9 +21,11 @@ Currently these libraries are supported: * [Typhoeus](https://github.com/typhoeus/typhoeus) * [HTTPClient](https://rubygems.org/gems/httpclient) * [Net::HTTP::Persistent](https://rubygems.org/gems/net-http-persistent) +* [Excon](https://github.com/excon/faraday-excon) +* [Async::HTTP](https://github.com/socketry/async-http-faraday) ::::{note} -Use [Typhoeus](https://github.com/typhoeus/typhoeus) v1.4.0 or up since older versions are not compatible with Faraday 1.0. +If using [Typhoeus](https://github.com/typhoeus/typhoeus), v1.4.0 or up is needed, since older versions are not compatible with Faraday 1.0. :::: diff --git a/docs/release-notes/breaking-changes.md b/docs/release-notes/breaking-changes.md index fba96055e4..29746c6949 100644 --- a/docs/release-notes/breaking-changes.md +++ b/docs/release-notes/breaking-changes.md @@ -17,12 +17,28 @@ To learn how to upgrade, check out . % **Action**
Steps for mitigating deprecation impact. % :::: -% ## 9.0.0 [elasticsearch-ruby-client-900-breaking-changes] -% **Release date:** March 25, 2025 +## 9.0.0 [elasticsearch-ruby-client-900-breaking-changes] -% ::::{dropdown} Title of breaking change -% Description of the breaking change. -% For more information, check [PR #](PR link). -% **Impact**
Impact of the breaking change. -% **Action**
Steps for mitigating deprecation impact. -% :::: \ No newline at end of file +### Scroll APIs need to send scroll_id in request body + +Sending the `scroll_id` as a parameter has been deprecated since version 7.0.0. It needs to be specified in the request body for `clear_scroll` and `scroll`. + +**Impact**
+ +Client code using `clear_scroll` or `scroll` APIs and the deprecated `scroll_id` as a parameter needs to be updated. + +**Action**
+ +If you are using the `clear_scroll` or `scroll` APIs, and sending the `scroll_id` as a parameter, you need to update your code to send the `scroll_id` as part of the request body: +```ruby +# Before: +client.clear_scroll(scroll_id: scroll_id) +# Now: +client.clear_scroll(body: { scroll_id: scroll_id }) + +# Before: +client.scroll(scroll_id: scroll_id) +# Now: +client.scroll(body: { scroll_id: scroll_id }) +``` +% :::: diff --git a/docs/release-notes/deprecations.md b/docs/release-notes/deprecations.md index 4c27fcb8bd..04c3e83766 100644 --- a/docs/release-notes/deprecations.md +++ b/docs/release-notes/deprecations.md @@ -7,6 +7,10 @@ Review the deprecated functionality for your Elasticsearch Ruby Client version. To learn how to upgrade, check out . +## 9.0.0 [elasticsearch-ruby-client-900-deprecations] + +_No deprecations_ + % ## Next version [elasticsearch-ruby-client-versionnext-deprecations] % **Release date:** Month day, year @@ -25,4 +29,4 @@ To learn how to upgrade, check out . % For more information, check [PR #](PR link). % **Impact**
Impact of deprecation. % **Action**
Steps for mitigating deprecation impact. -% :::: \ No newline at end of file +% :::: diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md index c2d13a705e..949f173eec 100644 --- a/docs/release-notes/index.md +++ b/docs/release-notes/index.md @@ -24,4 +24,33 @@ To check for security updates, go to [Security announcements for the Elastic sta ### Features and enhancements [elasticsearch-ruby-client-900-features-enhancements] -### Fixes [elasticsearch-ruby-client-900-fixes] \ No newline at end of file +Ruby 3.2 and up are tested and supported for 9.0. Older versions of Ruby have reached their end of life. We follow Ruby’s own maintenance policy and officially support all currently maintained versions per [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/). The required Ruby version is set to `2.6` to keep compatiblity wit JRuby 9.3. However, we only test the code against currently supported Ruby versions. + +#### Gem + +The size of both `elasticsearch` and `elasticsearch-api` gems is smaller than in previous versions. Some unnecessary files that were being included in the gem have now been removed. There has also been a lot of old code cleanup for the `9.x` branch. + +#### Elasticsearch Serverless + +With the release of `9.0`, the [Elasticsearch Serverless](https://github.com/elastic/elasticsearch-serverless-ruby) client has been discontinued. You can use this client to build your Elasticsearch Serverless Ruby applications. The Elasticsearch Serverless API is fully supported. The CI build for Elasticsearch Ruby runs tests to ensure compatibility with Elasticsearch Serverless. + +#### Elasticsearch API + +* The source code is now generated from [`elasticsearch-specification`](https://github.com/elastic/elasticsearch-specification/), so the API documentation is much more detailed and extensive. The value `Elasticsearch::ES_SPECIFICATION_COMMIT` is updated with the commit hash of elasticsearch-specification in which the code is based every time it's generated. +* The API code has been updated for compatibility with Elasticsearch API v 9.0. +* `indices.get_field_mapping` - `:fields` is a required parameter. +* `knn_search` - This API has been removed. It was only ever experimental and was deprecated in v`8.4`. It isn't supported in 9.0, and only works when the header `compatible-with=8` is set. The search API should be used for all knn queries. +* The functions in `utils.rb` that had names starting with double underscore have been renamed to remove these (e.g. `__listify` to `listify`). +* **Namespaces clean up**: The API namespaces are now generated dynamically based on the elasticsearch-specification. As such, some deprecated namespace files have been removed from the codebase: + * The `rollup` namespace was removed. The rollup feature was never GA-ed, it has been deprecated since `8.11.0` in favor of downsampling. + * The `data_frame_deprecated`, `remote` namespace files have been removed, no APIs were available. + * The `shutdown` namespace was removed. It is designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + +##### Testing + +The gem `elasticsearch-api` migrated away from the Elasticsearch REST API tests and test runner in CI. We now run the [Elasticsearch Client tests](https://github.com/elastic/elasticsearch-clients-tests/) with the [Elasticsearch Tests Runner](https://github.com/elastic/es-test-runner-ruby). This gives us more control on what we're testing and makes the Buildkite build way faster in Pull Requests and scheduled builds. + +### Fixes [elasticsearch-ruby-client-900-fixes] + +* Some old rake tasks that were not being used have been removed. The rest were streamlined, the `es` namespace has been streamlined to make it easier to run Elasticsearch with Docker during development. The `docker` task namespace was merged into `es`. +* Elasticsearch's REST API Spec tests can still be ran with `rake test:deprecated:rest_api` and setting the corresponding value for the environment variable `TEST_SUITE` ('platinum' or 'free'). diff --git a/docs/release-notes/known-issues.md b/docs/release-notes/known-issues.md index 91ff1765df..5784c8adc7 100644 --- a/docs/release-notes/known-issues.md +++ b/docs/release-notes/known-issues.md @@ -5,6 +5,10 @@ navigation_title: "Elasticsearch Ruby Client" # Elasticsearch Ruby Client known issues [elasticsearch-ruby-client-known-issues] +## 9.0.0 + +_No known issues_ + % Use the following template to add entries to this page. % :::{dropdown} Title of known issue @@ -17,4 +21,4 @@ navigation_title: "Elasticsearch Ruby Client" % **Resolved** % On [Month/Day/Year], this issue was resolved. -::: \ No newline at end of file +% :::