Add client compatibility (#4126)

* Add client compatibility Signed-off-by: Fanit Kolchina <[email protected]> * Add note for legacy clients Signed-off-by: Fanit Kolchina <[email protected]> * Implemented tech review feedback Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Fanit Kolchina <[email protected]>
opensearch-project · Dec 20, 2023 · 562c0c5 · 562c0c5
1 parent 2631639
commit 562c0c5
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/_clients/index.md b/_clients/index.md
@@ -35,14 +35,19 @@ OpenSearch provides clients for the following programming languages and platform
 * **Rust**
   * [OpenSearch Rust client]({{site.url}}{{site.baseurl}}/clients/rust/)
 
-All clients are compatible with any version of OpenSearch.
+For a client compatibility matrix, see the COMPATIBILITY.md file in the client's repository.
 {: .note}
 
+The OpenSearch Java high-level REST client will be deprecated starting with OpenSearch version 3.0.0 and will be removed in a future release. We recommend switching to the [Java client]({{site.url}}{{site.baseurl}}/clients/java/) instead.
+{: .warning}
 
 ## Legacy clients
 
 Most clients that work with Elasticsearch OSS 7.10.2 *should* work with OpenSearch, but the latest versions of those clients might include license or version checks that artificially break compatibility. This page includes recommendations around which versions of those clients to use for best compatibility with OpenSearch.
 
+For a client compatibility matrix, see the COMPATIBILITY.md file in the client's repository.
+{: .note}
+
 Client | Recommended version
 :--- | :---
 [Elasticsearch Java low-level REST client](https://search.maven.org/artifact/org.elasticsearch.client/elasticsearch-rest-client/7.13.4/jar) | 7.13.4