[XPACK] Updates ml/preview_datafeed and graph/explore.

General source code documentation updates (deprecations, parameters doc)

Author: picandocodigo

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/async_search/submit.rb

@@ -58,7 +58,7 @@ module Actions
           # @option arguments [String] :suggest_text The source text for which the suggestions should be returned
           # @option arguments [Time] :timeout Explicit operation timeout
           # @option arguments [Boolean] :track_scores Whether to calculate and return scores even if they are not used for sorting
-          # @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 [Boolean] :track_total_hits Indicate if the number of documents that match the query should be tracked
           # @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout
           # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
           # @option arguments [Boolean] :version Specify whether to return document version as part of a hit

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/graph/explore.rb

@@ -23,11 +23,17 @@ module Actions
           # Explore extracted and summarized information about the documents and terms in an index.
           #
           # @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 [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types *Deprecated*
           # @option arguments [String] :routing Specific routing value
           # @option arguments [Time] :timeout Explicit operation timeout
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Graph Query DSL
           #
+          # *Deprecation notice*:
+          # Specifying types in urls has been deprecated
+          # Deprecated since version 7.0.0
+          #
+          #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/graph-explore-api.html
           #
           def explore(arguments = {})
@@ -39,13 +45,19 @@ def explore(arguments = {})
 
             _index = arguments.delete(:index)
 
+            _type = arguments.delete(:type)
+
             method = if arguments[:body]
                        Elasticsearch::API::HTTP_POST
                      else
                        Elasticsearch::API::HTTP_GET
                      end
 
-            path = "#{Elasticsearch::API::Utils.__listify(_index)}/_graph/explore"
+            path = if _index && _type
+                     "#{Elasticsearch::API::Utils.__listify(_index)}/#{Elasticsearch::API::Utils.__listify(_type)}/_graph/explore"
+                   else
+                     "#{Elasticsearch::API::Utils.__listify(_index)}/_graph/explore"
+                   end
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = arguments[:body]

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/info.rb

@@ -22,7 +22,7 @@ module Actions
         # Retrieves information about the installed X-Pack features.
         #
         # @option arguments [List] :categories Comma-separated list of info categories. Can be any of: build, license, features
-        # @option arguments [Boolean] :accept_enterprise If this param is used it must be set to true *Deprecated*
+        # @option arguments [Boolean] :accept_enterprise If an enterprise license is installed, return the type and mode as 'enterprise' (default: false)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/info-api.html

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/license/get.rb

@@ -23,7 +23,7 @@ module Actions
           # Retrieves licensing information for the cluster
           #
           # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
-          # @option arguments [Boolean] :accept_enterprise Supported for backwards compatibility with 7.x. If this param is used it must be set to true *Deprecated*
+          # @option arguments [Boolean] :accept_enterprise If the active license is an enterprise license, return type as 'enterprise' (default: false)
           # @option arguments [Hash] :headers Custom HTTP headers
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/get-license.html

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/find_file_structure.rb

@@ -43,7 +43,12 @@ module Actions
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The contents of the file to be analyzed (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-find-file-structure.html
+          # *Deprecation notice*:
+          # This endpoint has changed to _text_structure/find_structure, please use that API instead
+          # Deprecated since version 7.12.0
+          #
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/find-structure.html
           #
           def find_file_structure(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/preview_datafeed.rb

@@ -24,23 +24,31 @@ module Actions
           #
           # @option arguments [String] :datafeed_id The ID of the datafeed to preview
           # @option arguments [Hash] :headers Custom HTTP headers
+          # @option arguments [Hash] :body The datafeed config and job config with which to execute the preview
           #
           # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-preview-datafeed.html
           #
           def preview_datafeed(arguments = {})
-            raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]
-
             headers = arguments.delete(:headers) || {}
 
             arguments = arguments.clone
 
             _datafeed_id = arguments.delete(:datafeed_id)
 
-            method = Elasticsearch::API::HTTP_GET
-            path   = "_ml/datafeeds/#{Elasticsearch::API::Utils.__listify(_datafeed_id)}/_preview"
+            method = if arguments[:body]
+                       Elasticsearch::API::HTTP_POST
+                     else
+                       Elasticsearch::API::HTTP_GET
+                     end
+
+            path = if _datafeed_id
+                     "_ml/datafeeds/#{Elasticsearch::API::Utils.__listify(_datafeed_id)}/_preview"
+                   else
+                     "_ml/datafeeds/_preview"
+                   end
             params = {}
 
-            body = nil
+            body = arguments[:body]
             perform_request(method, path, params, body, headers).body
           end
         end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/text_structure/find_structure.rb

@@ -21,10 +21,6 @@ module API
       module TextStructure
         module Actions
           # Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch.
-          # 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 [Int] :lines_to_sample How many lines of the file should be included in the analysis
           # @option arguments [Int] :line_merge_size_limit Maximum number of characters permitted in a single message when lines are merged to create messages.