Skip to content

Commit 1e3cb59

Browse files
committed
[API] Adds synonyms_set namespace, synonyms_set.get API
1 parent 5aba69f commit 1e3cb59

File tree

4 files changed

+126
-1
lines changed

4 files changed

+126
-1
lines changed

elasticsearch-api/lib/elasticsearch/api.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,8 @@ def self.included(base)
8181
Elasticsearch::API::Watcher,
8282
Elasticsearch::API::XPack,
8383
Elasticsearch::API::SearchApplication,
84-
Elasticsearch::API::Synonyms
84+
Elasticsearch::API::Synonyms,
85+
Elasticsearch::API::SynonymsSets
8586
end
8687

8788
# The serializer class
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Licensed to Elasticsearch B.V. under one or more contributor
2+
# license agreements. See the NOTICE file distributed with
3+
# this work for additional information regarding copyright
4+
# ownership. Elasticsearch B.V. licenses this file to you under
5+
# the Apache License, Version 2.0 (the "License"); you may
6+
# not use this file except in compliance with the License.
7+
# You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
#
18+
# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
19+
# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
20+
#
21+
module Elasticsearch
22+
module API
23+
module SynonymsSets
24+
module Actions
25+
# Retrieves a summary of all defined synonym sets
26+
# This functionality is Experimental and may be changed or removed
27+
# completely in a future release. Elastic will take a best effort approach
28+
# to fix any issues, but experimental features are not subject to the
29+
# support SLA of official GA features.
30+
#
31+
# @option arguments [Integer] :from Starting offset
32+
# @option arguments [Integer] :size specifies a max number of results to get
33+
# @option arguments [Hash] :headers Custom HTTP headers
34+
#
35+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/list-synonyms.html
36+
#
37+
def get(arguments = {})
38+
arguments = arguments.clone
39+
headers = arguments.delete(:headers) || {}
40+
41+
body = nil
42+
43+
method = Elasticsearch::API::HTTP_GET
44+
path = "_synonyms"
45+
params = Utils.process_params(arguments)
46+
47+
Elasticsearch::API::Response.new(
48+
perform_request(method, path, params, body, headers)
49+
)
50+
end
51+
end
52+
end
53+
end
54+
end
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Licensed to Elasticsearch B.V. under one or more contributor
2+
# license agreements. See the NOTICE file distributed with
3+
# this work for additional information regarding copyright
4+
# ownership. Elasticsearch B.V. licenses this file to you under
5+
# the Apache License, Version 2.0 (the "License"); you may
6+
# not use this file except in compliance with the License.
7+
# You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
18+
module Elasticsearch
19+
module API
20+
module SynonymsSets
21+
module Actions; end
22+
23+
# Client for the "synonyms_sets" namespace (includes the {SynonymsSets::Actions} methods)
24+
#
25+
class SynonymsSetsClient
26+
include Common::Client, Common::Client::Base, SynonymsSets::Actions
27+
end
28+
29+
# Proxy method for {SynonymsSetsClient}, available in the receiving object
30+
#
31+
def synonyms_sets
32+
@synonyms_sets ||= SynonymsSetsClient.new(self)
33+
end
34+
end
35+
end
36+
end
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Licensed to Elasticsearch B.V. under one or more contributor
2+
# license agreements. See the NOTICE file distributed with
3+
# this work for additional information regarding copyright
4+
# ownership. Elasticsearch B.V. licenses this file to you under
5+
# the Apache License, Version 2.0 (the "License"); you may
6+
# not use this file except in compliance with the License.
7+
# You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
18+
require 'spec_helper'
19+
20+
describe 'client.synonyms_sets#get' do
21+
let(:expected_args) do
22+
[
23+
'GET',
24+
'_synonyms',
25+
{},
26+
nil,
27+
{}
28+
]
29+
end
30+
31+
it 'performs the request' do
32+
expect(client_double.synonyms_sets.get).to be_a Elasticsearch::API::Response
33+
end
34+
end

0 commit comments

Comments
 (0)