lib/elasticsearch/api/actions/cat/help.rb in elasticsearch-api-6.8.3 vs lib/elasticsearch/api/actions/cat/help.rb in elasticsearch-api-7.0.0.pre
- old
+ new
@@ -1,20 +1,32 @@
-# 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 Cat
module Actions
# Help information for the Cat API
#
# @option arguments [Boolean] :help Return help information
- # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
#
- # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cat.html
+ # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html
#
def help(arguments={})
method = HTTP_GET
path = "_cat"
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
@@ -23,10 +35,10 @@
perform_request(method, path, params, body).body
end
# Register this action with its valid params when the module is loaded.
#
- # @since 6.2.0
+ # @since 6.1.1
ParamsRegistry.register(:help, [
:help,
:s ].freeze)
end
end