[API] Updates APIs

picandocodigo · picandocodigo · commit 5cf2a62bd958 · 2021-10-06T11:35:32.000+01:00
Promoted from experimental:
- get_script_context
- get_script_languages
- indices/resolve_index
- rank_eval

- open_point_in_time: index is now required
- search_mvt: adds track_total_hits parameter

Promoted from experimental. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported:
- shutdown.delete_node
- shutdown.get_node
- shutdown.put_node
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb
@@ -39,7 +39,7 @@ def allocation_explain(arguments = {})
                      Elasticsearch::API::HTTP_GET
                    end
 
-          path = "_cluster/allocation/explain"
+          path   = "_cluster/allocation/explain"
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = arguments[:body]
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb b/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb
@@ -65,11 +65,11 @@ def explain(arguments = {})
                    Elasticsearch::API::HTTP_GET
                  end
 
-        path = if _index && _type && _id
-                 "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/_explain"
-               else
-                 "#{Utils.__listify(_index)}/_explain/#{Utils.__listify(_id)}"
-               end
+        path   = if _index && _type && _id
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/_explain"
+                 else
+                   "#{Utils.__listify(_index)}/_explain/#{Utils.__listify(_id)}"
+                 end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = arguments[:body]
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb b/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb
@@ -44,11 +44,11 @@ def field_caps(arguments = {})
                    Elasticsearch::API::HTTP_GET
                  end
 
-        path = if _index
-                 "#{Utils.__listify(_index)}/_field_caps"
-               else
-                 "_field_caps"
-               end
+        path   = if _index
+                   "#{Utils.__listify(_index)}/_field_caps"
+                 else
+                   "_field_caps"
+                 end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = arguments[:body]
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_script_context.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_script_context.rb
@@ -19,10 +19,6 @@ module Elasticsearch
   module API
     module Actions
       # Returns all script contexts.
-      # This functionality is Experimental and may be changed or removed
-      # completely in a future release. Elastic will take a best effort approach
-      # to fix any issues, but experimental features are not subject to the
-      # support SLA of official GA features.
       #
       # @option arguments [Hash] :headers Custom HTTP headers
       #
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_script_languages.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_script_languages.rb
@@ -19,10 +19,6 @@ module Elasticsearch
   module API
     module Actions
       # Returns available script types, languages and contexts
-      # This functionality is Experimental and may be changed or removed
-      # completely in a future release. Elastic will take a best effort approach
-      # to fix any issues, but experimental features are not subject to the
-      # support SLA of official GA features.
       #
       # @option arguments [Hash] :headers Custom HTTP headers
       #
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb
@@ -40,11 +40,11 @@ def analyze(arguments = {})
                      Elasticsearch::API::HTTP_GET
                    end
 
-          path = if _index
-                   "#{Utils.__listify(_index)}/_analyze"
-                 else
-                   "_analyze"
-                 end
+          path   = if _index
+                     "#{Utils.__listify(_index)}/_analyze"
+                   else
+                     "_analyze"
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = arguments[:body]
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb
@@ -26,7 +26,7 @@ module Actions
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false)
         # @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false)
-        # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
+        # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open, closed, or hidden indices (options: open, closed, hidden, none, all)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-delete-index.html
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb
@@ -20,10 +20,6 @@ module API
     module Indices
       module Actions
         # Returns information about any matching indices, aliases, and data streams
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
         #
         # @option arguments [List] :name A comma-separated list of names or wildcard expressions
         # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb
@@ -60,13 +60,13 @@ def validate_query(arguments = {})
                      Elasticsearch::API::HTTP_GET
                    end
 
-          path = if _index && _type
-                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_validate/query"
-                 elsif _index
-                   "#{Utils.__listify(_index)}/_validate/query"
-                 else
-                   "_validate/query"
-                 end
+          path   = if _index && _type
+                     "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_validate/query"
+                   elsif _index
+                     "#{Utils.__listify(_index)}/_validate/query"
+                   else
+                     "_validate/query"
+                   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           body = arguments[:body]
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb b/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb
@@ -60,13 +60,13 @@ def mtermvectors(arguments = {})
                    Elasticsearch::API::HTTP_GET
                  end
 
-        path = if _index && _type
-                 "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_mtermvectors"
-               elsif _index
-                 "#{Utils.__listify(_index)}/_mtermvectors"
-               else
-                 "_mtermvectors"
-               end
+        path   = if _index && _type
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_mtermvectors"
+                 elsif _index
+                   "#{Utils.__listify(_index)}/_mtermvectors"
+                 else
+                   "_mtermvectors"
+                 end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         if ids
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb b/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb
@@ -31,18 +31,16 @@ module Actions
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/point-in-time-api.html
       #
       def open_point_in_time(arguments = {})
+        raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
         headers = arguments.delete(:headers) || {}
 
         arguments = arguments.clone
 
         _index = arguments.delete(:index)
 
         method = Elasticsearch::API::HTTP_POST
-        path   = if _index
-                   "#{Utils.__listify(_index)}/_pit"
-                 else
-                   "_pit"
-                 end
+        path   = "#{Utils.__listify(_index)}/_pit"
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = nil
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb
@@ -19,10 +19,6 @@ module Elasticsearch
   module API
     module Actions
       # Allows to evaluate the quality of ranked search results over a set of typical search queries
-      # This functionality is Experimental and may be changed or removed
-      # completely in a future release. Elastic will take a best effort approach
-      # to fix any issues, but experimental features are not subject to the
-      # support SLA of official GA features.
       #
       # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
       # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb
@@ -39,11 +39,11 @@ def render_search_template(arguments = {})
                    Elasticsearch::API::HTTP_GET
                  end
 
-        path = if _id
-                 "_render/template/#{Utils.__listify(_id)}"
-               else
-                 "_render/template"
-               end
+        path   = if _id
+                   "_render/template/#{Utils.__listify(_id)}"
+                 else
+                   "_render/template"
+                 end
         params = {}
 
         body = arguments[:body]
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/scripts_painless_execute.rb b/elasticsearch-api/lib/elasticsearch/api/actions/scripts_painless_execute.rb
@@ -40,7 +40,7 @@ def scripts_painless_execute(arguments = {})
                    Elasticsearch::API::HTTP_GET
                  end
 
-        path = "_scripts/painless/_execute"
+        path   = "_scripts/painless/_execute"
         params = {}
 
         body = arguments[:body]
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb b/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb
@@ -46,11 +46,11 @@ def scroll(arguments = {})
                    Elasticsearch::API::HTTP_GET
                  end
 
-        path = if _scroll_id
-                 "_search/scroll/#{Utils.__listify(_scroll_id)}"
-               else
-                 "_search/scroll"
-               end
+        path   = if _scroll_id
+                   "_search/scroll/#{Utils.__listify(_scroll_id)}"
+                 else
+                   "_search/scroll"
+                 end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = arguments[:body]
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search.rb
@@ -91,13 +91,13 @@ def search(arguments = {})
                    Elasticsearch::API::HTTP_GET
                  end
 
-        path = if _index && _type
-                 "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_search"
-               elsif _index
-                 "#{Utils.__listify(_index)}/_search"
-               else
-                 "_search"
-               end
+        path   = if _index && _type
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_search"
+                 elsif _index
+                   "#{Utils.__listify(_index)}/_search"
+                 else
+                   "_search"
+                 end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = arguments[:body]
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb
@@ -30,10 +30,11 @@ module Actions
       # @option arguments [Integer] :x X coordinate for the vector tile to search
       # @option arguments [Integer] :y Y coordinate for the vector tile to search
       # @option arguments [Boolean] :exact_bounds If false, the meta layer's feature is the bounding box of the tile. If true, the meta layer's feature is a bounding box resulting from a `geo_bounds` aggregation.
-      # @option arguments [Number] :extent Size, in pixels, of a side of the vector tile.
-      # @option arguments [Number] :grid_precision Additional zoom levels available through the aggs layer. Accepts 0-8.
-      # @option arguments [String] :grid_type Determines the geometry type for features in the aggs layer. (options: grid, point)
-      # @option arguments [Number] :size Maximum number of features to return in the hits layer. Accepts 0-10000.
+      # @option arguments [Integer] :extent Size, in pixels, of a side of the vector tile.
+      # @option arguments [Integer] :grid_precision Additional zoom levels available through the aggs layer. Accepts 0-8.
+      # @option arguments [String] :grid_type Determines the geometry type for features in the aggs layer. (options: grid, point, centroid)
+      # @option arguments [Integer] :size Maximum number of features to return in the hits layer. Accepts 0-10000.
+      # @option arguments [Boolean|long] :track_total_hits Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body Search request body.
       #
@@ -60,12 +61,7 @@ def search_mvt(arguments = {})
 
         _y = arguments.delete(:y)
 
-        method = if arguments[:body]
-                   Elasticsearch::API::HTTP_POST
-                 else
-                   Elasticsearch::API::HTTP_GET
-                 end
-
+        method = Elasticsearch::API::HTTP_POST
         path   = "#{Utils.__listify(_index)}/_mvt/#{Utils.__listify(_field)}/#{Utils.__listify(_zoom)}/#{Utils.__listify(_x)}/#{Utils.__listify(_y)}"
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
@@ -81,7 +77,8 @@ def search_mvt(arguments = {})
         :extent,
         :grid_precision,
         :grid_type,
-        :size
+        :size,
+        :track_total_hits
       ].freeze)
     end
   end
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/delete_node.rb b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/delete_node.rb
@@ -19,11 +19,7 @@ module Elasticsearch
   module API
     module Shutdown
       module Actions
-        # Removes a node from the shutdown list
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
+        # Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
         #
         # @option arguments [String] :node_id The node id of node to be removed from the shutdown state
         # @option arguments [Hash] :headers Custom HTTP headers
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/get_node.rb b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/get_node.rb
@@ -19,11 +19,7 @@ module Elasticsearch
   module API
     module Shutdown
       module Actions
-        # Retrieve status of a node or nodes that are currently marked as shutting down
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
+        # Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
         #
         # @option arguments [String] :node_id Which node for which to retrieve the shutdown status
         # @option arguments [Hash] :headers Custom HTTP headers
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/put_node.rb b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/put_node.rb
@@ -19,11 +19,7 @@ module Elasticsearch
   module API
     module Shutdown
       module Actions
-        # Adds a node to be shut down
-        # This functionality is Experimental and may be changed or removed
-        # completely in a future release. Elastic will take a best effort approach
-        # to fix any issues, but experimental features are not subject to the
-        # support SLA of official GA features.
+        # Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
         #
         # @option arguments [String] :node_id The node id of node to be shut down
         # @option arguments [Hash] :headers Custom HTTP headers
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb b/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb
@@ -64,15 +64,15 @@ def termvectors(arguments = {})
                  end
 
         endpoint = arguments.delete(:endpoint) || '_termvectors'
-        path = if _index && _type && _id
-                 "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/#{endpoint}"
-               elsif _index && _type
-                 "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{endpoint}"
-               elsif _index && _id
-                 "#{Utils.__listify(_index)}/#{endpoint}/#{Utils.__listify(_id)}"
-               else
-                 "#{Utils.__listify(_index)}/#{endpoint}"
-               end
+        path   = if _index && _type && _id
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/#{endpoint}"
+                 elsif _index && _type
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{endpoint}"
+                 elsif _index && _id
+                   "#{Utils.__listify(_index)}/#{endpoint}/#{Utils.__listify(_id)}"
+                 else
+                   "#{Utils.__listify(_index)}/#{endpoint}"
+                 end
 
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/open_point_in_time_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/open_point_in_time_spec.rb
@@ -21,24 +21,14 @@
   let(:expected_args) do
     [
       'POST',
-      url,
+      'foo/_pit',
       {},
       nil,
       {}
     ]
   end
 
-  let (:url) { '_pit'}
-
   it 'performs the request' do
-    expect(client_double.open_point_in_time).to eq({})
-  end
-
-  context 'with index' do
-    let (:url) { 'foo/_pit'}
-
-    it 'performs the request' do
-      expect(client_double.open_point_in_time(index: 'foo')).to eq({})
-    end
+    expect(client_double.open_point_in_time(index: 'foo')).to eq({})
   end
 end
diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/search_mvt_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/search_mvt_spec.rb
@@ -20,7 +20,7 @@
 describe 'client#search_mvt' do
   let(:expected_args) do
     [
-      method,
+      'POST',
       url,
       params,
       body,
@@ -29,7 +29,6 @@
   end
 
   context 'with right parameters' do
-    let(:method) { 'GET' }
     let(:url) { 'foo/_mvt/field/10/57.2127/6.2348' }
     let(:params) { {} }
     let(:body) { nil }

Original file line number	Diff line number	Diff line change
`@@ -19,10 +19,6 @@ module Elasticsearch`
`19`	`19`	`module API`
`20`	`20`	`module Actions`
`21`	`21`	`# Returns all script contexts.`
`22`		`- # This functionality is Experimental and may be changed or removed`
`23`		`- # completely in a future release. Elastic will take a best effort approach`
`24`		`- # to fix any issues, but experimental features are not subject to the`
`25`		`- # support SLA of official GA features.`
`26`	`22`	`#`
`27`	`23`	`# @option arguments [Hash] :headers Custom HTTP headers`
`28`	`24`	`#`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ module Actions`
`26`	`26`	`# @option arguments [Time] :master_timeout Specify timeout for connection to master`
`27`	`27`	`# @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false)`
`28`	`28`	`# @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false)`
`29`		`- # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)`
	`29`	`+ # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open, closed, or hidden indices (options: open, closed, hidden, none, all)`
`30`	`30`	`# @option arguments [Hash] :headers Custom HTTP headers`
`31`	`31`	`#`
`32`	`32`	`# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-delete-index.html`