From 68df32575e5e5d2bb0682b915abd41036f3473b8 Mon Sep 17 00:00:00 2001 From: Fernando Briano Date: Fri, 2 Feb 2024 06:03:02 +0000 Subject: [PATCH] [API] Adds connector.update_api_key_id endpoint --- .../actions/connector/update_api_key_id.rb | 66 +++++++++++++++++++ .../connector/update_api_key_id_spec.rb | 38 +++++++++++ 2 files changed, 104 insertions(+) create mode 100644 elasticsearch-api/lib/elasticsearch/api/actions/connector/update_api_key_id.rb create mode 100644 elasticsearch-api/spec/elasticsearch/api/actions/connector/update_api_key_id_spec.rb diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_api_key_id.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_api_key_id.rb new file mode 100644 index 0000000000..9e6002aab7 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_api_key_id.rb @@ -0,0 +1,66 @@ +# 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. +# +# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 +# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec +# +module Elasticsearch + module API + module Connector + module Actions + # Updates the API key id and/or API key secret id fields in the connector document. + # This functionality is Experimental and may be changed or removed + # completely in a future release. Elastic will take a best effort approach + # to fix any issues, but experimental features are not subject to the + # support SLA of official GA features. + # + # @option arguments [String] :connector_id The unique identifier of the connector to be updated. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body An object containing the connector's API key id and/or Connector Secret document id for that API key. (*Required*) + # + # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/connector-apis.html + # + def update_api_key_id(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'connector.update_api_key_id' } + + defined_params = [:connector_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] + raise ArgumentError, "Required argument 'connector_id' missing" unless arguments[:connector_id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _connector_id = arguments.delete(:connector_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_connector/#{Utils.__listify(_connector_id)}/_api_key_id" + params = {} + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/spec/elasticsearch/api/actions/connector/update_api_key_id_spec.rb b/elasticsearch-api/spec/elasticsearch/api/actions/connector/update_api_key_id_spec.rb new file mode 100644 index 0000000000..ecc638fafb --- /dev/null +++ b/elasticsearch-api/spec/elasticsearch/api/actions/connector/update_api_key_id_spec.rb @@ -0,0 +1,38 @@ +# 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.connector#check_in' do + let(:expected_args) do + [ + 'PUT', + '_connector/foo/_api_key_id', + {}, + {}, + {}, + { + :defined_params=>{ connector_id: 'foo' }, + endpoint: 'connector.update_api_key_id' + } + ] + end + + it 'performs the request' do + expect(client_double.connector.update_api_key_id(body: {}, connector_id: 'foo')).to be_a Elasticsearch::API::Response + end +end