diff --git a/_clients/index.md b/_clients/index.md index 979e3205..6c6cc920 100644 --- a/_clients/index.md +++ b/_clients/index.md @@ -9,22 +9,33 @@ redirect_from: # OpenSearch language clients -OpenSearch provides clients for several popular programming languages, with more to come. +OpenSearch provides clients in JavaScript, Python, Ruby, Java, PHP, .NET, Go and Rust. -## OpenSearch language client compatibility +## OpenSearch clients -In general, clients are compatible with clusters running the same major version of OpenSearch (`major.minor.patch`). +OpenSearch provides clients for the following programming languages and platforms: -For example, a 1.0.0 client works with an OpenSearch 1.1.0 cluster, but might not support any non-breaking API changes in OpenSearch 1.1.0. A 1.2.0 client works with the same cluster, but might allow you to pass unsupported options in certain functions. We recommend using the same version for both, but if your tests pass after a cluster upgrade, you don't necessarily need to upgrade your clients immediately. +* **Python** + * [OpenSearch high-level Python client]({{site.url}}{{site.baseurl}}/clients/python-high-level/) + * [OpenSearch low-level Python client]({{site.url}}{{site.baseurl}}/clients/python-low-level/) + * [`opensearch-py-ml` client]({{site.url}}{{site.baseurl}}/clients/opensearch-py-ml/) +* **Java** + * [OpenSearch Java client]({{site.url}}{{site.baseurl}}/clients/java/) +* **JavaScript** + * [OpenSearch JavaScript (Node.js) client]({{site.url}}{{site.baseurl}}/clients/javascript/index) +* **Go** + * [OpenSearch Go client]({{site.url}}{{site.baseurl}}/clients/go/) +* **Ruby** + * [OpenSearch Ruby client]({{site.url}}{{site.baseurl}}/clients/ruby/) +* **PHP** + * [OpenSearch PHP client]({{site.url}}{{site.baseurl}}/clients/php/) +* **.NET** + * [OpenSearch .NET clients]({{site.url}}{{site.baseurl}}/clients/dot-net/) +* **Rust** + * [OpenSearch Rust client]({{site.url}}{{site.baseurl}}/clients/rust/) -{% comment %} -* [OpenSearch Java client]({{site.url}}{{site.baseurl}}/clients/java/) -{% endcomment %} -* [OpenSearch Python client]({{site.url}}{{site.baseurl}}/clients/python-low-level/) -* [OpenSearch JavaScript (Node.js) client]({{site.url}}{{site.baseurl}}/clients/javascript/index) -* [OpenSearch .NET clients]({{site.url}}{{site.baseurl}}/clients/dot-net/) -* [OpenSearch Go client]({{site.url}}{{site.baseurl}}/clients/go/) -* [OpenSearch PHP client]({{site.url}}{{site.baseurl}}/clients/php/) +All clients are compatible with any version of OpenSearch. +{: .note} ## Legacy clients @@ -33,11 +44,11 @@ Most clients that work with Elasticsearch OSS 7.10.2 *should* work with OpenSear Client | Recommended version :--- | :--- -[Java low-level REST client](https://search.maven.org/artifact/org.elasticsearch.client/elasticsearch-rest-client/7.13.4/jar) | 7.13.4 -[Java high-level REST client](https://search.maven.org/artifact/org.elasticsearch.client/elasticsearch-rest-high-level-client/7.13.4/jar) | 7.13.4 -[Python Elasticsearch client](https://pypi.org/project/elasticsearch/7.13.4/) | 7.13.4 +[Elasticsearch Java low-level REST client](https://search.maven.org/artifact/org.elasticsearch.client/elasticsearch-rest-client/7.13.4/jar) | 7.13.4 +[Elasticsearch Java high-level REST client](https://search.maven.org/artifact/org.elasticsearch.client/elasticsearch-rest-high-level-client/7.13.4/jar) | 7.13.4 +[Elasticsearch Python client](https://pypi.org/project/elasticsearch/7.13.4/) | 7.13.4 [Elasticsearch Node.js client](https://www.npmjs.com/package/@elastic/elasticsearch/v/7.13.0) | 7.13.0 -[Ruby Elasticsearch client](https://rubygems.org/gems/elasticsearch/versions/7.13.0) | 7.13.0 +[Elasticsearch Ruby client](https://rubygems.org/gems/elasticsearch/versions/7.13.0) | 7.13.0 If you test a legacy client and verify that it works, please [submit a PR](https://github.com/opensearch-project/documentation-website/pulls) and add it to this table. diff --git a/_clients/javascript/index.md b/_clients/javascript/index.md index d890e1f4..b74f0082 100644 --- a/_clients/javascript/index.md +++ b/_clients/javascript/index.md @@ -5,7 +5,7 @@ has_children: true nav_order: 40 --- -# Getting started +# JavaScript client The OpenSearch JavaScript (JS) client provides a safer and easier way to interact with your OpenSearch cluster. Rather than using OpenSearch from the browser and potentially exposing your data to the public, you can build an OpenSearch client that takes care of sending requests to your cluster. For the client's complete API documentation and additional examples, see the [JS client API documentation](https://opensearch-project.github.io/opensearch-js/2.1/index.html).