Skip to content

Commit 2f7b405

Browse files
committed
[DOCS] Updates elasticsearch-api docs
1 parent 66c6ddc commit 2f7b405

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

elasticsearch-api/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**Refer to the [official documentation on Elasticsearch API](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/api.html).**
66

7-
The `elasticsearch-api` library provides a Ruby implementation of the [Elasticsearch](http://elasticsearch.com) REST API. It does not provide an Elasticsearch client; see the [`elastic-transport`](https://github.com/elastic/elastic-transport-ruby/) library.
7+
The `elasticsearch-api` library provides a Ruby implementation of the [Elasticsearch](http://elasticsearch.com) REST API. It does not provide an Elasticsearch client. See [elasticsearch](https://github.com/elastic/elasticsearch-ruby) and the [`elastic-transport`](https://github.com/elastic/elastic-transport-ruby/) libraries for a full Elasticsearch client and HTTP transport layer respectively.
88

99
We follow Ruby’s own maintenance policy and officially support all currently maintained versions per [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/).
1010

@@ -15,17 +15,17 @@ Language clients are forward compatible; meaning that clients support communicat
1515

1616
Refer to [CONTRIBUTING](https://github.com/elastic/elasticsearch-ruby/blob/main/CONTRIBUTING.md).
1717

18-
We run the test suite for Elasticsearch's Rest API tests. You can read more about this in [the test runner README](https://github.com/elastic/elasticsearch-ruby/tree/main/api-spec-testing#rest-api-yaml-test-runner).
18+
The integration tests on this project run the [Elasticsearch Client tests](https://github.com/elastic/elasticsearch-clients-tests/) with the [Elasticsearch Tests Runner](https://github.com/elastic/es-test-runner-ruby/) library. This runs in CI against an Elasticsearch cluster in Docker. You can run a docker container with Elasticsearch with a Rake task from the root directory of this project:
1919

20-
The `rest_api` task needs the test files from Elasticsearch. You can run the rake task to download the test artifacts in the root folder of the project. You can pass in a version to the task as a parameter:
20+
```bash
21+
$ rake es:up
22+
```
2123

22-
`rake download_artifacts[8.5.0-SNAPSHOT]`
24+
This will start whatever version of Elasticsearch is set in the Buildkite pipeline file (`../.buildkite/pipeline.yml`) with security enabled. You can also specify a version and a suite ('free' or 'platinum' for security disabled/enabled):
2325

24-
Or it can get the version from a running cluster to determine which version and build hash of Elasticsearch to use and test against:
25-
26-
`TEST_ES_SERVER=http://localhost:9200 rake es:download_artifacts`
27-
28-
This will download the necessary files used for the integration tests to `./tmp`.
26+
```bash
27+
$ rake es:start[version,suite] # e.g. rake es:start[9.0.0-SNAPSHOT, free]
28+
```
2929

3030
### Code generation
3131

elasticsearch-api/lib/elasticsearch/api.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@
2727
Dir[ File.expand_path('../api/namespace/**/*.rb', __FILE__) ].each { |f| require f }
2828

2929
module Elasticsearch
30+
# This is the main module for including all API endpoint functions
31+
# It includes the namespace modules from ./api/actions
3032
module API
3133
DEFAULT_SERIALIZER = MultiJson
3234

0 commit comments

Comments
 (0)