Skip to content

Commit 7c9b6af

Browse files
committed
[API] Adds capabilities endpoint
1 parent dbb602c commit 7c9b6af

File tree

2 files changed

+91
-0
lines changed

2 files changed

+91
-0
lines changed
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
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 Actions
24+
# Checks if the specified combination of method, API, parameters, and arbitrary capabilities are supported
25+
# This functionality is Experimental and may be changed or removed
26+
# completely in a future release. Elastic will take a best effort approach
27+
# to fix any issues, but experimental features are not subject to the
28+
# support SLA of official GA features.
29+
#
30+
# @option arguments [String] :method REST method to check (options: GET, HEAD, POST, PUT, DELETE)
31+
# @option arguments [String] :path API path to check
32+
# @option arguments [String] :parameters Comma-separated list of API parameters to check
33+
# @option arguments [String] :capabilities Comma-separated list of arbitrary API capabilities to check
34+
# @option arguments [Hash] :headers Custom HTTP headers
35+
#
36+
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/capabilities.html
37+
#
38+
def capabilities(arguments = {})
39+
request_opts = { endpoint: arguments[:endpoint] || 'capabilities' }
40+
41+
arguments = arguments.clone
42+
headers = arguments.delete(:headers) || {}
43+
44+
body = nil
45+
46+
method = Elasticsearch::API::HTTP_GET
47+
path = '_capabilities'
48+
params = Utils.process_params(arguments)
49+
50+
Elasticsearch::API::Response.new(
51+
perform_request(method, path, params, body, headers, request_opts)
52+
)
53+
end
54+
end
55+
end
56+
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#capabilities' do
21+
let(:expected_args) do
22+
[
23+
'GET',
24+
'_capabilities',
25+
{},
26+
nil,
27+
{},
28+
{ endpoint: 'capabilities' }
29+
]
30+
end
31+
32+
it 'performs the request' do
33+
expect(client_double.capabilities).to be_a Elasticsearch::API::Response
34+
end
35+
end

0 commit comments

Comments
 (0)