Elasticsearch Ruby Client release notes

Review the changes, fixes, and more in each version of Elasticsearch Ruby Client.

To check for security updates, go to Security announcements for the Elastic stack.

• Adds ccr alias for cross_cluster_replication and slm alias for snapshot_lifecycle_management.
• Tested for JRuby 10.0.0.
• General updates in source code docs.

• Udpates setting Accept and Content-Type headers as to not duplicate or overwrite user set headers #2666.

• The request headers were updated for Elasticsearch v9: compatible-with=9 #2660.

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. The required Ruby version is set to 2.6 to keep compatibility with JRuby 9.3. However, we only test the code against currently supported Ruby versions.

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.

With the release of 9.0, the Elasticsearch Serverless 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.

• The source code is now generated from 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 v8.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.

The gem elasticsearch-api migrated away from the Elasticsearch REST API tests and test runner in CI. We now run the Elasticsearch Client tests with the Elasticsearch Tests Runner. This gives us more control on what we're testing and makes the Buildkite way faster in pull requests and scheduled builds.

• 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').