[Backport 8.12] [DOCS] Adds compatibility matrix to docs and readme (#2145)
Co-authored-by: Josh Mock <joshua.mock@elastic.co>
(cherry picked from commit 352f73e7c2)
Co-authored-by: István Zoltán Szabó <szabosteve@gmail.com>
This commit is contained in:
committed by
GitHub
parent
cf8287d7ae
commit
dd3609665a
19
README.md
19
README.md
@ -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)
|
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.
|
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
|
## Usage
|
||||||
|
|
||||||
* [Creating an index](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_creating_an_index)
|
* [Creating an index](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_creating_an_index)
|
||||||
|
|||||||
@ -74,25 +74,36 @@ of `^7.10.0`).
|
|||||||
[[js-compatibility-matrix]]
|
[[js-compatibility-matrix]]
|
||||||
=== Compatibility matrix
|
=== Compatibility matrix
|
||||||
|
|
||||||
Language clients are forward compatible; meaning that clients support communicating with greater or equal minor versions of Elasticsearch.
|
Language clients are forward compatible; meaning that clients support
|
||||||
Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made.
|
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
|
|{es} Version
|
||||||
|Client Version
|
|Client Version
|
||||||
|
|Supported
|
||||||
|
|
||||||
|
|`8.x`
|
||||||
|`8.x`
|
|`8.x`
|
||||||
|`8.x`
|
|`8.x`
|
||||||
|
|
||||||
|`7.x`
|
|`7.x`
|
||||||
|`7.x`
|
|`7.x`
|
||||||
|
|`7.17`
|
||||||
|
|
||||||
|`6.x`
|
|`6.x`
|
||||||
|`6.x`
|
|`6.x`
|
||||||
|
|
|
||||||
|
|
||||||
|`5.x`
|
|`5.x`
|
||||||
|`5.x`
|
|`5.x`
|
||||||
|
|
|
||||||
|===
|
|===
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user