Skip to content

Amend compatibility matrix #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 18, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ In the `pom.xml` for your project add the following repository definition and de

```xml
<project>

<repositories>
<repository>
<id>Elastic-Snapshots</id>
Expand All @@ -59,7 +59,7 @@ In the `pom.xml` for your project add the following repository definition and de
</snapshots>
</repository>
</repositories>

<dependencies>
<dependency>
<groupId>co.elastic.clients</groupId>
Expand All @@ -72,7 +72,7 @@ In the `pom.xml` for your project add the following repository definition and de
<version>2.12.3</version>
</dependency>
</dependencies>

</project>
```

Expand Down Expand Up @@ -107,10 +107,12 @@ if (search.hits().hits().isEmpty()) {

The `main` branch targets the next major release (8.0) and the `7.x` branch targets the next minor release. Support is still incomplete as the API code is generated from the [Elasticsearch Specification](https://github.com/elastic/elasticsearch-specification) that is also still a work in progress.

The Elasticsearch Java client is forward compatible; meaning that the client supports communicating with greater minor versions of Elasticsearch. Elastic language clients are also backwards compatible with lesser supported minor Elasticsearch versions.

## Current status

While not complete, this library is already fairly usable. What's missing falls in two main categories, related to the [Elasticsearch specification](https://github.com/elastic/elasticsearch-specification):
* incomplete support for some data types used in specification (e.g. unions). Until they have been implemented in the code generator, they are represented as raw `JsonValue` objects.
* incomplete support for some data types used in specification (e.g. unions). Until they have been implemented in the code generator, they are represented as raw `JsonValue` objects.
* incomplete APIs: as the API specification is still incomplete, so are their implementations in this library since their code is entirely generated from the spec.

## Contributing
Expand Down