Skip to content

Commit 4a6b9e8

Browse files
authored
[DOCS] Adds compatibility matrix to the docs and readme (#8045)
* [DOCS] Adds compatibility matrix to the docs and readme. * Apply suggestions from code review * Update README.md * Apply suggestions from code review
1 parent c648bb7 commit 4a6b9e8

File tree

2 files changed

+33
-10
lines changed

2 files changed

+33
-10
lines changed

README.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,20 @@ The .NET client for Elasticsearch provides strongly typed requests and responses
1717

1818
## Compatibility
1919

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

2535
## Installation
2636

docs/install.asciidoc

+19-6
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,25 @@ To learn how to connect the {es} client, refer to the <<connecting,Connecting>>
5858
=== Compatibility
5959

6060
The {es} client is compatible with currently maintained .NET runtime versions.
61-
Compatibility with End of Life (EOL) .NET runtimes is not guaranteed or supported.
62-
63-
Language clients are forward compatible; meaning that clients support
64-
communicating with greater or equal minor versions of {es}. {es} language
65-
clients are only backward compatible with default distributions and without
66-
guarantees made.
61+
Compatibility with End of Life (EOL) .NET runtimes is not guaranteed or
62+
supported.
63+
64+
Language clients are forward compatible; meaning that the clients support
65+
communicating with greater or equal minor versions of {es} without breaking. It
66+
does not mean that the clients automatically support new features of newer
67+
{es} versions; it is only possible after a release of a new client version. For
68+
example, a 8.12 client version won't automatically support the new features of
69+
the 8.13 version of {es}, the 8.13 client version is required for that. {es}
70+
language clients are only backwards compatible with default distributions and
71+
without guarantees made.
72+
73+
|===
74+
| Elasticsearch Version | Elasticsearch-NET Branch | Supported
75+
76+
| main | main |
77+
| 8.x | 8.x | 8.x
78+
| 7.x | 7.x | 7.17
79+
|===
6780

6881
Refer to the https://www.elastic.co/support/eol[end-of-life policy] for more
6982
information.

0 commit comments

Comments
 (0)