Skip to content

Commit 2f01e29

Browse files
authored
Merge pull request #1072 from marciw/mw-rn-fix
[DOCS] Spruce up release notes
2 parents f1e9518 + 009b85a commit 2f01e29

File tree

6 files changed

+57
-41
lines changed

6 files changed

+57
-41
lines changed

docs/release-notes/9-0-0.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ navigation_title: "9.0.0"
55

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

8-
### Breaking changes [elasticsearch-java-client-900-breaking-changes]
8+
## Breaking changes [elasticsearch-java-client-900-breaking-changes]
99

1010
::::{dropdown} Java version update
1111
While previous versions of the client used to target Java 8, from version 9.0 forward the client will target Java 17.
@@ -353,7 +353,7 @@ For `DenseVectorProperty`, choose the Enum value that matches the old String.
353353
::::
354354
355355
356-
### Features and enhancements [elasticsearch-java-client-900-features-enhancements]
356+
## Features and enhancements [elasticsearch-java-client-900-features-enhancements]
357357
358358
::::{dropdown} New ElasticsearchClient builder
359359
ElasticsearchClient now can be created with just a few lines of code:
@@ -465,6 +465,6 @@ Example with `Aggregation`, where the `aggregations` field can now accept `Avera
465465
::::
466466

467467

468-
### Deprecations [elasticsearch-java-client-900-deprecations]
468+
## Deprecations [elasticsearch-java-client-900-deprecations]
469469

470470
Nothing was deprecated in this version of the client.

docs/release-notes/9-0-4.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,16 @@ navigation_title: "9.0.4"
33
---
44
# Elasticsearch Java Client 9.0.4 [elasticsearch-java-client-904]
55

6-
Discover what changed in the 9.0.4 version of the java client.
6+
Discover what changed in the 9.0.4 version of the Java client.
77

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

10-
::::{dropdown} Added callbacks to Rest5Client builder
11-
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:
10+
There are no breaking changes in this version of the client.
11+
12+
## Features and enhancements [elasticsearch-java-client-904-features-enhancements]
13+
14+
### Added callbacks to Rest5ClientBuilder
15+
`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:
1216
```java
1317
Rest5ClientBuilder builder = Rest5Client
1418
.builder(new HttpHost("localhost", 9200))
@@ -18,7 +22,7 @@ Rest5ClientBuilder builder = Rest5Client
1822
)
1923
);
2024
```
21-
And this is how to customize the response timeout:
25+
Here's how to customize the response timeout:
2226
```java
2327
Rest5ClientBuilder builder = Rest5Client
2428
.builder(new HttpHost("localhost", 9200))
@@ -29,3 +33,7 @@ Rest5ClientBuilder builder = Rest5Client
2933
);
3034
```
3135
::::
36+
37+
## Deprecations [elasticsearch-java-client-904-deprecations]
38+
39+
Nothing was deprecated in this version of the client.

docs/release-notes/9-1-0.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ navigation_title: "9.1.0"
55

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

8-
### Breaking changes [elasticsearch-java-client-910-breaking-changes]
8+
## Breaking changes [elasticsearch-java-client-910-breaking-changes]
99

1010
::::{dropdown} Map to NamedValue Highlight.fields
1111
`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>`.
@@ -47,7 +47,7 @@ Example with `SearchRequest`:
4747
**Action**<br> Replace the missing class with the new class name.
4848
::::
4949

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

5252
::::{dropdown} Opentelemetry update to stable conventions
5353
Following the stable release of Opentelemetry's database conventions, the client was updated to use the correct attribute names.
@@ -70,6 +70,6 @@ catch (ElasticsearchException e){
7070
More details in the PR: [#1041](https://github.com/elastic/elasticsearch-java/pull/1041)
7171
::::
7272
73-
### Deprecations [elasticsearch-java-client-910-deprecations]
73+
## Deprecations [elasticsearch-java-client-910-deprecations]
7474
7575
Nothing was deprecated in this version of the client.

docs/release-notes/index.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,15 @@ mapped_pages:
88

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

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

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

1615
## 9.1.0
1716
[Release notes](../release-notes/9-1-0.md)
17+
18+
## 9.0.4
19+
[Release notes](../release-notes/9-0-4.md)
20+
21+
## 9.0.0
22+
[Release notes](../release-notes/9-0-0.md)

docs/release-notes/known-issues.md

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,12 @@ navigation_title: "Known issues"
55

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

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

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

12-
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:
13-
```
14-
Could not resolve dependencies for project
15-
[ERROR] dependency: org.elasticsearch.client:elasticsearch-rest-client:jar:8.16.7 (compile)
16-
[ERROR] Could not find artifact org.elasticsearch.client:elasticsearch-rest-client:jar:8.16.7 in central (https://repo.maven.apache.org/maven2)
17-
```
18-
To use this version of the client, set the latest available version explicitly in the project:
19-
```kotlin
20-
// gradle
21-
implementation("org.elasticsearch.client:elasticsearch-rest-client:8.16.6")
22-
```
23-
```xml
24-
<!--maven-->
25-
<dependency>
26-
<groupId>org.elasticsearch.client</groupId>
27-
<artifactId>elasticsearch-rest-client</artifactId>
28-
<version>8.16.6</version>
29-
</dependency>
30-
```
11+
## 9.0.0 [known-issues-9-0-0]
3112

32-
### 9.0.0 [known-issues-9-0-0]
33-
34-
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:
13+
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:
3514
```
3615
Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/commons/logging/LogFactory
3716
at co.elastic.clients.transport.rest5_client.low_level.Rest5Client.<clinit>(Rest5Client.java:115)
@@ -40,7 +19,9 @@ Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/commons/lo
4019
at co.elastic.clients.transport.ElasticsearchTransportConfig$Default.buildTransport(ElasticsearchTransportConfig.java:110)
4120
at co.elastic.clients.elasticsearch.ElasticsearchClient.of(ElasticsearchClient.java:190)
4221
```
43-
To use the new Rest5Client, add the `commons-logging` dependency:
22+
This problem was [fixed](https://github.com/elastic/elasticsearch-java/pull/1010) in 9.0.1.
23+
24+
To fix this issue in 9.0.0 and use the new `Rest5Client`, add the `commons-logging` dependency:
4425
```kotlin
4526
// gradle
4627
implementation("commons-logging:commons-logging:1.3.5")
@@ -53,3 +34,25 @@ implementation("commons-logging:commons-logging:1.3.5")
5334
<version>1.3.5</version>
5435
</dependency>
5536
```
37+
38+
## 8.16.7 [known-issues-8-16-7]
39+
40+
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:
41+
```
42+
Could not resolve dependencies for project
43+
[ERROR] dependency: org.elasticsearch.client:elasticsearch-rest-client:jar:8.16.7 (compile)
44+
[ERROR] Could not find artifact org.elasticsearch.client:elasticsearch-rest-client:jar:8.16.7 in central (https://repo.maven.apache.org/maven2)
45+
```
46+
To use this version of the client, set the latest available version explicitly in the project:
47+
```kotlin
48+
// gradle
49+
implementation("org.elasticsearch.client:elasticsearch-rest-client:8.16.6")
50+
```
51+
```xml
52+
<!--maven-->
53+
<dependency>
54+
<groupId>org.elasticsearch.client</groupId>
55+
<artifactId>elasticsearch-rest-client</artifactId>
56+
<version>8.16.6</version>
57+
</dependency>
58+
```

docs/release-notes/toc.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
toc:
22
- file: index.md
33
- file: known-issues.md
4-
- file: 9-0-0.md
5-
- file: 9-0-4.md
64
- file: 9-1-0.md
5+
- file: 9-0-4.md
6+
- file: 9-0-0.md

0 commit comments

Comments
 (0)