elasticsearch-serverless 0.5.0 → 0.7.0

data/lib/elasticsearch-serverless/api/eql/get_status.rb

@@ -22,19 +22,19 @@ module ElasticsearchServerless
   module API
     module Eql
       module Actions
-        # Returns the current status for an async EQL search or a stored synchronous EQL search without returning results.
+        # Get the async EQL status.
+        # Get the current status for an async EQL search or a stored synchronous EQL search without returning results.
         #
         # @option arguments [String] :id Identifier for the search. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-eql-status-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get-status
         #
         def get_status(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "eql.get_status" }
+          request_opts = { endpoint: arguments[:endpoint] || 'eql.get_status' }
 
-          defined_params = [:id].inject({}) do |set_variables, variable|
+          defined_params = [:id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/eql/search.rb

@@ -22,10 +22,15 @@ module ElasticsearchServerless
   module API
     module Eql
       module Actions
-        # Returns results matching a query expressed in Event Query Language (EQL)
+        # Get EQL search results.
+        # Returns search results for an Event Query Language (EQL) query.
+        # EQL assumes each document in a data stream or index corresponds to an event.
         #
         # @option arguments [String, Array] :index The name of the index to scope the operation (*Required*)
         # @option arguments [Boolean] :allow_no_indices [TODO] Server default: true.
+        # @option arguments [Boolean] :allow_partial_search_results If true, returns partial results if there are shard failures. If false, returns an error with no partial results. Server default: true.
+        # @option arguments [Boolean] :allow_partial_sequence_results If true, sequence queries will return partial results in case of shard failures. If false, they will return no results at all.
+        #  This flag has effect only if allow_partial_search_results is true.
         # @option arguments [String, Array<String>] :expand_wildcards [TODO] Server default: open.
         # @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response. Server default: true.
         # @option arguments [Time] :keep_alive Period for which the search and its results are stored on the cluster. Server default: 5d.
@@ -34,14 +39,13 @@ module ElasticsearchServerless
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-search
         #
         def search(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "eql.search" }
+          request_opts = { endpoint: arguments[:endpoint] || 'eql.search' }
 
-          defined_params = [:index].inject({}) do |set_variables, variable|
+          defined_params = [:index].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/exists.rb

@@ -22,35 +22,54 @@ module ElasticsearchServerless
   module API
     module Actions
       # Check a document.
-      # Checks if a specified document exists.
+      # Verify that a document exists.
+      # For example, check to see if a document with the +_id+ 0 exists:
+      # +
+      # HEAD my-index-000001/_doc/0
+      # +
+      # If the document exists, the API returns a status code of +200 - OK+.
+      # If the document doesn’t exist, the API returns +404 - Not Found+.
+      # **Versioning support**
+      # You can use the +version+ parameter to check the document only if its current version is equal to the specified one.
+      # Internally, Elasticsearch has marked the old document as deleted and added an entirely new document.
+      # The old version of the document doesn't disappear immediately, although you won't be able to access it.
+      # Elasticsearch cleans up deleted documents in the background as you continue to index more data.
       #
-      # @option arguments [String] :id Identifier of the document. (*Required*)
-      # @option arguments [String] :index Comma-separated list of data streams, indices, and aliases.
-      #  Supports wildcards (+*+). (*Required*)
-      # @option arguments [String] :preference Specifies the node or shard the operation should be performed on.
-      #  Random by default.
+      # @option arguments [String] :id A unique document identifier. (*Required*)
+      # @option arguments [String] :index A comma-separated list of data streams, indices, and aliases.
+      #  It supports wildcards (+*+). (*Required*)
+      # @option arguments [String] :preference The node or shard the operation should be performed on.
+      #  By default, the operation is randomized between the shard replicas.If it is set to +_local+, the operation will prefer to be run on a local allocated shard when possible.
+      #  If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value.
+      #  This can help with "jumping values" when hitting different shards in different refresh states.
+      #  A sample value can be something like the web session ID or the user name.
       # @option arguments [Boolean] :realtime If +true+, the request is real-time as opposed to near-real-time. Server default: true.
-      # @option arguments [Boolean] :refresh If +true+, Elasticsearch refreshes all shards involved in the delete by query after the request completes.
-      # @option arguments [String] :routing Target the specified primary shard.
-      # @option arguments [Boolean, String, Array<String>] :_source +true+ or +false+ to return the +_source+ field or not, or a list of fields to return.
-      # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude in the response.
+      # @option arguments [Boolean] :refresh If +true+, the request refreshes the relevant shards before retrieving the document.
+      #  Setting it to +true+ should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
+      # @option arguments [String] :routing A custom value used to route operations to a specific shard.
+      # @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the +_source+ field (+true+ or +false+) or lists the fields to return.
+      # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
+      #  You can also use this parameter to exclude fields from the subset specified in +_source_includes+ query parameter.
+      #  If the +_source+ parameter is +false+, this parameter is ignored.
       # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
-      # @option arguments [String, Array<String>] :stored_fields List of stored fields to return as part of a hit.
+      #  If this parameter is specified, only these source fields are returned.
+      #  You can exclude fields from this subset using the +_source_excludes+ query parameter.
+      #  If the +_source+ parameter is +false+, this parameter is ignored.
+      # @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return as part of a hit.
       #  If no fields are specified, no stored fields are included in the response.
-      #  If this field is specified, the +_source+ parameter defaults to false.
+      #  If this field is specified, the +_source+ parameter defaults to +false+.
       # @option arguments [Integer] :version Explicit version number for concurrency control.
       #  The specified version must match the current version of the document for the request to succeed.
-      # @option arguments [String] :version_type Specific version type: +external+, +external_gte+.
+      # @option arguments [String] :version_type The version type.
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get
       #
       def exists(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "exists" }
+        request_opts = { endpoint: arguments[:endpoint] || 'exists' }
 
-        defined_params = [:index, :id].inject({}) do |set_variables, variable|
+        defined_params = [:index, :id].each_with_object({}) do |variable, set_variables|
           set_variables[variable] = arguments[variable] if arguments.key?(variable)
-          set_variables
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -71,11 +90,11 @@ module ElasticsearchServerless
         params = Utils.process_params(arguments)
 
         Utils.rescue_from_not_found do
-          perform_request(method, path, params, body, headers, request_opts).status == 200 ? true : false
+          perform_request(method, path, params, body, headers, request_opts).status == 200
         end
       end
 
-      alias_method :exists?, :exists
+      alias exists? exists
     end
   end
 end

data/lib/elasticsearch-serverless/api/exists_source.rb

@@ -22,32 +22,37 @@ module ElasticsearchServerless
   module API
     module Actions
       # Check for a document source.
-      # Checks if a document's +_source+ is stored.
+      # Check whether a document source exists in an index.
+      # For example:
+      # +
+      # HEAD my-index-000001/_source/1
+      # +
+      # A document's source is not available if it is disabled in the mapping.
       #
-      # @option arguments [String] :id Identifier of the document. (*Required*)
-      # @option arguments [String] :index Comma-separated list of data streams, indices, and aliases.
-      #  Supports wildcards (+*+). (*Required*)
-      # @option arguments [String] :preference Specifies the node or shard the operation should be performed on.
-      #  Random by default.
-      # @option arguments [Boolean] :realtime If true, the request is real-time as opposed to near-real-time. Server default: true.
-      # @option arguments [Boolean] :refresh If +true+, Elasticsearch refreshes all shards involved in the delete by query after the request completes.
-      # @option arguments [String] :routing Target the specified primary shard.
-      # @option arguments [Boolean, String, Array<String>] :_source +true+ or +false+ to return the +_source+ field or not, or a list of fields to return.
+      # @option arguments [String] :id A unique identifier for the document. (*Required*)
+      # @option arguments [String] :index A comma-separated list of data streams, indices, and aliases.
+      #  It supports wildcards (+*+). (*Required*)
+      # @option arguments [String] :preference The node or shard the operation should be performed on.
+      #  By default, the operation is randomized between the shard replicas.
+      # @option arguments [Boolean] :realtime If +true+, the request is real-time as opposed to near-real-time. Server default: true.
+      # @option arguments [Boolean] :refresh If +true+, the request refreshes the relevant shards before retrieving the document.
+      #  Setting it to +true+ should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
+      # @option arguments [String] :routing A custom value used to route operations to a specific shard.
+      # @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the +_source+ field (+true+ or +false+) or lists the fields to return.
       # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude in the response.
       # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
-      # @option arguments [Integer] :version Explicit version number for concurrency control.
-      #  The specified version must match the current version of the document for the request to succeed.
-      # @option arguments [String] :version_type Specific version type: +external+, +external_gte+.
+      # @option arguments [Integer] :version The version number for concurrency control.
+      #  It must match the current version of the document for the request to succeed.
+      # @option arguments [String] :version_type The version type.
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get
       #
       def exists_source(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "exists_source" }
+        request_opts = { endpoint: arguments[:endpoint] || 'exists_source' }
 
-        defined_params = [:index, :id].inject({}) do |set_variables, variable|
+        defined_params = [:index, :id].each_with_object({}) do |variable, set_variables|
           set_variables[variable] = arguments[variable] if arguments.key?(variable)
-          set_variables
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -72,7 +77,7 @@ module ElasticsearchServerless
         )
       end
 
-      alias_method :exists_source?, :exists_source
+      alias exists_source? exists_source
     end
   end
 end

data/lib/elasticsearch-serverless/api/explain.rb

@@ -22,36 +22,45 @@ module ElasticsearchServerless
   module API
     module Actions
       # Explain a document match result.
-      # Returns information about why a specific document matches, or doesn’t match, a query.
+      # Get information about why a specific document matches, or doesn't match, a query.
+      # It computes a score explanation for a query and a specific document.
       #
-      # @option arguments [String] :id Defines the document ID. (*Required*)
-      # @option arguments [String] :index Index names used to limit the request.
+      # @option arguments [String] :id The document identifier. (*Required*)
+      # @option arguments [String] :index Index names that are used to limit the request.
       #  Only a single index name can be provided to this parameter. (*Required*)
-      # @option arguments [String] :analyzer Analyzer to use for the query string.
-      #  This parameter can only be used when the +q+ query string parameter is specified.
+      # @option arguments [String] :analyzer The analyzer to use for the query string.
+      #  This parameter can be used only when the +q+ query string parameter is specified.
       # @option arguments [Boolean] :analyze_wildcard If +true+, wildcard and prefix queries are analyzed.
-      # @option arguments [String] :default_operator The default operator for query string query: +AND+ or +OR+. Server default: OR.
-      # @option arguments [String] :df Field to use as default where no field prefix is given in the query string.
+      #  This parameter can be used only when the +q+ query string parameter is specified.
+      # @option arguments [String] :default_operator The default operator for query string query: +AND+ or +OR+.
+      #  This parameter can be used only when the +q+ query string parameter is specified. Server default: OR.
+      # @option arguments [String] :df The field to use as default where no field prefix is given in the query string.
+      #  This parameter can be used only when the +q+ query string parameter is specified.
       # @option arguments [Boolean] :lenient If +true+, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
-      # @option arguments [String] :preference Specifies the node or shard the operation should be performed on.
-      #  Random by default.
-      # @option arguments [String] :routing Custom value used to route operations to a specific shard.
-      # @option arguments [Boolean, String, Array<String>] :_source True or false to return the +_source+ field or not, or a list of fields to return.
+      #  This parameter can be used only when the +q+ query string parameter is specified.
+      # @option arguments [String] :preference The node or shard the operation should be performed on.
+      #  It is random by default.
+      # @option arguments [String] :routing A custom value used to route operations to a specific shard.
+      # @option arguments [Boolean, String, Array<String>] :_source +True+ or +false+ to return the +_source+ field or not or a list of fields to return.
       # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
+      #  You can also use this parameter to exclude fields from the subset specified in +_source_includes+ query parameter.
+      #  If the +_source+ parameter is +false+, this parameter is ignored.
       # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
+      #  If this parameter is specified, only these source fields are returned.
+      #  You can exclude fields from this subset using the +_source_excludes+ query parameter.
+      #  If the +_source+ parameter is +false+, this parameter is ignored.
       # @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return in the response.
-      # @option arguments [String] :q Query in the Lucene query string syntax.
+      # @option arguments [String] :q The query in the Lucene query string syntax.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-explain
       #
       def explain(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "explain" }
+        request_opts = { endpoint: arguments[:endpoint] || 'explain' }
 
-        defined_params = [:index, :id].inject({}) do |set_variables, variable|
+        defined_params = [:index, :id].each_with_object({}) do |variable, set_variables|
           set_variables[variable] = arguments[variable] if arguments.key?(variable)
-          set_variables
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/field_caps.rb

@@ -21,32 +21,35 @@
 module ElasticsearchServerless
   module API
     module Actions
-      # The field capabilities API returns the information about the capabilities of fields among multiple indices.
-      # The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type
-      # of keyword is returned as any other field that belongs to the +keyword+ family.
+      # Get the field capabilities.
+      # Get information about the capabilities of fields among multiple indices.
+      # For data streams, the API returns field capabilities among the stream’s backing indices.
+      # It returns runtime fields like any other field.
+      # For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the +keyword+ family.
       #
-      # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.
+      # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.
       # @option arguments [Boolean] :allow_no_indices If false, the request returns an error if any wildcard expression, index alias,
       #  or +_all+ value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request
       #  targeting +foo*,bar*+ returns an error if an index starts with foo but no index starts with bar. Server default: true.
-      # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as +open,hidden+. Server default: open.
-      # @option arguments [String, Array<String>] :fields Comma-separated list of fields to retrieve capabilities for. Wildcard (+*+) expressions are supported.
+      # @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as +open,hidden+. Server default: open.
+      # @option arguments [String, Array<String>] :fields A comma-separated list of fields to retrieve capabilities for. Wildcard (+*+) expressions are supported.
       # @option arguments [Boolean] :ignore_unavailable If +true+, missing or closed indices are not included in the response.
       # @option arguments [Boolean] :include_unmapped If true, unmapped fields are included in the response.
-      # @option arguments [String] :filters An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent
-      # @option arguments [Array<String>] :types Only return results for fields that have one of the types in the list
+      # @option arguments [String] :filters A comma-separated list of filters to apply to the response.
+      # @option arguments [Array<String>] :types A comma-separated list of field types to include.
+      #  Any fields that do not match one of these types will be excluded from the results.
+      #  It defaults to empty, meaning that all field types are returned.
       # @option arguments [Boolean] :include_empty_fields If false, empty fields are not included in the response. Server default: true.
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [Hash] :body request body
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-field-caps
       #
       def field_caps(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "field_caps" }
+        request_opts = { endpoint: arguments[:endpoint] || 'field_caps' }
 
-        defined_params = [:index].inject({}) do |set_variables, variable|
+        defined_params = [:index].each_with_object({}) do |variable, set_variables|
           set_variables[variable] = arguments[variable] if arguments.key?(variable)
-          set_variables
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -66,7 +69,7 @@ module ElasticsearchServerless
         path   = if _index
                    "#{Utils.listify(_index)}/_field_caps"
                  else
-                   "_field_caps"
+                   '_field_caps'
                  end
         params = Utils.process_params(arguments)
 

data/lib/elasticsearch-serverless/api/get.rb

@@ -22,35 +22,85 @@ module ElasticsearchServerless
   module API
     module Actions
       # Get a document by its ID.
-      # Retrieves the document with the specified ID from an index.
+      # Get a document and its source or stored fields from an index.
+      # By default, this API is realtime and is not affected by the refresh rate of the index (when data will become visible for search).
+      # In the case where stored fields are requested with the +stored_fields+ parameter and the document has been updated but is not yet refreshed, the API will have to parse and analyze the source to extract the stored fields.
+      # To turn off realtime behavior, set the +realtime+ parameter to false.
+      # **Source filtering**
+      # By default, the API returns the contents of the +_source+ field unless you have used the +stored_fields+ parameter or the +_source+ field is turned off.
+      # You can turn off +_source+ retrieval by using the +_source+ parameter:
+      # +
+      # GET my-index-000001/_doc/0?_source=false
+      # +
+      # If you only need one or two fields from the +_source+, use the +_source_includes+ or +_source_excludes+ parameters to include or filter out particular fields.
+      # This can be helpful with large documents where partial retrieval can save on network overhead
+      # Both parameters take a comma separated list of fields or wildcard expressions.
+      # For example:
+      # +
+      # GET my-index-000001/_doc/0?_source_includes=*.id&_source_excludes=entities
+      # +
+      # If you only want to specify includes, you can use a shorter notation:
+      # +
+      # GET my-index-000001/_doc/0?_source=*.id
+      # +
+      # **Routing**
+      # If routing is used during indexing, the routing value also needs to be specified to retrieve a document.
+      # For example:
+      # +
+      # GET my-index-000001/_doc/2?routing=user1
+      # +
+      # This request gets the document with ID 2, but it is routed based on the user.
+      # The document is not fetched if the correct routing is not specified.
+      # **Distributed**
+      # The GET operation is hashed into a specific shard ID.
+      # It is then redirected to one of the replicas within that shard ID and returns the result.
+      # The replicas are the primary shard and its replicas within that shard ID group.
+      # This means that the more replicas you have, the better your GET scaling will be.
+      # **Versioning support**
+      # You can use the +version+ parameter to retrieve the document only if its current version is equal to the specified one.
+      # Internally, Elasticsearch has marked the old document as deleted and added an entirely new document.
+      # The old version of the document doesn't disappear immediately, although you won't be able to access it.
+      # Elasticsearch cleans up deleted documents in the background as you continue to index more data.
       #
-      # @option arguments [String] :id Unique identifier of the document. (*Required*)
-      # @option arguments [String] :index Name of the index that contains the document. (*Required*)
-      # @option arguments [Boolean] :force_synthetic_source Should this request force synthetic _source?
-      #  Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
-      #  Fetches with this enabled will be slower the enabling synthetic source natively in the index.
-      # @option arguments [String] :preference Specifies the node or shard the operation should be performed on. Random by default.
+      # @option arguments [String] :id A unique document identifier. (*Required*)
+      # @option arguments [String] :index The name of the index that contains the document. (*Required*)
+      # @option arguments [Boolean] :force_synthetic_source Indicates whether the request forces synthetic +_source+.
+      #  Use this paramater to test if the mapping supports synthetic +_source+ and to get a sense of the worst case performance.
+      #  Fetches with this parameter enabled will be slower than enabling synthetic source natively in the index.
+      # @option arguments [String] :preference The node or shard the operation should be performed on.
+      #  By default, the operation is randomized between the shard replicas.If it is set to +_local+, the operation will prefer to be run on a local allocated shard when possible.
+      #  If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value.
+      #  This can help with "jumping values" when hitting different shards in different refresh states.
+      #  A sample value can be something like the web session ID or the user name.
       # @option arguments [Boolean] :realtime If +true+, the request is real-time as opposed to near-real-time. Server default: true.
-      # @option arguments [Boolean] :refresh If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.
-      # @option arguments [String] :routing Target the specified primary shard.
-      # @option arguments [Boolean, String, Array<String>] :_source True or false to return the _source field or not, or a list of fields to return.
-      # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude in the response.
+      # @option arguments [Boolean] :refresh If +true+, the request refreshes the relevant shards before retrieving the document.
+      #  Setting it to +true+ should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
+      # @option arguments [String] :routing A custom value used to route operations to a specific shard.
+      # @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the +_source+ field (+true+ or +false+) or lists the fields to return.
+      # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude from the response.
+      #  You can also use this parameter to exclude fields from the subset specified in +_source_includes+ query parameter.
+      #  If the +_source+ parameter is +false+, this parameter is ignored.
       # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
-      # @option arguments [String, Array<String>] :stored_fields List of stored fields to return as part of a hit.
+      #  If this parameter is specified, only these source fields are returned.
+      #  You can exclude fields from this subset using the +_source_excludes+ query parameter.
+      #  If the +_source+ parameter is +false+, this parameter is ignored.
+      # @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return as part of a hit.
       #  If no fields are specified, no stored fields are included in the response.
-      #  If this field is specified, the +_source+ parameter defaults to false.
-      # @option arguments [Integer] :version Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.
-      # @option arguments [String] :version_type Specific version type: internal, external, external_gte.
+      #  If this field is specified, the +_source+ parameter defaults to +false+.
+      #  Only leaf fields can be retrieved with the +stored_field+ option.
+      #  Object fields can't be returned;​if specified, the request fails.
+      # @option arguments [Integer] :version The version number for concurrency control.
+      #  It must match the current version of the document for the request to succeed.
+      # @option arguments [String] :version_type The version type.
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get
       #
       def get(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "get" }
+        request_opts = { endpoint: arguments[:endpoint] || 'get' }
 
-        defined_params = [:index, :id].inject({}) do |set_variables, variable|
+        defined_params = [:index, :id].each_with_object({}) do |variable, set_variables|
           set_variables[variable] = arguments[variable] if arguments.key?(variable)
-          set_variables
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
 
@@ -71,11 +121,11 @@ module ElasticsearchServerless
         params = Utils.process_params(arguments)
 
         if Array(arguments[:ignore]).include?(404)
-          Utils.rescue_from_not_found {
+          Utils.rescue_from_not_found do
             ElasticsearchServerless::API::Response.new(
               perform_request(method, path, params, body, headers, request_opts)
             )
-          }
+          end
         else
           ElasticsearchServerless::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch-serverless/api/get_script.rb

@@ -24,18 +24,19 @@ module ElasticsearchServerless
       # Get a script or search template.
       # Retrieves a stored script or search template.
       #
-      # @option arguments [String] :id Identifier for the stored script or search template. (*Required*)
-      # @option arguments [Time] :master_timeout Specify timeout for connection to master
+      # @option arguments [String] :id The identifier for the stored script or search template. (*Required*)
+      # @option arguments [Time] :master_timeout The period to wait for the master node.
+      #  If the master node is not available before the timeout expires, the request fails and returns an error.
+      #  It can also be set to +-1+ to indicate that the request should never timeout. Server default: .
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script
       #
       def get_script(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "get_script" }
+        request_opts = { endpoint: arguments[:endpoint] || 'get_script' }
 
-        defined_params = [:id].inject({}) do |set_variables, variable|
+        defined_params = [:id].each_with_object({}) do |variable, set_variables|
           set_variables[variable] = arguments[variable] if arguments.key?(variable)
-          set_variables
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/get_source.rb

@@ -22,30 +22,40 @@ module ElasticsearchServerless
   module API
     module Actions
       # Get a document's source.
-      # Returns the source of a document.
+      # Get the source of a document.
+      # For example:
+      # +
+      # GET my-index-000001/_source/1
+      # +
+      # You can use the source filtering parameters to control which parts of the +_source+ are returned:
+      # +
+      # GET my-index-000001/_source/1/?_source_includes=*.id&_source_excludes=entities
+      # +
       #
-      # @option arguments [String] :id Unique identifier of the document. (*Required*)
-      # @option arguments [String] :index Name of the index that contains the document. (*Required*)
-      # @option arguments [String] :preference Specifies the node or shard the operation should be performed on. Random by default.
-      # @option arguments [Boolean] :realtime Boolean) If true, the request is real-time as opposed to near-real-time. Server default: true.
-      # @option arguments [Boolean] :refresh If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.
-      # @option arguments [String] :routing Target the specified primary shard.
-      # @option arguments [Boolean, String, Array<String>] :_source True or false to return the _source field or not, or a list of fields to return.
+      # @option arguments [String] :id A unique document identifier. (*Required*)
+      # @option arguments [String] :index The name of the index that contains the document. (*Required*)
+      # @option arguments [String] :preference The node or shard the operation should be performed on.
+      #  By default, the operation is randomized between the shard replicas.
+      # @option arguments [Boolean] :realtime If +true+, the request is real-time as opposed to near-real-time. Server default: true.
+      # @option arguments [Boolean] :refresh If +true+, the request refreshes the relevant shards before retrieving the document.
+      #  Setting it to +true+ should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
+      # @option arguments [String] :routing A custom value used to route operations to a specific shard.
+      # @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the +_source+ field (+true+ or +false+) or lists the fields to return.
       # @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude in the response.
       # @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
-      # @option arguments [String, Array<String>] :stored_fields [TODO]
-      # @option arguments [Integer] :version Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.
-      # @option arguments [String] :version_type Specific version type: internal, external, external_gte.
+      # @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return as part of a hit.
+      # @option arguments [Integer] :version The version number for concurrency control.
+      #  It must match the current version of the document for the request to succeed.
+      # @option arguments [String] :version_type The version type.
       # @option arguments [Hash] :headers Custom HTTP headers
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html
+      # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get
       #
       def get_source(arguments = {})
-        request_opts = { endpoint: arguments[:endpoint] || "get_source" }
+        request_opts = { endpoint: arguments[:endpoint] || 'get_source' }
 
-        defined_params = [:index, :id].inject({}) do |set_variables, variable|
+        defined_params = [:index, :id].each_with_object({}) do |variable, set_variables|
           set_variables[variable] = arguments[variable] if arguments.key?(variable)
-          set_variables
         end
         request_opts[:defined_params] = defined_params unless defined_params.empty?
 

data/lib/elasticsearch-serverless/api/graph/explore.rb

@@ -22,7 +22,12 @@ module ElasticsearchServerless
   module API
     module Graph
       module Actions
-        # Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index.
+        # Explore graph analytics.
+        # Extract and summarize information about the documents and terms in an Elasticsearch data stream or index.
+        # The easiest way to understand the behavior of this API is to use the Graph UI to explore connections.
+        # An initial request to the +_explore+ API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.
+        # Subsequent requests enable you to spider out from one more vertices of interest.
+        # You can exclude vertices that have already been returned.
         #
         # @option arguments [String, Array] :index Name of the index. (*Required*)
         # @option arguments [String] :routing Custom value used to route operations to a specific shard.
@@ -32,14 +37,13 @@ module ElasticsearchServerless
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-graph
         #
         def explore(arguments = {})
-          request_opts = { endpoint: arguments[:endpoint] || "graph.explore" }
+          request_opts = { endpoint: arguments[:endpoint] || 'graph.explore' }
 
-          defined_params = [:index].inject({}) do |set_variables, variable|
+          defined_params = [:index].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
-            set_variables
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?