Skip to content

Commit

Permalink
[DOCS] Adds section about version compatibility to overview. (#1394)
Browse files Browse the repository at this point in the history
  • Loading branch information
szabosteve authored Feb 23, 2024
1 parent 6f4a2ee commit f70c97a
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,25 @@ the major version of the corresponding Enterprise Search implementation.
For example, for Elasticsearch `7.16`, use `7.16` of this library or above, but
not `8.0`.

## Compatibility

The Elasticsearch client is compatible with currently maintained PHP 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-PHP Branch | Supported |
| --------------------- | ------------------------ | --------- |
| main | main | |
| 8.x | 8.x | 8.x |
| 7.x | 7.x | 7.17 |

## Backward Incompatible Changes :boom:

The 8.0.0 version of `elasticsearch-php` contains a new implementation compared
Expand Down
25 changes: 25 additions & 0 deletions docs/overview.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,31 @@ standard is a community effort that contains a set of interfaces defined by the
PHP Framework Interop Group. For more information, refer to the
https://www.php-fig.org/psr/psr-7/[PSR 7 standard documentation].


[discrete]
[[version-compatibility]]
=== {es} and PHP version Compatibility

The {es} client is compatible with currently maintained PHP versions.

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.

|===
| Elasticsearch Version | Elasticsearch-PHP Branch | Supported

| main | main |
| 8.x | 8.x | 8.x
| 7.x | 7.x | 7.17
|===


* <<breaking_changes>>

include::breaking-changes.asciidoc[]

0 comments on commit f70c97a

Please sign in to comment.