Contents

module Elasticsearch
  module API
    module Cat
      module Actions

        # Help information for the Cat API
        #
        # @option arguments [Boolean] :help Return help information
        #
        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html
        #
        def help(arguments={})
          valid_params = [
            :help ]
          method = 'GET'
          path   = "_cat"
          params = Utils.__validate_and_extract_params arguments, valid_params
          body   = nil

          perform_request(method, path, params, body).body
        end
      end
    end
  end
end

Version data entries

8 entries across 8 versions & 1 rubygems

Version	Path
elasticsearch-api-1.0.6	lib/elasticsearch/api/actions/cat/help.rb
elasticsearch-api-1.0.5	lib/elasticsearch/api/actions/cat/help.rb
elasticsearch-api-1.0.4	lib/elasticsearch/api/actions/cat/help.rb
elasticsearch-api-1.0.2	lib/elasticsearch/api/actions/cat/help.rb
elasticsearch-api-1.0.1	lib/elasticsearch/api/actions/cat/help.rb
elasticsearch-api-1.0.0	lib/elasticsearch/api/actions/cat/help.rb
elasticsearch-api-1.0.0.rc2	lib/elasticsearch/api/actions/cat/help.rb
elasticsearch-api-1.0.0.rc1	lib/elasticsearch/api/actions/cat/help.rb