Skip to content

Commit

Permalink
Update version and add link to examples - Javascript client (#4224)
Browse files Browse the repository at this point in the history
* addlinktoguides

Signed-off-by: Heather Halter <[email protected]>

* addslinktohelperfile

Signed-off-by: Heather Halter <[email protected]>

* addedlinktohelper

Signed-off-by: Heather Halter <[email protected]>

* Update _clients/javascript/index.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Update _clients/javascript/helpers.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

---------

Signed-off-by: Heather Halter <[email protected]>
Signed-off-by: Heather Halter <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
  • Loading branch information
hdhalter and kolchfa-aws authored Jun 6, 2023
1 parent bfdd426 commit 09aa024
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
4 changes: 2 additions & 2 deletions _clients/javascript/helpers.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ nav_order: 2

# Helper methods

Helper methods simplify the use of complicated API tasks.
Helper methods simplify the use of complicated API tasks. For the client's complete API documentation and additional examples, see the [JS client API documentation](https://opensearch-project.github.io/opensearch-js/2.2/index.html).

## Bulk helper

Expand Down Expand Up @@ -68,7 +68,7 @@ When creating a new bulk helper instance, you can use the following configuratio

### Examples

The following examples illustrate the index, create, update, and delete bulk helper operations.
The following examples illustrate the index, create, update, and delete bulk helper operations. For more information and advanced index actions, see the [`opensearch-js` guides](https://github.com/opensearch-project/opensearch-js/tree/main/guides) in GitHub.

#### Index

Expand Down
6 changes: 4 additions & 2 deletions _clients/javascript/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ redirect_from:

# 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).
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.2/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.
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.

You can use helper methods to simplify the use of complicated API tasks. For more information, see [Helper methods]({{site.url}}{{site.baseurl}}/clients/javascript/helpers/). For more advanced index actions, see the [`opensearch-js` guides](https://github.com/opensearch-project/opensearch-js/tree/main/guides) in GitHub.

## Setup

Expand Down

0 comments on commit 09aa024

Please sign in to comment.