opensearch-api 2.0.2 → 2.2.0

data.tar.gz.sig

@@ -1 +1 @@
-D+7���V�C
J��c����Ց:�o�����/T�4T�0 <�91j$���e�r),��)D|a�"�t��@�Źm�m�.�؇��Thx�w!�C�c����!i�!���u�Y�2��h>H'S�����c��4�m���	5GY���
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opensearch-api
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Jayesh Hathila
@@ -15,7 +15,7 @@ cert_chain:
   -----BEGIN CERTIFICATE-----
   MIIDfDCCAmSgAwIBAgIBATANBgkqhkiG9w0BAQUFADBCMRMwEQYDVQQDDApvcGVu
   c2VhcmNoMRYwFAYKCZImiZPyLGQBGRYGYW1hem9uMRMwEQYKCZImiZPyLGQBGRYD
-  Y29tMB4XDTIxMDgwMjIxMDQwM1oXDTIyMDgwMjIxMDQwM1owQjETMBEGA1UEAwwK
+  Y29tMB4XDTIyMDgxNzE3NTIzNFoXDTIzMDgxNzE3NTIzNFowQjETMBEGA1UEAwwK
   b3BlbnNlYXJjaDEWMBQGCgmSJomT8ixkARkWBmFtYXpvbjETMBEGCgmSJomT8ixk
   ARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAM1z3/jcitjV
   umXwRFn+JSBBd36qZB54Dtucf6+E2fmNPzBRhgYN5XJy/+clQJ9NIJV7C8H52P3V
@@ -26,14 +26,14 @@ cert_chain:
   zfR37/NQFkECAwEAAaN9MHswCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
   BBYEFJJ2myhLXK742btavNbG0IWrMNBIMCAGA1UdEQQZMBeBFW9wZW5zZWFyY2hA
   YW1hem9uLmNvbTAgBgNVHRIEGTAXgRVvcGVuc2VhcmNoQGFtYXpvbi5jb20wDQYJ
-  KoZIhvcNAQEFBQADggEBAE7gBP5ecTtKb04qmEsnbJ6+yn0LUSmxPabFBnB6h1+T
-  XW8BvBw9MpE//5fQf4HSia3m9XjRpl4WxBcJiyfLER64tk/c1JLhV2+rq3CCV/be
-  DFSP6gY93kK7jwauajGQvyHzORaW1TBM6diIRYCMLY7Isf+PTHl0xhZZBSVm8wl6
-  IstV+mTP2KC1l7hSzUDb4rrOSnpRB7AEczcDdkjwzHKIlw8rcL+PLLnFTOgqKyq3
-  yXikuH6LEVykA8pgOcB9gKsB2/zMd2ZlSj2monM8Qw9EfB14ZSDTYS8VYuwWCeF0
-  eFmXXk0ufQFKl1Yll7quHkmQ0PzKkvXTpONBT6qPkXE=
+  KoZIhvcNAQEFBQADggEBAH5pWLYwKWFh1OjdCReGz/VEAiF4jXXputoN5Z8ga+1Z
+  lg8/diJf0PlP2B46PdmxH/TVc/o+qglNO2cHVEp8xZfEd83dfioOBeK90URQUpC5
+  UZmO0LZusg46SQKwKa2ukpIy2fNi3PeHRiV+W2Zv69GoWppyLun+fMez7wVoah2r
+  r5ROUYuAvFUvga1Vm+49pKiPM5n+MAYP5t/vWhgymY3SYQ1TfewkvKAFiFXikOR+
+  r+j7FLyKuk5DzIxiCp8QN5dU71BbGUmsHf/C5UV76WLPOFX/szeaHhPwpjR3sK7r
+  5zLgCV1KP7cgDdCYMlmZGeSViU8NV+Yy8/ghrzGpqVw=
   -----END CERTIFICATE-----
-date: 2022-06-30 00:00:00.000000000 Z
+date: 2023-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -78,19 +78,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: opensearch
+  name: opensearch-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: opensearch-transport
   requirement: !ruby/object:Gem::Requirement
@@ -315,9 +315,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'Ruby API for OpenSearch. See the `opensearch` gem for full integration.
+description: 'Ruby API for OpenSearch. See the `opensearch-ruby` gem for full integration.
 
-'
+  '
 email:
 - jayehh@amazon.com
 - vamshin@amazon.com
@@ -330,17 +330,21 @@ extra_rdoc_files:
 - LICENSE
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- USER_GUIDE.md
 - lib/opensearch-api.rb
 - lib/opensearch/api.rb
 - lib/opensearch/api/actions/abort_benchmark.rb
 - lib/opensearch/api/actions/benchmark.rb
 - lib/opensearch/api/actions/bulk.rb
 - lib/opensearch/api/actions/cat/aliases.rb
+- lib/opensearch/api/actions/cat/all_pit_segments.rb
 - lib/opensearch/api/actions/cat/allocation.rb
+- lib/opensearch/api/actions/cat/cluster_manager.rb
 - lib/opensearch/api/actions/cat/count.rb
 - lib/opensearch/api/actions/cat/fielddata.rb
 - lib/opensearch/api/actions/cat/health.rb
@@ -351,6 +355,7 @@ files:
 - lib/opensearch/api/actions/cat/nodes.rb
 - lib/opensearch/api/actions/cat/params_registry.rb
 - lib/opensearch/api/actions/cat/pending_tasks.rb
+- lib/opensearch/api/actions/cat/pit_segments.rb
 - lib/opensearch/api/actions/cat/plugins.rb
 - lib/opensearch/api/actions/cat/recovery.rb
 - lib/opensearch/api/actions/cat/repositories.rb
@@ -361,7 +366,6 @@ files:
 - lib/opensearch/api/actions/cat/templates.rb
 - lib/opensearch/api/actions/cat/thread_pool.rb
 - lib/opensearch/api/actions/clear_scroll.rb
-- lib/opensearch/api/actions/close_point_in_time.rb
 - lib/opensearch/api/actions/cluster/allocation_explain.rb
 - lib/opensearch/api/actions/cluster/delete_component_template.rb
 - lib/opensearch/api/actions/cluster/delete_voting_config_exclusions.rb
@@ -380,14 +384,17 @@ files:
 - lib/opensearch/api/actions/cluster/stats.rb
 - lib/opensearch/api/actions/count.rb
 - lib/opensearch/api/actions/create.rb
+- lib/opensearch/api/actions/create_pit.rb
 - lib/opensearch/api/actions/dangling_indices/delete_dangling_index.rb
 - lib/opensearch/api/actions/dangling_indices/import_dangling_index.rb
 - lib/opensearch/api/actions/dangling_indices/list_dangling_indices.rb
 - lib/opensearch/api/actions/dangling_indices/params_registry.rb
 - lib/opensearch/api/actions/delete.rb
+- lib/opensearch/api/actions/delete_all_pits.rb
 - lib/opensearch/api/actions/delete_by_query.rb
 - lib/opensearch/api/actions/delete_by_query_rethrottle.rb
 - lib/opensearch/api/actions/delete_by_rethrottle.rb
+- lib/opensearch/api/actions/delete_pit.rb
 - lib/opensearch/api/actions/delete_script.rb
 - lib/opensearch/api/actions/exists.rb
 - lib/opensearch/api/actions/exists_source.rb
@@ -397,6 +404,7 @@ files:
 - lib/opensearch/api/actions/features/reset_features.rb
 - lib/opensearch/api/actions/field_caps.rb
 - lib/opensearch/api/actions/get.rb
+- lib/opensearch/api/actions/get_all_pits.rb
 - lib/opensearch/api/actions/get_script.rb
 - lib/opensearch/api/actions/get_script_context.rb
 - lib/opensearch/api/actions/get_script_languages.rb
@@ -468,7 +476,6 @@ files:
 - lib/opensearch/api/actions/nodes/shutdown.rb
 - lib/opensearch/api/actions/nodes/stats.rb
 - lib/opensearch/api/actions/nodes/usage.rb
-- lib/opensearch/api/actions/open_point_in_time.rb
 - lib/opensearch/api/actions/params_registry.rb
 - lib/opensearch/api/actions/ping.rb
 - lib/opensearch/api/actions/put_script.rb
@@ -528,7 +535,9 @@ files:
 - spec/opensearch/api/actions/benchmark_spec.rb
 - spec/opensearch/api/actions/bulk_spec.rb
 - spec/opensearch/api/actions/cat/aliases_spec.rb
+- spec/opensearch/api/actions/cat/all_pit_segments_spec.rb
 - spec/opensearch/api/actions/cat/allocation_spec.rb
+- spec/opensearch/api/actions/cat/cluster_manager_spec.rb
 - spec/opensearch/api/actions/cat/count_spec.rb
 - spec/opensearch/api/actions/cat/fielddata_spec.rb
 - spec/opensearch/api/actions/cat/health_spec.rb
@@ -538,6 +547,7 @@ files:
 - spec/opensearch/api/actions/cat/nodeattrs_spec.rb
 - spec/opensearch/api/actions/cat/nodes_spec.rb
 - spec/opensearch/api/actions/cat/pending_tasks_spec.rb
+- spec/opensearch/api/actions/cat/pit_segments_spec.rb
 - spec/opensearch/api/actions/cat/plugins_spec.rb
 - spec/opensearch/api/actions/cat/recovery_spec.rb
 - spec/opensearch/api/actions/cat/repositories_spec.rb
@@ -548,7 +558,6 @@ files:
 - spec/opensearch/api/actions/cat/templates_spec.rb
 - spec/opensearch/api/actions/cat/thread_pool_spec.rb
 - spec/opensearch/api/actions/clear_scroll_spec.rb
-- spec/opensearch/api/actions/close_point_in_time_spec.rb
 - spec/opensearch/api/actions/cluster/allocation_explain_spec.rb
 - spec/opensearch/api/actions/cluster/get_settings_spec.rb
 - spec/opensearch/api/actions/cluster/health_spec.rb
@@ -560,17 +569,21 @@ files:
 - spec/opensearch/api/actions/cluster/stats_spec.rb
 - spec/opensearch/api/actions/count_spec.rb
 - spec/opensearch/api/actions/create_document_spec.rb
+- spec/opensearch/api/actions/create_pit_spec.rb
 - spec/opensearch/api/actions/dangling_indices/delete_dangling_indices_spec.rb
 - spec/opensearch/api/actions/dangling_indices/import_dangling_indices_spec.rb
 - spec/opensearch/api/actions/dangling_indices/list_dangling_indices_spec.rb
+- spec/opensearch/api/actions/delete_all_pits_spec.rb
 - spec/opensearch/api/actions/delete_by_query_spec.rb
 - spec/opensearch/api/actions/delete_document_spec.rb
+- spec/opensearch/api/actions/delete_pit_spec.rb
 - spec/opensearch/api/actions/delete_script_spec.rb
 - spec/opensearch/api/actions/exists_document_spec.rb
 - spec/opensearch/api/actions/explain_document_spec.rb
 - spec/opensearch/api/actions/features/get_features_spec.rb
 - spec/opensearch/api/actions/features/reset_features_spec.rb
 - spec/opensearch/api/actions/field_caps_spec.rb
+- spec/opensearch/api/actions/get_all_pits_spec.rb
 - spec/opensearch/api/actions/get_document_source_spec.rb
 - spec/opensearch/api/actions/get_document_spec.rb
 - spec/opensearch/api/actions/get_script_spec.rb
@@ -629,7 +642,6 @@ files:
 - spec/opensearch/api/actions/nodes/reload_secure_settings_spec.rb
 - spec/opensearch/api/actions/nodes/shutdown_spec.rb
 - spec/opensearch/api/actions/nodes/stats_spec.rb
-- spec/opensearch/api/actions/open_point_in_time_spec.rb
 - spec/opensearch/api/actions/ping_spec.rb
 - spec/opensearch/api/actions/put_script_spec.rb
 - spec/opensearch/api/actions/reindex_spec.rb
@@ -690,7 +702,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Ruby API for OpenSearch.
@@ -699,7 +711,9 @@ test_files:
 - spec/opensearch/api/actions/benchmark_spec.rb
 - spec/opensearch/api/actions/bulk_spec.rb
 - spec/opensearch/api/actions/cat/aliases_spec.rb
+- spec/opensearch/api/actions/cat/all_pit_segments_spec.rb
 - spec/opensearch/api/actions/cat/allocation_spec.rb
+- spec/opensearch/api/actions/cat/cluster_manager_spec.rb
 - spec/opensearch/api/actions/cat/count_spec.rb
 - spec/opensearch/api/actions/cat/fielddata_spec.rb
 - spec/opensearch/api/actions/cat/health_spec.rb
@@ -709,6 +723,7 @@ test_files:
 - spec/opensearch/api/actions/cat/nodeattrs_spec.rb
 - spec/opensearch/api/actions/cat/nodes_spec.rb
 - spec/opensearch/api/actions/cat/pending_tasks_spec.rb
+- spec/opensearch/api/actions/cat/pit_segments_spec.rb
 - spec/opensearch/api/actions/cat/plugins_spec.rb
 - spec/opensearch/api/actions/cat/recovery_spec.rb
 - spec/opensearch/api/actions/cat/repositories_spec.rb
@@ -719,7 +734,6 @@ test_files:
 - spec/opensearch/api/actions/cat/templates_spec.rb
 - spec/opensearch/api/actions/cat/thread_pool_spec.rb
 - spec/opensearch/api/actions/clear_scroll_spec.rb
-- spec/opensearch/api/actions/close_point_in_time_spec.rb
 - spec/opensearch/api/actions/cluster/allocation_explain_spec.rb
 - spec/opensearch/api/actions/cluster/get_settings_spec.rb
 - spec/opensearch/api/actions/cluster/health_spec.rb
@@ -731,17 +745,21 @@ test_files:
 - spec/opensearch/api/actions/cluster/stats_spec.rb
 - spec/opensearch/api/actions/count_spec.rb
 - spec/opensearch/api/actions/create_document_spec.rb
+- spec/opensearch/api/actions/create_pit_spec.rb
 - spec/opensearch/api/actions/dangling_indices/delete_dangling_indices_spec.rb
 - spec/opensearch/api/actions/dangling_indices/import_dangling_indices_spec.rb
 - spec/opensearch/api/actions/dangling_indices/list_dangling_indices_spec.rb
+- spec/opensearch/api/actions/delete_all_pits_spec.rb
 - spec/opensearch/api/actions/delete_by_query_spec.rb
 - spec/opensearch/api/actions/delete_document_spec.rb
+- spec/opensearch/api/actions/delete_pit_spec.rb
 - spec/opensearch/api/actions/delete_script_spec.rb
 - spec/opensearch/api/actions/exists_document_spec.rb
 - spec/opensearch/api/actions/explain_document_spec.rb
 - spec/opensearch/api/actions/features/get_features_spec.rb
 - spec/opensearch/api/actions/features/reset_features_spec.rb
 - spec/opensearch/api/actions/field_caps_spec.rb
+- spec/opensearch/api/actions/get_all_pits_spec.rb
 - spec/opensearch/api/actions/get_document_source_spec.rb
 - spec/opensearch/api/actions/get_document_spec.rb
 - spec/opensearch/api/actions/get_script_spec.rb
@@ -800,7 +818,6 @@ test_files:
 - spec/opensearch/api/actions/nodes/reload_secure_settings_spec.rb
 - spec/opensearch/api/actions/nodes/shutdown_spec.rb
 - spec/opensearch/api/actions/nodes/stats_spec.rb
-- spec/opensearch/api/actions/open_point_in_time_spec.rb
 - spec/opensearch/api/actions/ping_spec.rb
 - spec/opensearch/api/actions/put_script_spec.rb
 - spec/opensearch/api/actions/reindex_spec.rb

data/lib/opensearch/api/actions/close_point_in_time.rb

@@ -1,50 +0,0 @@
-# SPDX-License-Identifier: Apache-2.0
-#
-# The OpenSearch Contributors require contributions made to
-# this file be licensed under the Apache-2.0 license or a
-# compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-#
-# 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 OpenSearch
-  module API
-    module Actions
-      # Close a point in time
-      #
-      # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body a point-in-time id to close
-      #
-      #
-      def close_point_in_time(arguments = {})
-        headers = arguments.delete(:headers) || {}
-
-        arguments = arguments.clone
-
-        method = OpenSearch::API::HTTP_DELETE
-        path   = "_pit"
-        params = {}
-
-        body = arguments[:body]
-        perform_request(method, path, params, body, headers).body
-      end
-    end
-  end
-end

data/lib/opensearch/api/actions/open_point_in_time.rb

@@ -1,72 +0,0 @@
-# SPDX-License-Identifier: Apache-2.0
-#
-# The OpenSearch Contributors require contributions made to
-# this file be licensed under the Apache-2.0 license or a
-# compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-#
-# 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 OpenSearch
-  module API
-    module Actions
-      # Open a point in time that can be used in subsequent searches
-      #
-      # @option arguments [List] :index A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
-      # @option arguments [String] :routing Specific routing value
-      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
-      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
-      # @option arguments [String] :keep_alive Specific the time to live for the point in time
-      # @option arguments [Hash] :headers Custom HTTP headers
-      #
-      #
-      def open_point_in_time(arguments = {})
-        headers = arguments.delete(:headers) || {}
-
-        arguments = arguments.clone
-
-        _index = arguments.delete(:index)
-
-        method = OpenSearch::API::HTTP_POST
-        path   = if _index
-                   "#{Utils.__listify(_index)}/_pit"
-                 else
-                   "_pit"
-                 end
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-        body = nil
-        perform_request(method, path, params, body, headers).body
-      end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:open_point_in_time, [
-        :preference,
-        :routing,
-        :ignore_unavailable,
-        :expand_wildcards,
-        :keep_alive
-      ].freeze)
-    end
-  end
-end

data/spec/opensearch/api/actions/close_point_in_time_spec.rb

@@ -1,43 +0,0 @@
-# SPDX-License-Identifier: Apache-2.0
-#
-# The OpenSearch Contributors require contributions made to
-# this file be licensed under the Apache-2.0 license or a
-# compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-#
-# 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#close_point_in_time' do
-  let(:expected_args) do
-    [
-      'DELETE',
-      '_pit',
-      {},
-      nil,
-      {}
-    ]
-  end
-
-  it 'performs the request' do
-    expect(client_double.close_point_in_time).to eq({})
-  end
-end

data/spec/opensearch/api/actions/open_point_in_time_spec.rb

@@ -1,53 +0,0 @@
-# SPDX-License-Identifier: Apache-2.0
-#
-# The OpenSearch Contributors require contributions made to
-# this file be licensed under the Apache-2.0 license or a
-# compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-#
-# 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#open_point_in_time' do
-  let(:expected_args) do
-    [
-      'POST',
-      url,
-      {},
-      nil,
-      {}
-    ]
-  end
-
-  let (:url) { '_pit'}
-
-  it 'performs the request' do
-    expect(client_double.open_point_in_time).to eq({})
-  end
-
-  context 'with index' do
-    let (:url) { 'foo/_pit'}
-
-    it 'performs the request' do
-      expect(client_double.open_point_in_time(index: 'foo')).to eq({})
-    end
-  end
-end