Skip to content

Commit 0723e03

Browse files
committed
[DOCS] Adds more details on X-Pack documentation
1 parent 9a77404 commit 0723e03

File tree

3 files changed

+11
-10
lines changed

3 files changed

+11
-10
lines changed

docs/overview.asciidoc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,17 @@ More documentation is hosted in https://github.com/elastic/elasticsearch-ruby[Gi
2424
[[transport-api]]
2525
=== Transport and API
2626

27-
The `elasticsearch` gem combines two separate Rubygems:
27+
The `elasticsearch` gem combines three separate Rubygems:
2828

29-
* https://github.com/elastic/elasticsearch-ruby/tree/master/elasticsearch-transport[`elasticsearch-transport`]
29+
* https://github.com/elastic/elasticsearch-ruby/tree/7.16/elasticsearch-transport[`elasticsearch-transport`]
3030
provides an HTTP Ruby client for connecting to the {es} cluster,
3131

32-
* https://github.com/elastic/elasticsearch-ruby/tree/master/elasticsearch-api[`elasticsearch-api`]
32+
* https://github.com/elastic/elasticsearch-ruby/tree/7.16/elasticsearch-api[`elasticsearch-api`]
3333
provides a Ruby API for the {es} RESTful API.
3434

35+
* https://github.com/elastic/elasticsearch-ruby/tree/7.16/elasticsearch-xpack/[`elasticsearch-xpack`]
36+
provides a Ruby API for the {es} RESTful API for X-Pack endpoints. Notice that the API endpoints living in `elasticsearch-xpack` will be moved into `elasticsearch-api` in version 8.0.0 and forward. You should be able to keep using `elasticsearch-xpack` and the `xpack` namespace in `7.x` versions. We're running the same tests in `elasticsearch-xpack`, but if you encounter any problems, please let us know https://github.com/elastic/elasticsearch-ruby/issues/1274[in this issue].
37+
3538
Please consult their respective documentation for configuration options and
3639
technical details.
3740

docs/transport.asciidoc

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,6 @@ data serialization and transport.
1111

1212
It does not handle calling the {es} API.
1313

14-
The library is compatible with Ruby 1.9 or higher and with all versions of {es}
15-
since 0.90.
16-
1714
For optimal performance, use a HTTP library which supports persistent
1815
("keep-alive") connections, such as https://github.com/toland/patron[patron] or
1916
https://github.com/typhoeus/typhoeus[Typhoeus]. Require the library
@@ -58,7 +55,7 @@ any configuration:
5855
require 'elasticsearch/transport'
5956

6057
client = Elasticsearch::Client.new
61-
response = client.perform_request 'GET', '_cluster/health'
58+
response = client.perform_request('GET', '_cluster/health')
6259
# => #<Elasticsearch::Transport::Transport::Response:0x007fc5d506ce38 @status=200, @body={ ... } >
6360
```
6461

@@ -250,4 +247,4 @@ by injecting it directly.
250247

251248
* The `Elasticsearch::Transport::Transport::Connections::Selector::Base`
252249
implementations allow to choose connections from the pool, for example, in a
253-
round-robin or random fashion. You can implement your own selector strategy.
250+
round-robin or random fashion. You can implement your own selector strategy.

elasticsearch-xpack/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,15 @@ A Ruby integration for the [X-Pack extension](https://www.elastic.co/guide/en/x-
1515

1616
Install the package from [Rubygems](https://rubygems.org):
1717

18-
gem install elasticsearch-api
18+
gem install elasticsearch-xpack
1919

2020
## Usage
2121

22-
If you use the official [Ruby client for Elasticsearch](https://github.com/elastic/elasticsearch-ruby), all the methods will be automatically available:
22+
If you use the official [Ruby client for Elasticsearch](https://github.com/elastic/elasticsearch-ruby), require the library in your code, and all the methods will be automatically available in the `xpack` namespace:
2323

2424
```ruby
2525
require 'elasticsearch'
26+
require 'elasticsearch/xpack
2627
2728
client = Elasticsearch::Client.new(url: 'http://elastic:changeme@localhost:9200')
2829

0 commit comments

Comments
 (0)