[API] Adds security.query_api_keys

Author: picandocodigo

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/security/query_api_keys.rb

@@ -0,0 +1,51 @@
+# 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 XPack
+    module API
+      module Security
+        module Actions
+          # Retrieves information for API keys using a subset of query DSL
+          #
+          # @option arguments [Hash] :headers Custom HTTP headers
+          # @option arguments [Hash] :body From, size, query, sort and search_after
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-query-api-key.html
+          #
+          def query_api_keys(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            method = if arguments[:body]
+                       Elasticsearch::API::HTTP_POST
+                     else
+                       Elasticsearch::API::HTTP_GET
+                     end
+
+            path   = "_security/_query/api_key"
+            params = {}
+
+            body = arguments[:body]
+            perform_request(method, path, params, body, headers).body
+          end
+        end
+      end
+    end
+  end
+end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/sql/clear_cursor.rb

@@ -25,7 +25,7 @@ module Actions
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body Specify the cursor value in the `cursor` element to clean the cursor. (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/sql-pagination.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/clear-sql-cursor-api.html
           #
           def clear_cursor(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

elasticsearch-xpack/spec/xpack/security/query_api_keys_spec.rb

@@ -0,0 +1,48 @@
+# 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.
+
+require 'spec_helper'
+
+describe 'client#security#query_api_keys' do
+  let(:expected_args) do
+    [
+      method,
+      '_security/_query/api_key',
+      {},
+      body,
+      {}
+    ]
+  end
+
+  let(:body) { nil }
+  let(:method) { 'GET' }
+
+  it 'performs the request' do
+    expect(client_double.security.query_api_keys).to eq({})
+  end
+
+  context 'when body is specified' do
+    let(:body) do
+      { size: 1, query: 'test' }
+    end
+    let(:method) { 'POST' }
+
+    it 'performs the request' do
+      expect(client_double.security.query_api_keys(body: body)).to eq({})
+    end
+  end
+end