Skip to content

Commit 8eade05

Browse files
committed
[DOCS] Updates Helpers documentation
1 parent 494027b commit 8eade05

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/helpers.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
The {es} Ruby client includes some useful helpers for a more comfortable experience with some APIs.
55

6+
[discrete]
67
=== Bulk Helper
78

89
This helper provides a better developer experience when using the Bulk API. At its simplest, you can send it a collection of hashes in an array, and it will bulk ingest them into {es}.
@@ -69,7 +70,7 @@ To update documents, you can send the array of documents with their respective i
6970
----
7071
documents = [
7172
{name: 'updated name 1', id: 'AxkFJYgB6LpJd9ljOtr7'},
72-
{name: 'updated name 2', 'BBkFJYgB6LpJd9ljOtr7'}
73+
{name: 'updated name 2', id: 'BBkFJYgB6LpJd9ljOtr7'}
7374
]
7475
helper.update(documents)
7576
----
@@ -112,6 +113,7 @@ The following is an example of the Ruby code to ingest the documents in the JSON
112113
bulk_helper.ingest_json(file_path, { keys: ['data', 'items'] })
113114
----
114115

116+
[discrete]
115117
=== Scroll Helper
116118

117119
This helper provides an easy way to get results from a Scroll.

0 commit comments

Comments
 (0)