Skip to content

[DOCS] Spruce up release notes #1072

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Sep 26, 2025
Merged

[DOCS] Spruce up release notes #1072

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2fdba8a
Edits for consistency and reverse chron
marciw Sep 25, 2025
379585e
missing word
marciw Sep 25, 2025
5a15314
spruce all the things
marciw Sep 25, 2025
639e64c
^^
marciw Sep 25, 2025
872fcbb
Clarify known issue
marciw Sep 25, 2025
009b85a
Clarify dependency issue
marciw Sep 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/release-notes/9-0-0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ navigation_title: "9.0.0"

Discover what changed in the 9.0.0 version of the Java client.

### Breaking changes [elasticsearch-java-client-900-breaking-changes]
## Breaking changes [elasticsearch-java-client-900-breaking-changes]

::::{dropdown} Java version update
While previous versions of the client used to target Java 8, from version 9.0 forward the client will target Java 17.
Expand Down Expand Up @@ -353,7 +353,7 @@ For `DenseVectorProperty`, choose the Enum value that matches the old String.
::::


### Features and enhancements [elasticsearch-java-client-900-features-enhancements]
## Features and enhancements [elasticsearch-java-client-900-features-enhancements]

::::{dropdown} New ElasticsearchClient builder
ElasticsearchClient now can be created with just a few lines of code:
Expand Down Expand Up @@ -465,6 +465,6 @@ Example with `Aggregation`, where the `aggregations` field can now accept `Avera
::::


### Deprecations [elasticsearch-java-client-900-deprecations]
## Deprecations [elasticsearch-java-client-900-deprecations]

Nothing was deprecated in this version of the client.
18 changes: 13 additions & 5 deletions docs/release-notes/9-0-4.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,16 @@ navigation_title: "9.0.4"
---
# Elasticsearch Java Client 9.0.4 [elasticsearch-java-client-904]

Discover what changed in the 9.0.4 version of the java client.
Discover what changed in the 9.0.4 version of the Java client.

### Features and enhancements [elasticsearch-java-client-904-features-enhancements]
## Breaking changes [elasticsearch-java-client-904-breaking-changes]

::::{dropdown} Added callbacks to Rest5Client builder
Rest5ClientBuilder now has the same level of in depth configuration the Legacy RestClientBuilder has, allowing to customize the underlying Apache HttpClient through callback functions; for example, this is how to configure the IOReactor's thread count:
There are no breaking changes in this version of the client.

## Features and enhancements [elasticsearch-java-client-904-features-enhancements]

### Added callbacks to Rest5ClientBuilder
`Rest5ClientBuilder` now has the same level of in-depth configuration as the legacy `RestClientBuilder`, allowing you to customize the underlying Apache `HttpClient` through callback functions. For example, here's how to configure the `IOReactor` thread count:
```java
Rest5ClientBuilder builder = Rest5Client
.builder(new HttpHost("localhost", 9200))
Expand All @@ -18,7 +22,7 @@ Rest5ClientBuilder builder = Rest5Client
)
);
```
And this is how to customize the response timeout:
Here's how to customize the response timeout:
```java
Rest5ClientBuilder builder = Rest5Client
.builder(new HttpHost("localhost", 9200))
Expand All @@ -29,3 +33,7 @@ Rest5ClientBuilder builder = Rest5Client
);
```
::::

## Deprecations [elasticsearch-java-client-904-deprecations]

Nothing was deprecated in this version of the client.
6 changes: 3 additions & 3 deletions docs/release-notes/9-1-0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ navigation_title: "9.1.0"

Discover what changed in the 9.1.0 version of the Java client.

### Breaking changes [elasticsearch-java-client-910-breaking-changes]
## Breaking changes [elasticsearch-java-client-910-breaking-changes]

::::{dropdown} Map to NamedValue Highlight.fields
`fields` in `Highlight` was wrongly mapped as `List<Map>`, but the server doesn't actually accept more than one value, so the type has been changed to `List<NamedValue>`.
Expand Down Expand Up @@ -47,7 +47,7 @@ Example with `SearchRequest`:
**Action**<br> Replace the missing class with the new class name.
::::

### Features and enhancements [elasticsearch-java-client-910-features-enhancements]
## Features and enhancements [elasticsearch-java-client-910-features-enhancements]

::::{dropdown} Opentelemetry update to stable conventions
Following the stable release of Opentelemetry's database conventions, the client was updated to use the correct attribute names.
Expand All @@ -70,6 +70,6 @@ catch (ElasticsearchException e){
More details in the PR: [#1041](https://github.com/elastic/elasticsearch-java/pull/1041)
::::

### Deprecations [elasticsearch-java-client-910-deprecations]
## Deprecations [elasticsearch-java-client-910-deprecations]

Nothing was deprecated in this version of the client.
11 changes: 8 additions & 3 deletions docs/release-notes/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,15 @@ mapped_pages:

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

To check for security updates, go to [Security announcements for the Elastic stack](https://discuss.elastic.co/c/announcements/security-announcements/31).
To check for security updates, refer to [Security announcements for the Elastic stack](https://discuss.elastic.co/c/announcements/security-announcements/31).

## 9.0.0
[Release notes](../release-notes/9-0-0.md)
To check for issues, refer to [Known issues](../release-notes/known-issues.md).

## 9.1.0
[Release notes](../release-notes/9-1-0.md)

## 9.0.4
[Release notes](../release-notes/9-0-4.md)

## 9.0.0
[Release notes](../release-notes/9-0-0.md)
53 changes: 28 additions & 25 deletions docs/release-notes/known-issues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,12 @@ navigation_title: "Known issues"

# Elasticsearch Java Client known issues [elasticsearch-java-client-known-issues]

We handle all of our issues in our [Github repo](https://github.com/elastic/elasticsearch-java/issues).
For detailed issues, refer to the [Java client repo](https://github.com/elastic/elasticsearch-java/issues).

### 8.16.7 [known-issues-8-16-7]

8.16.7 is the first patch released without a matching rest-client version, so the `elasticsearch-rest-client` dependency is missing, causing the following exception:
```
Could not resolve dependencies for project
[ERROR] dependency: org.elasticsearch.client:elasticsearch-rest-client:jar:8.16.7 (compile)
[ERROR] Could not find artifact org.elasticsearch.client:elasticsearch-rest-client:jar:8.16.7 in central (https://repo.maven.apache.org/maven2)
```
To use this version of the client, set the latest available version explicitly in the project:
```kotlin
// gradle
implementation("org.elasticsearch.client:elasticsearch-rest-client:8.16.6")
```
```xml
<!--maven-->
<dependency>
<groupId>org.elasticsearch.client</groupId>
<artifactId>elasticsearch-rest-client</artifactId>
<version>8.16.6</version>
</dependency>
```
## 9.0.0 [known-issues-9-0-0]

### 9.0.0 [known-issues-9-0-0]

The latest major version of the client doesn't depend on `elasticsearch-rest-client` anymore, as the new built in Rest5Client is available, but it does depend on the Apache `commons-logging` dependency, which is missing, causing the following exception:
The 9.0.0 version of the client uses the new built-in `Rest5Client`, instead of depending on `elasticsearch-rest-client`. But the 9.0.0 client still depends on Apache `commons-logging`, which causes the following exception when not available:
```
Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/commons/logging/LogFactory
at co.elastic.clients.transport.rest5_client.low_level.Rest5Client.<clinit>(Rest5Client.java:115)
Expand All @@ -40,7 +19,9 @@ Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/commons/lo
at co.elastic.clients.transport.ElasticsearchTransportConfig$Default.buildTransport(ElasticsearchTransportConfig.java:110)
at co.elastic.clients.elasticsearch.ElasticsearchClient.of(ElasticsearchClient.java:190)
```
To use the new Rest5Client, add the `commons-logging` dependency:
This problem was [fixed](https://github.com/elastic/elasticsearch-java/pull/1010) in 9.0.1.

To fix this issue in 9.0.0 and use the new `Rest5Client`, add the `commons-logging` dependency:
```kotlin
// gradle
implementation("commons-logging:commons-logging:1.3.5")
Expand All @@ -53,3 +34,25 @@ implementation("commons-logging:commons-logging:1.3.5")
<version>1.3.5</version>
</dependency>
```

## 8.16.7 [known-issues-8-16-7]

8.16.7 is the first patch released without a matching rest-client version. The `elasticsearch-rest-client` dependency is missing, causing the following exception:
```
Could not resolve dependencies for project
[ERROR] dependency: org.elasticsearch.client:elasticsearch-rest-client:jar:8.16.7 (compile)
[ERROR] Could not find artifact org.elasticsearch.client:elasticsearch-rest-client:jar:8.16.7 in central (https://repo.maven.apache.org/maven2)
```
To use this version of the client, set the latest available version explicitly in the project:
```kotlin
// gradle
implementation("org.elasticsearch.client:elasticsearch-rest-client:8.16.6")
```
```xml
<!--maven-->
<dependency>
<groupId>org.elasticsearch.client</groupId>
<artifactId>elasticsearch-rest-client</artifactId>
<version>8.16.6</version>
</dependency>
```
4 changes: 2 additions & 2 deletions docs/release-notes/toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
toc:
- file: index.md
- file: known-issues.md
- file: 9-0-0.md
- file: 9-0-4.md
- file: 9-1-0.md
- file: 9-0-4.md
- file: 9-0-0.md
Loading