API Key: Add rubydoc

picandocodigo · picandocodigo · commit 00e879e2a2b5 · 2020-03-06T11:47:37.000-03:00
diff --git a/elasticsearch-transport/lib/elasticsearch/transport/client.rb b/elasticsearch-transport/lib/elasticsearch/transport/client.rb
@@ -85,6 +85,9 @@ class Client
       # @option arguments [String] :send_get_body_as Specify the HTTP method to use for GET requests with a body.
       #                                              (Default: GET)
       #
+      # @option api_key [String, Hash] :api_key Use API Key Authentication, either the base64 encoding of `id` and `api_key`
+      #                                         joined by a colon as a String, or a hash with the `id` and `api_key` values.
+      #
       # @yield [faraday] Access and configure the `Faraday::Connection` instance directly with a block
       #
       def initialize(arguments={}, &block)

Original file line number	Diff line number	Diff line change
`@@ -85,6 +85,9 @@ class Client`
`85`	`85`	`# @option arguments [String] :send_get_body_as Specify the HTTP method to use for GET requests with a body.`
`86`	`86`	`# (Default: GET)`
`87`	`87`	`#`
	`88`	+ # @option api_key [String, Hash] :api_key Use API Key Authentication, either the base64 encoding of `id` and `api_key`
	`89`	+ # joined by a colon as a String, or a hash with the `id` and `api_key` values.
	`90`	`+ #`
`88`	`91`	# @yield [faraday] Access and configure the `Faraday::Connection` instance directly with a block
`89`	`92`	`#`
`90`	`93`	`def initialize(arguments={}, &block)`