Skip to content

Commit

Permalink
[DOCS] Adds compatibility matrix to docs and readme (#2136)
Browse files Browse the repository at this point in the history
Co-authored-by: Josh Mock <joshua.mock@elastic.co>
  • Loading branch information
szabosteve and JoshMock authored Feb 28, 2024
1 parent 1d8da99 commit 352f73e
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 3 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,25 @@ of the getting started documentation.
Refer to the [Connecting section](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_connecting)
of the getting started documentation.

## Compatibility

The Elasticsearch client is compatible with currently maintained JS versions.

Language clients are forward compatible; meaning that clients support
communicating with greater or equal minor versions of Elasticsearch without
breaking. It does not mean that the client automatically supports new features
of newer Elasticsearch versions; it is only possible after a release of a new
client version. For example, a 8.12 client version won't automatically support
the new features of the 8.13 version of Elasticsearch, the 8.13 client version
is required for that. Elasticsearch language clients are only backwards
compatible with default distributions and without guarantees made.

| Elasticsearch Version | Elasticsearch-JS Branch | Supported |
| --------------------- | ------------------------ | --------- |
| main | main | |
| 8.x | 8.x | 8.x |
| 7.x | 7.x | 7.17 |

## Usage

* [Creating an index](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_creating_an_index)
Expand Down
17 changes: 14 additions & 3 deletions docs/installation.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -74,25 +74,36 @@ of `^7.10.0`).
[[js-compatibility-matrix]]
=== Compatibility matrix

Language clients are forward compatible; meaning that clients support communicating with greater or equal minor versions of Elasticsearch.
Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made.
Language clients are forward compatible; meaning that clients support
communicating with greater or equal minor versions of {es} without breaking. It
does not mean that the client automatically supports new features of newer {es}
versions; it is only possible after a release of a new client version. For
example, a 8.12 client version won't automatically support the new features of
the 8.13 version of {es}, the 8.13 client version is required for that.
{es} language clients are only backwards compatible with default distributions
and without guarantees made.

[%header,cols=2*]
[%header,cols=3*]
|===
|{es} Version
|Client Version
|Supported

|`8.x`
|`8.x`
|`8.x`

|`7.x`
|`7.x`
|`7.17`

|`6.x`
|`6.x`
|

|`5.x`
|`5.x`
|
|===


Expand Down

0 comments on commit 352f73e

Please sign in to comment.