lib/elasticsearch/api/actions/get.rb in elasticsearch-api-6.8.3 vs lib/elasticsearch/api/actions/get.rb in elasticsearch-api-7.0.0.pre

- old
+ new

@@ -1,8 +1,21 @@ -# Licensed to Elasticsearch B.V under one or more agreements. -# Elasticsearch B.V licenses this file to you under the Apache 2.0 License. -# See the LICENSE file in the project root for more information +# 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 @@ -14,11 +27,11 @@ # # client.get index: 'myindex', type: 'mytype', id: '1' # # @option arguments [String] :id The document ID (*Required*) # @option arguments [String] :index The name of the index (*Required*) - # @option arguments [String] :type The type of the document (use `_all` to fetch the first document matching the ID across all types) (*Required*) + # @option arguments [String] :type The type of the document (use `_all` to fetch the first document matching the ID across all types) # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response # @option arguments [String] :parent The ID of the parent document # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation @@ -34,11 +47,12 @@ # @see http://elasticsearch.org/guide/reference/api/get/ # def get(arguments={}) raise ArgumentError, "Required argument 'index' missing" unless arguments[:index] raise ArgumentError, "Required argument 'id' missing" unless arguments[:id] - arguments[:type] ||= UNDERSCORE_ALL + arguments[:type] ||= DEFAULT_DOC + method = HTTP_GET path = Utils.__pathify Utils.__escape(arguments[:index]), Utils.__escape(arguments[:type]), Utils.__escape(arguments[:id]) @@ -54,10 +68,10 @@ end end # Register this action with its valid params when the module is loaded. # - # @since 6.2.0 + # @since 6.1.1 ParamsRegistry.register(:get, [ :stored_fields, :parent, :preference, :realtime,