Skip to content

[7.x][DOCS] Fine-tunes the Node.js client API reference section #1007

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.

Sign up for GitHub

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 1 commit into from
Nov 25, 2019
Merged

[7.x][DOCS] Fine-tunes the Node.js client API reference section #1007

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 14 additions & 5 deletions docs/reference.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
[[api-reference]]
== API Reference

This document contains the entire list of the Elasticsearch API supported by the client, both OSS and commercial. The client is entirely licensed under Apache 2.0.
This document contains the entire list of the {es} API supported by the client,
both OSS and commercial. The client is entirely licensed under Apache 2.0.

Elasticsearch exposes an HTTP layer to communicate with, and the client is a library that will help you do this. Because of this reason, you will see HTTP related parameters, such as `body` or `headers`.
{es} exposes an HTTP layer to communicate with, and the client is a library that
helps you do this. Because of this reason, you will see HTTP related parameters,
such as `body` or `headers`.

Every API can accept two objects, the first contains all the parameters that will be sent to Elasticsearch, while the second includes the request specific parameters, such as timeouts, headers, and so on.
In the first object, every parameter but the body will be sent via querystring or url parameter, depending on the API, and every unrecognized parameter will be sent as querystring.
Every API can accept two objects, the first contains all the parameters that
will be sent to {es}, while the second includes the request specific parameters,
such as timeouts, headers, and so on. In the first object, every parameter but
the body will be sent via querystring or url parameter, depending on the API,
and every unrecognized parameter will be sent as querystring.

[source,js]
----
Expand Down Expand Up @@ -35,7 +41,10 @@ client.search({
})
----

In this document, you will find the reference of every parameter accepted by the querystring or the url. If you also need to send the body, you can find the documentation of its format in the reference link that is present along with every endpoint.
In this document, you will find the reference of every parameter accepted by the
querystring or the url. If you also need to send the body, you can find the
documentation of its format in the reference link that is present along with
every endpoint.

////////

Expand Down