Skip to content

Commit da7220a

Browse files
authored
[7.x][DOCS] Fine-tunes the Node.js client API reference section. (#1007)
1 parent b52b96b commit da7220a

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

docs/reference.asciidoc

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
11
[[api-reference]]
22
== API Reference
33

4-
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.
4+
This document contains the entire list of the {es} API supported by the client,
5+
both OSS and commercial. The client is entirely licensed under Apache 2.0.
56

6-
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`.
7+
{es} exposes an HTTP layer to communicate with, and the client is a library that
8+
helps you do this. Because of this reason, you will see HTTP related parameters,
9+
such as `body` or `headers`.
710

8-
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.
9-
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.
11+
Every API can accept two objects, the first contains all the parameters that
12+
will be sent to {es}, while the second includes the request specific parameters,
13+
such as timeouts, headers, and so on. In the first object, every parameter but
14+
the body will be sent via querystring or url parameter, depending on the API,
15+
and every unrecognized parameter will be sent as querystring.
1016

1117
[source,js]
1218
----
@@ -35,7 +41,10 @@ client.search({
3541
})
3642
----
3743

38-
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.
44+
In this document, you will find the reference of every parameter accepted by the
45+
querystring or the url. If you also need to send the body, you can find the
46+
documentation of its format in the reference link that is present along with
47+
every endpoint.
3948

4049
////////
4150

0 commit comments

Comments
 (0)