Skip to content

Commit 4fa4e7a

Browse files
szabostevegithub-actions[bot]
authored andcommitted
[DOCS] Adds compatibility matrix to docs and README. (#749)
1 parent 57f91c7 commit 4fa4e7a

File tree

2 files changed

+35
-4
lines changed

2 files changed

+35
-4
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,25 @@ of the getting started documentation.
2727
Refer to the [Connecting section](https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/getting-started-java.html#_connecting)
2828
of the getting started documentation.
2929

30+
## Compatibility
31+
32+
The Elasticsearch client is compatible with currently maintained Java versions.
33+
34+
The Java client is forward compatible; meaning that the client supports
35+
communicating with greater or equal minor versions of Elasticsearch without
36+
breaking. It does not mean that the client automatically supports new features
37+
of newer Elasticsearch versions; it is only possible after a release of a new
38+
client version. For example, a 8.12 client version won't automatically support
39+
the new features of the 8.13 version of Elasticsearch, the 8.13 client version
40+
is required for that. Elasticsearch language clients are only backwards
41+
compatible with default distributions and without guarantees made.
42+
43+
| Elasticsearch Version | Elasticsearch-Java Branch | Supported |
44+
| --------------------- | ------------------------- | --------- |
45+
| main | main | |
46+
| 8.x | 8.x | 8.x |
47+
| 7.x | 7.x | 7.17 |
48+
3049
## Usage
3150

3251
- [Creating an index](https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/getting-started-java.html#_creating_an_index)

docs/introduction.asciidoc

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,19 @@ provides strongly typed requests and responses for all {es} APIs.
2020
[discrete]
2121
=== Elasticsearch server compatibility policy
2222

23-
The {es} Java client is forward compatible; meaning that the client supports
24-
communicating with greater or equal minor versions of {es}. {es} language
25-
clients are only backwards compatible with default distributions and without
26-
guarantees made.
23+
The {es} Java client is forward compatible; meaning that the client supports
24+
communicating with greater or equal minor versions of {es} without breaking. It
25+
does not mean that the client automatically supports new features of newer
26+
{es} versions; it is only possible after a release of a new client version. For
27+
example, a 8.12 client version won't automatically support the new features of
28+
the 8.13 version of {es}, the 8.13 client version is required for that. {es}
29+
language clients are only backwards compatible with default distributions and
30+
without guarantees made.
31+
32+
|===
33+
| Elasticsearch Version | Elasticsearch-Java Branch | Supported
34+
35+
| main | main |
36+
| 8.x | 8.x | 8.x
37+
| 7.x | 7.x | 7.17
38+
|===

0 commit comments

Comments
 (0)