Skip to content

Commit aefc521

Browse files
committed
moar updates
1 parent 24f8f70 commit aefc521

File tree

2 files changed

+20
-8
lines changed

2 files changed

+20
-8
lines changed

docs/java-rest/high-level/migration.asciidoc

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,8 @@ https://www.elastic.co/blog/state-of-the-official-elasticsearch-java-clients[sta
2222

2323
=== Prerequisite
2424

25-
The Java High Level Rest Client requires Java `1.8`. It can be used to send requests
26-
to an Elasticsearch cluster that is in version 5.6.0 or 6.0.0. When using the high-level
27-
client in version 5.x to talk to a cluster in version 6.0.0, breaking changes in the REST
28-
API may cause unexpected results and new APIs provided by Elasticsearch won't be known by
29-
the high-level client (but could be used with the Low-Level Rest Client).
25+
The Java High Level Rest Client requires Java `1.8` and can be used to send requests
26+
to an <<java-rest-high-compatibility,Elasticsearch cluster in a compatible version>>.
3027

3128
=== How to migrate
3229

@@ -39,7 +36,7 @@ requires the following steps:
3936

4037
=== Updating the dependencies
4138

42-
Java application that uses the `TransportClient` depend on the
39+
Java application that uses the `TransportClient` depends on the
4340
`org.elasticsearch.client:transport` artifact. This dependency
4441
must be replaced by a new dependency on the high-level client.
4542

@@ -50,7 +47,7 @@ The <<java-rest-high-usage,Getting Started>> page shows
5047

5148
=== Changing the client's initialization code
5249

53-
The `TransportClient` is typically initialized with something as follows:
50+
The `TransportClient` is typically initialized as follows:
5451
[source,java]
5552
--------------------------------------------------
5653
Settings settings = Settings.builder()
@@ -107,7 +104,7 @@ lowLevelRestClient.close();
107104

108105
=== Changing the application's code
109106

110-
The `RestHighLevelClient` supports the same request and response object
107+
The `RestHighLevelClient` supports the same request and response objects
111108
as the `TransportClient`, but exposes slightly different methods to
112109
send the requests.
113110

docs/java-rest/high-level/usage.asciidoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@
44
This section describes how to get started with the high-level REST client from
55
getting the artifact to using it in an application.
66

7+
[[java-rest-high-compatibility]]
8+
=== Compatibility
9+
The Java High Level REST Client requires Java 1.8 and depends on the Elasticsearch
10+
core project. The client version is the same as the Elasticsearch version that the
11+
client was developed for. It accepts the same request arguments as the `TransportClient`
12+
and returns the same response objects.
13+
14+
The High Level Client is backwards compatible but can only communicate with Elasticsearch
15+
version 5.5 and onwards. The High Level Client is forward compatible as well, meaning that
16+
it supports communicating with a later version of Elasticsearch than the one it was developed
17+
for. It is recommended to upgrade the High Level Client when upgrading the Elasticsearch
18+
cluster to a new major version, as REST API breaking changes may cause unexpected results,
19+
and newly added APIs will only be supported by the newer version of the client. The client
20+
should be updated last, once all of the nodes in the cluster have been upgraded.
21+
722
[[java-rest-high-javadoc]]
823
=== Javadoc
924

0 commit comments

Comments
 (0)