[API] Updates source docs, adds search_mvt

Author: picandocodigo

elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb

@@ -24,7 +24,7 @@ module Actions
         # @option arguments [Boolean] :include_yes_decisions Return 'YES' decisions in explanation (default: false)
         # @option arguments [Boolean] :include_disk_info Return information about disk usage and shard sizes (default: false)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'
+        # @option arguments [Hash] :body The index, shard, and primary flag to explain. Empty means 'explain a randomly-chosen unassigned shard'
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cluster-allocation-explain.html
         #

elasticsearch-api/lib/elasticsearch/api/actions/indices/field_usage_stats.rb

@@ -32,7 +32,7 @@ module Actions
         # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.15/field-usage-stats.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/field-usage-stats.html
         #
         def field_usage_stats(arguments = {})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb

@@ -23,7 +23,7 @@ module Actions
         #
         # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
         # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, breaker, fs, http, indices, jvm, os, process, thread_pool, transport, discovery, indexing_pressure)
-        # @option arguments [List] :index_metric Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, suggest)
+        # @option arguments [List] :index_metric Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, suggest, shards)
         # @option arguments [List] :completion_fields A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
         # @option arguments [List] :fielddata_fields A comma-separated list of fields for `fielddata` index metric (supports wildcards)
         # @option arguments [List] :fields A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)

elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb

@@ -0,0 +1,88 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module API
+    module Actions
+      # Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile.
+      # 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 Comma-separated list of data streams, indices, or aliases to search
+      # @option arguments [String] :field Field containing geospatial data to return
+      # @option arguments [Integer] :zoom Zoom level for the vector tile to search
+      # @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 [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body Search request body.
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-vector-tile-api.html
+      #
+      def search_mvt(arguments = {})
+        raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+        raise ArgumentError, "Required argument 'field' missing" unless arguments[:field]
+        raise ArgumentError, "Required argument 'zoom' missing" unless arguments[:zoom]
+        raise ArgumentError, "Required argument 'x' missing" unless arguments[:x]
+        raise ArgumentError, "Required argument 'y' missing" unless arguments[:y]
+
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
+
+        _field = arguments.delete(:field)
+
+        _zoom = arguments.delete(:zoom)
+
+        _x = arguments.delete(:x)
+
+        _y = arguments.delete(:y)
+
+        method = if arguments[:body]
+                   Elasticsearch::API::HTTP_POST
+                 else
+                   Elasticsearch::API::HTTP_GET
+                 end
+
+        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__)
+
+        body = arguments[:body]
+        perform_request(method, path, params, body, headers).body
+      end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.2.0
+      ParamsRegistry.register(:search_mvt, [
+        :exact_bounds,
+        :extent,
+        :grid_precision,
+        :grid_type,
+        :size
+      ].freeze)
+    end
+  end
+end

elasticsearch-api/spec/elasticsearch/api/actions/search_mvt_spec.rb

@@ -0,0 +1,53 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require 'spec_helper'
+
+describe 'client#search_mvt' do
+  let(:expected_args) do
+    [
+      method,
+      url,
+      params,
+      body,
+      {}
+    ]
+  end
+
+  context 'with right parameters' do
+    let(:method) { 'GET' }
+    let(:url) { 'foo/_mvt/field/10/57.2127/6.2348' }
+    let(:params) { {} }
+    let(:body) { nil }
+
+    it 'performs the request' do
+      expect(client_double.search_mvt(index: 'foo', field: 'field', zoom: 10, x: 57.2127, y: 6.2348)).to eq({})
+    end
+  end
+
+  context 'when a param is missing' do
+    let(:client) do
+      Class.new { include Elasticsearch::API }.new
+    end
+
+    it 'raises an ArgumentError' do
+      expect{
+        client.search_mvt
+      }.to raise_exception(ArgumentError)
+    end
+  end
+end