Skip to content

Commit f6016a8

Browse files
committed
[API] Adds Query Ruleset namespace and query_ruleset.put API
1 parent 4b02da1 commit f6016a8

File tree

4 files changed

+132
-1
lines changed

4 files changed

+132
-1
lines changed

elasticsearch-api/lib/elasticsearch/api.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,8 @@ def self.included(base)
8282
Elasticsearch::API::XPack,
8383
Elasticsearch::API::SearchApplication,
8484
Elasticsearch::API::Synonyms,
85-
Elasticsearch::API::SynonymsSets
85+
Elasticsearch::API::SynonymsSets,
86+
Elasticsearch::API::QueryRuleset
8687
end
8788

8889
# The serializer class
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
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 QueryRuleset
24+
module Actions
25+
# Creates or updates a query ruleset.
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 [String] :ruleset_id The unique identifier of the ruleset to be created or updated.
32+
# @option arguments [Hash] :headers Custom HTTP headers
33+
# @option arguments [Hash] :body The query ruleset configuration, including `rules` (*Required*)
34+
#
35+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-query-ruleset.html
36+
#
37+
def put(arguments = {})
38+
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
39+
raise ArgumentError, "Required argument 'ruleset_id' missing" unless arguments[:ruleset_id]
40+
41+
arguments = arguments.clone
42+
headers = arguments.delete(:headers) || {}
43+
44+
body = arguments.delete(:body)
45+
46+
_ruleset_id = arguments.delete(:ruleset_id)
47+
48+
method = Elasticsearch::API::HTTP_PUT
49+
path = "_query_rules/#{Utils.__listify(_ruleset_id)}"
50+
params = {}
51+
52+
Elasticsearch::API::Response.new(
53+
perform_request(method, path, params, body, headers)
54+
)
55+
end
56+
end
57+
end
58+
end
59+
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 QueryRuleset
21+
module Actions; end
22+
23+
# Client for the "query_ruleset" namespace (includes the {QueryRuleset::Actions} methods)
24+
#
25+
class QueryRulesetClient
26+
include Common::Client, Common::Client::Base, QueryRuleset::Actions
27+
end
28+
29+
# Proxy method for {QueryRulesetClient}, available in the receiving object
30+
#
31+
def query_ruleset
32+
@query_ruleset ||= QueryRulesetClient.new(self)
33+
end
34+
end
35+
end
36+
end
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
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.query_ruleset#put' do
21+
22+
let(:expected_args) do
23+
[
24+
'PUT',
25+
'_query_rules/foo',
26+
{},
27+
{},
28+
{}
29+
]
30+
end
31+
32+
it 'performs the request' do
33+
expect(client_double.query_ruleset.put(body: {}, ruleset_id: 'foo')).to be_a Elasticsearch::API::Response
34+
end
35+
end

0 commit comments

Comments
 (0)