Skip to content

Commit f25cec2

Browse files
committed
[Gem] Updates source code docs for client initializer
1 parent 801234e commit f25cec2

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

elasticsearch/lib/elasticsearch.rb

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,15 @@ class Client
3535

3636
# Create a client connected to an Elasticsearch cluster.
3737
#
38+
# @param [Hash] arguments - initializer arguments
3839
# @option arguments [String] :cloud_id - The Cloud ID to connect to Elastic Cloud
39-
# @option api_key [String, Hash] :api_key Use API Key Authentication, either the base64 encoding of `id` and `api_key`
40-
# joined by a colon as a String, or a hash with the `id` and `api_key` values.
41-
# @option opaque_id_prefix [String] :opaque_id_prefix set a prefix for X-Opaque-Id when initializing the client.
42-
# This will be prepended to the id you set before each request
43-
# if you're using X-Opaque-Id
40+
# @option arguments [String, Hash] :api_key Use API Key Authentication, either the base64 encoding of `id` and `api_key`
41+
# joined by a colon as a String, or a hash with the `id` and `api_key` values.
42+
# @option arguments [String] :opaque_id_prefix set a prefix for X-Opaque-Id when initializing the client.
43+
# This will be prepended to the id you set before each request
44+
# if you're using X-Opaque-Id
45+
# @option arguments [Hash] :headers Custom HTTP Request Headers
46+
#
4447
def initialize(arguments = {}, &block)
4548
@verified = false
4649
@warned = false

0 commit comments

Comments
 (0)