From bf0c4f8aad7c44066395798821e3d8f712406294 Mon Sep 17 00:00:00 2001 From: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Date: Tue, 24 Jan 2023 11:43:08 -0500 Subject: [PATCH] Adds generated documentation to clients (#2458) * Adds generated documentation to clients Signed-off-by: Fanit Kolchina * Reworded as per doc review Signed-off-by: Fanit Kolchina Signed-off-by: Fanit Kolchina --- _clients/go.md | 4 +++- _clients/java.md | 2 +- _clients/javascript/index.md | 2 +- _clients/python-low-level.md | 2 +- _clients/ruby.md | 2 +- _clients/rust.md | 2 +- 6 files changed, 8 insertions(+), 6 deletions(-) diff --git a/_clients/go.md b/_clients/go.md index c7d59813..e6db8092 100644 --- a/_clients/go.md +++ b/_clients/go.md @@ -6,7 +6,9 @@ nav_order: 50 # Go client -The OpenSearch Go client lets you connect your Go application with the data in your OpenSearch cluster. This getting started guide illustrates how to connect to OpenSearch, index documents, and run queries. For the client source code, see the [opensearch-go repo](https://github.com/opensearch-project/opensearch-go). +The OpenSearch Go client lets you connect your Go application with the data in your OpenSearch cluster. This getting started guide illustrates how to connect to OpenSearch, index documents, and run queries. For the client's complete API documentation and additional examples, see the [Go client API documentation](https://pkg.go.dev/github.com/opensearch-project/opensearch-go/v2). + +For the client source code, see the [opensearch-go repo](https://github.com/opensearch-project/opensearch-go). ## Setup diff --git a/_clients/java.md b/_clients/java.md index 1653c1c9..a8d993c4 100644 --- a/_clients/java.md +++ b/_clients/java.md @@ -6,7 +6,7 @@ nav_order: 30 # Java client -The OpenSearch Java client allows you to interact with your OpenSearch clusters through Java methods and data structures rather than HTTP methods and raw JSON. For example, you can submit requests to your cluster using objects to create indexes, add data to documents, or complete some other operation using the client's built-in methods. +The OpenSearch Java client allows you to interact with your OpenSearch clusters through Java methods and data structures rather than HTTP methods and raw JSON. For example, you can submit requests to your cluster using objects to create indexes, add data to documents, or complete some other operation using the client's built-in methods. For the client's complete API documentation and additional examples, see the [javadoc](https://www.javadoc.io/doc/org.opensearch.client/opensearch-java/latest/index.html). This getting started guide illustrates how to connect to OpenSearch, index documents, and run queries. For the client source code, see the [opensearch-java repo](https://github.com/opensearch-project/opensearch-java). diff --git a/_clients/javascript/index.md b/_clients/javascript/index.md index c20d69e4..d890e1f4 100644 --- a/_clients/javascript/index.md +++ b/_clients/javascript/index.md @@ -7,7 +7,7 @@ nav_order: 40 # Getting started -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. +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). The client contains a library of APIs that let you perform different operations on your cluster and return a standard response body. The example here demonstrates some basic operations like creating an index, adding documents, and searching your data. diff --git a/_clients/python-low-level.md b/_clients/python-low-level.md index 8bf3f709..99a04de2 100644 --- a/_clients/python-low-level.md +++ b/_clients/python-low-level.md @@ -6,7 +6,7 @@ nav_order: 10 # Low-level Python client -The OpenSearch low-level Python client (`opensearch-py`) provides wrapper methods for the OpenSearch REST API so that you can interact with your cluster more naturally in Python. Rather than sending raw HTTP requests to a given URL, you can create an OpenSearch client for your cluster and call the client's built-in functions. +The OpenSearch low-level Python client (`opensearch-py`) provides wrapper methods for the OpenSearch REST API so that you can interact with your cluster more naturally in Python. Rather than sending raw HTTP requests to a given URL, you can create an OpenSearch client for your cluster and call the client's built-in functions. For the client's complete API documentation and additional examples, see the [`opensearch-py` API documentation](https://opensearch-project.github.io/opensearch-py/). This getting started guide illustrates how to connect to OpenSearch, index documents, and run queries. For the client source code, see the [opensearch-py repo](https://github.com/opensearch-project/opensearch-py). diff --git a/_clients/ruby.md b/_clients/ruby.md index 9c2e1052..19ce8102 100644 --- a/_clients/ruby.md +++ b/_clients/ruby.md @@ -7,7 +7,7 @@ has_children: false # Ruby client -The OpenSearch Ruby client allows you to interact with your OpenSearch clusters through Ruby methods rather than HTTP methods and raw JSON. +The OpenSearch Ruby client allows you to interact with your OpenSearch clusters through Ruby methods rather than HTTP methods and raw JSON. For the client's complete API documentation and additional examples, see the [`opensearch-transport`](https://rubydoc.info/gems/opensearch-transport), [`opensearch-api`](https://rubydoc.info/gems/opensearch-api), [`opensearch-dsl`](https://rubydoc.info/gems/opensearch-dsl), and [`opensearch-ruby`](https://rubydoc.info/gems/opensearch-ruby/) gem documentation. This getting started guide illustrates how to connect to OpenSearch, index documents, and run queries. For the client source code, see the [opensearch-ruby repo](https://github.com/opensearch-project/opensearch-ruby). diff --git a/_clients/rust.md b/_clients/rust.md index e22e4765..e9aaf393 100644 --- a/_clients/rust.md +++ b/_clients/rust.md @@ -6,7 +6,7 @@ nav_order: 100 # Rust client -The OpenSearch Rust client lets you connect your Rust application with the data in your OpenSearch cluster. For the client's complete API documentation and more examples, see the [OpenSearch docs.rs documentation](https://docs.rs/opensearch/). +The OpenSearch Rust client lets you connect your Rust application with the data in your OpenSearch cluster. For the client's complete API documentation and additional examples, see the [OpenSearch docs.rs documentation](https://docs.rs/opensearch/). This getting started guide illustrates how to connect to OpenSearch, index documents, and run queries. For the client source code, see the [opensearch-rs repo](https://github.com/opensearch-project/opensearch-rs).