Skip to content

Commit 9d2158f

Browse files
committed
[DOCS] Adds rake task and updates README for yard
1 parent ed7a419 commit 9d2158f

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ The parameters are:
9393
| `headers` | `Hash` | Custom HTTP Request Headers |
9494
### Using the API
9595

96-
See [APIs](https://github.com/elastic/elasticsearch-serverless-ruby/blob/main/docs/apis.md) for the full list of available endpoints. Check [rubydoc](https://rubydoc.info/gems/elasticsearch-serverless/) for the API reference, or run `yardoc` in the root of the project if you've checked out the code. The API reference documentation will be generated in the `doc` folder.
96+
Check [rubydoc](https://rubydoc.info/gems/elasticsearch-serverless/) for the API reference, or run `yardoc` or `rake doc` in the root directory of the project if you've checked out the code. The API reference documentation will be generated in the `doc` folder.
9797

9898
Once you've instantiated a client with your API key and Elasticsearch endpoint, you can start ingesting documents into Elasticsearch Service. You can use the **Bulk API** for this. This API allows you to index, update and delete several documents in one request. You call the `bulk` API on the client with a body parameter, an Array of hashes that define the action and a document. Here's an example of indexing some classic books into the `books` index:
9999

Rakefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,3 +127,6 @@ task :info do
127127
info = client.info
128128
puts "Connected to Elasticsearch cluster #{info['cluster_name']}"
129129
end
130+
131+
require 'yard'
132+
YARD::Rake::YardocTask.new(:doc)

0 commit comments

Comments
 (0)