Skip to content

Commit f70c97a

Browse files
authored
[DOCS] Adds section about version compatibility to overview. (#1394)
1 parent 6f4a2ee commit f70c97a

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,25 @@ the major version of the corresponding Enterprise Search implementation.
6464
For example, for Elasticsearch `7.16`, use `7.16` of this library or above, but
6565
not `8.0`.
6666

67+
## Compatibility
68+
69+
The Elasticsearch client is compatible with currently maintained PHP versions.
70+
71+
Language clients are forward compatible; meaning that clients support
72+
communicating with greater or equal minor versions of Elasticsearch without
73+
breaking. It does not mean that the client automatically supports new features
74+
of newer Elasticsearch versions; it is only possible after a release of a new
75+
client version. For example, a 8.12 client version won't automatically support
76+
the new features of the 8.13 version of Elasticsearch, the 8.13 client version
77+
is required for that. Elasticsearch language clients are only backwards
78+
compatible with default distributions and without guarantees made.
79+
80+
| Elasticsearch Version | Elasticsearch-PHP Branch | Supported |
81+
| --------------------- | ------------------------ | --------- |
82+
| main | main | |
83+
| 8.x | 8.x | 8.x |
84+
| 7.x | 7.x | 7.17 |
85+
6786
## Backward Incompatible Changes :boom:
6887

6988
The 8.0.0 version of `elasticsearch-php` contains a new implementation compared

docs/overview.asciidoc

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,31 @@ standard is a community effort that contains a set of interfaces defined by the
2424
PHP Framework Interop Group. For more information, refer to the
2525
https://www.php-fig.org/psr/psr-7/[PSR 7 standard documentation].
2626

27+
28+
[discrete]
29+
[[version-compatibility]]
30+
=== {es} and PHP version Compatibility
31+
32+
The {es} client is compatible with currently maintained PHP versions.
33+
34+
Language clients are forward compatible; meaning that clients support
35+
communicating with greater or equal minor versions of {es} without breaking. It
36+
does not mean that the client automatically supports new features of newer {es}
37+
versions; it is only possible after a release of a new client version. For
38+
example, a 8.12 client version won't automatically support the new features of
39+
the 8.13 version of {es}, the 8.13 client version is required for that.
40+
{es} language clients are only backwards compatible with default distributions
41+
and without guarantees made.
42+
43+
|===
44+
| Elasticsearch Version | Elasticsearch-PHP Branch | Supported
45+
46+
| main | main |
47+
| 8.x | 8.x | 8.x
48+
| 7.x | 7.x | 7.17
49+
|===
50+
51+
2752
* <<breaking_changes>>
2853

2954
include::breaking-changes.asciidoc[]

0 commit comments

Comments
 (0)