elastics-client 1.2.0 → 1.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/VERSION +1 -1
  3. data/elastics-client.gemspec +1 -1
  4. data/lib/elastics/api_stubs.rb +588 -229
  5. data/lib/elastics/class_proxy/templates/doc.rb +6 -5
  6. metadata +3 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 0c02f2ac3c2b9b6bb4e171602857f15e55a5c7e2
4
- data.tar.gz: 3c896bc4ce82299716aead954fbb21d4ce8389e7
3
+ metadata.gz: 3292010647ca4fa25dcf4e8a93a2be9920b4f6e9
4
+ data.tar.gz: a28a7e7cc7fd0f15af1e45dabf0c8d1eafb35f51
5
5
  SHA512:
6
- metadata.gz: b2fbd808a7a9743aac6d5496a3b44ac6d394ec0cfdb492cf12f62f0a128ce19976f521534df3d26a1bb5929c27764777c47b6f60336f2888590cab6114bd9d2c
7
- data.tar.gz: b650f110ca1e64876a538052ec3d8b93c815d2db62a8634a0fd9e82b22231b78243ccc6e7a2e263d141a35e20a426a92f47b2028ed303fd49a958372b05a7d05
6
+ metadata.gz: b44327f3e0b873675ddbf2d6268ef25469e50e45263f90fa25826ead713a4dc25278cdabe127544493180c9bd1b94419f79ecb9e367069922c421cba8b3d4c79
7
+ data.tar.gz: 5db2ef919864d6a91166609592d50b638e67c3aedaab6b68a44bbf7caf914893aaf1672c347c81ce39a252b852740b3fa164a12a37dd0824ca420f06a8e6cd5b
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.2.0
1
+ 1.2.1
data/elastics-client.gemspec CHANGED
@@ -28,7 +28,7 @@ ________________________________________________________________________________
28
28
 
29
29
  New Documentation: http://elastics.github.io/elastics
30
30
 
31
- Upgrading Tutorial: http://elastics.github.io/elastics/doc/7-Tutorials/2-Migrate-from-0.x.html
31
+ Upgrading Tutorial: http://elastics.github.io/elastics/doc/7-tutorials/2-Migrate-from-0.x.html
32
32
 
33
33
  ________________________________________________________________________________
34
34
  EOM
data/lib/elastics/api_stubs.rb CHANGED
@@ -5,8 +5,12 @@ module Elastics
5
5
  # Notice: :index and :type variables are always shown as nil (default), although they may be required by elasticsearch
6
6
 
7
7
  # ########## Elastics.store ##########
8
- # ------------------
9
- # Elastics::Template
8
+ #
9
+ # API Name: Index API
10
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html
11
+ #
12
+ # -----------------------
13
+ # Elastics::Template::Api
10
14
  # ---
11
15
  # store:
12
16
  # - PUT
@@ -18,6 +22,8 @@ module Elastics
18
22
  # :type => nil,
19
23
  # :index => nil
20
24
  #
25
+ # Notice: You must pass the :data variable.
26
+ #
21
27
  def self.store(*vars)
22
28
  ## this is a stub, used for reference
23
29
  super
@@ -26,8 +32,12 @@ module Elastics
26
32
 
27
33
 
28
34
  # ########## Elastics.post_store ##########
29
- # ------------------
30
- # Elastics::Template
35
+ #
36
+ # API Name: Index API
37
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html
38
+ #
39
+ # -----------------------
40
+ # Elastics::Template::Api
31
41
  # ---
32
42
  # post_store:
33
43
  # - POST
@@ -38,15 +48,22 @@ module Elastics
38
48
  # Elastics.post_store :index => nil,
39
49
  # :type => nil
40
50
  #
51
+ # Notice: The id is assigned by elasticsearch; you must pass the :data variable.
52
+ #
41
53
  def self.post_store(*vars)
42
54
  ## this is a stub, used for reference
43
55
  super
44
56
  end
57
+ # also aliased by: :put_store
45
58
 
46
59
 
47
60
  # ########## Elastics.get ##########
48
- # ------------------
49
- # Elastics::Template
61
+ #
62
+ # API Name: Get API
63
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
64
+ #
65
+ # -----------------------
66
+ # Elastics::Template::Api
50
67
  # ---
51
68
  # get:
52
69
  # - GET
@@ -65,8 +82,12 @@ module Elastics
65
82
 
66
83
 
67
84
  # ########## Elastics.get_source ##########
68
- # ------------------
69
- # Elastics::Template
85
+ #
86
+ # API Name: Get API
87
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
88
+ #
89
+ # -----------------------
90
+ # Elastics::Template::Api
70
91
  # ---
71
92
  # get_source:
72
93
  # - GET
@@ -85,8 +106,12 @@ module Elastics
85
106
 
86
107
 
87
108
  # ########## Elastics.delete ##########
88
- # ------------------
89
- # Elastics::Template
109
+ #
110
+ # API Name: Delete API
111
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html
112
+ #
113
+ # -----------------------
114
+ # Elastics::Template::Api
90
115
  # ---
91
116
  # delete:
92
117
  # - DELETE
@@ -98,6 +123,8 @@ module Elastics
98
123
  # :type => nil,
99
124
  # :index => nil
100
125
  #
126
+ # Notice: You must pass the :data variable.
127
+ #
101
128
  def self.delete(*vars)
102
129
  ## this is a stub, used for reference
103
130
  super
@@ -106,8 +133,12 @@ module Elastics
106
133
 
107
134
 
108
135
  # ########## Elastics.update ##########
109
- # ------------------
110
- # Elastics::Template
136
+ #
137
+ # API Name: Update API
138
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html
139
+ #
140
+ # -----------------------
141
+ # Elastics::Template::Api
111
142
  # ---
112
143
  # update:
113
144
  # - POST
@@ -119,6 +150,8 @@ module Elastics
119
150
  # :type => nil,
120
151
  # :index => nil
121
152
  #
153
+ # Notice: You must pass script or doc and the other options as the :data variable.
154
+ #
122
155
  def self.update(*vars)
123
156
  ## this is a stub, used for reference
124
157
  super
@@ -126,8 +159,12 @@ module Elastics
126
159
 
127
160
 
128
161
  # ########## Elastics.multi_get_ids ##########
129
- # ------------------
130
- # Elastics::Template
162
+ #
163
+ # API Name: Multi Get API
164
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html
165
+ #
166
+ # -----------------------
167
+ # Elastics::Template::Api
131
168
  # ---
132
169
  # multi_get_ids:
133
170
  # - GET
@@ -140,6 +177,8 @@ module Elastics
140
177
  # :type => nil,
141
178
  # :index => nil
142
179
  #
180
+ # Notice: You must pass the :ids array.
181
+ #
143
182
  def self.multi_get_ids(*vars)
144
183
  ## this is a stub, used for reference
145
184
  super
@@ -148,8 +187,12 @@ module Elastics
148
187
 
149
188
 
150
189
  # ########## Elastics.multi_get_docs ##########
151
- # ------------------
152
- # Elastics::Template
190
+ #
191
+ # API Name: Multi Get API
192
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html
193
+ #
194
+ # -----------------------
195
+ # Elastics::Template::Api
153
196
  # ---
154
197
  # multi_get_docs:
155
198
  # - GET
@@ -162,15 +205,22 @@ module Elastics
162
205
  # :type => nil,
163
206
  # :index => nil
164
207
  #
208
+ # Notice: You must pass the :docs array.
209
+ #
165
210
  def self.multi_get_docs(*vars)
166
211
  ## this is a stub, used for reference
167
212
  super
168
213
  end
214
+ # also aliased by: :multi_get
169
215
 
170
216
 
171
217
  # ########## Elastics.post_bulk_string ##########
172
- # ------------------
173
- # Elastics::Template
218
+ #
219
+ # API Name: Bulk API
220
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
221
+ #
222
+ # -----------------------
223
+ # Elastics::Template::Api
174
224
  # ---
175
225
  # post_bulk_string:
176
226
  # - POST
@@ -181,6 +231,8 @@ module Elastics
181
231
  # Usage:
182
232
  # Elastics.post_bulk_string :bulk_string => bulk_string # required
183
233
  #
234
+ # Notice: You must pass the :docs array.
235
+ #
184
236
  def self.post_bulk_string(*vars)
185
237
  ## this is a stub, used for reference
186
238
  super
@@ -190,7 +242,7 @@ module Elastics
190
242
 
191
243
  # ########## Elastics.termvector ##########
192
244
  # ------------------
193
- # Elastics::Template
245
+ # Elastics::Template::API
194
246
  # ---
195
247
  # termvector:
196
248
  # - POST
@@ -209,8 +261,12 @@ module Elastics
209
261
 
210
262
 
211
263
  # ########## Elastics.multi_termvectors ##########
212
- # ------------------
213
- # Elastics::Template
264
+ #
265
+ # API Name: Multi Termvectors API
266
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-termvectors.html
267
+ #
268
+ # -----------------------
269
+ # Elastics::Template::Api
214
270
  # ---
215
271
  # multi_termvectors:
216
272
  # - POST
@@ -223,6 +279,8 @@ module Elastics
223
279
  # :type => nil,
224
280
  # :docs => nil
225
281
  #
282
+ # Notice: You must pass the docs array as the :docs variable or use the :data variable for the simplified request.
283
+ #
226
284
  def self.multi_termvectors(*vars)
227
285
  ## this is a stub, used for reference
228
286
  super
@@ -230,8 +288,12 @@ module Elastics
230
288
 
231
289
 
232
290
  # ########## Elastics.search_shards ##########
233
- # ------------------
234
- # Elastics::Template
291
+ #
292
+ # API Name: Search Shards
293
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-shards.html
294
+ #
295
+ # -----------------------
296
+ # Elastics::Template::Api
235
297
  # ---
236
298
  # search_shards:
237
299
  # - GET
@@ -242,6 +304,8 @@ module Elastics
242
304
  # Elastics.search_shards :index => nil,
243
305
  # :type => nil
244
306
  #
307
+ # Notice: You can pass the parameters as the :params variable.
308
+ #
245
309
  def self.search_shards(*vars)
246
310
  ## this is a stub, used for reference
247
311
  super
@@ -249,8 +313,12 @@ module Elastics
249
313
 
250
314
 
251
315
  # ########## Elastics.count ##########
252
- # ------------------
253
- # Elastics::Template
316
+ #
317
+ # API Name: Search Shards
318
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html
319
+ #
320
+ # -----------------------
321
+ # Elastics::Template::Api
254
322
  # ---
255
323
  # count:
256
324
  # - GET
@@ -261,6 +329,8 @@ module Elastics
261
329
  # Elastics.count :index => nil,
262
330
  # :type => nil
263
331
  #
332
+ # Notice: You must pass the query to validate as the :data variable. You can pass the parameters as the :params variable.
333
+ #
264
334
  def self.count(*vars)
265
335
  ## this is a stub, used for reference
266
336
  super
@@ -268,8 +338,12 @@ module Elastics
268
338
 
269
339
 
270
340
  # ########## Elastics.search_exists ##########
271
- # ------------------
272
- # Elastics::Template
341
+ #
342
+ # API Name: Search Exists
343
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-exists.html
344
+ #
345
+ # -----------------------
346
+ # Elastics::Template::Api
273
347
  # ---
274
348
  # search_exists:
275
349
  # - GET
@@ -281,6 +355,8 @@ module Elastics
281
355
  # :type => nil,
282
356
  # :id => nil
283
357
  #
358
+ # Notice: You must pass the query to validate as the :data variable. You can pass the parameters as the :params variable.
359
+ #
284
360
  def self.search_exists(*vars)
285
361
  ## this is a stub, used for reference
286
362
  super
@@ -288,8 +364,12 @@ module Elastics
288
364
 
289
365
 
290
366
  # ########## Elastics.validate ##########
291
- # ------------------
292
- # Elastics::Template
367
+ #
368
+ # API Name: Validate
369
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-validate.html
370
+ #
371
+ # -----------------------
372
+ # Elastics::Template::Api
293
373
  # ---
294
374
  # validate:
295
375
  # - GET
@@ -301,6 +381,8 @@ module Elastics
301
381
  # :type => nil,
302
382
  # :id => nil
303
383
  #
384
+ # Notice: You must pass the query to validate as the :data variable. You can pass the parameters as the :params variable.
385
+ #
304
386
  def self.validate(*vars)
305
387
  ## this is a stub, used for reference
306
388
  super
@@ -308,8 +390,12 @@ module Elastics
308
390
 
309
391
 
310
392
  # ########## Elastics.explain ##########
311
- # ------------------
312
- # Elastics::Template
393
+ #
394
+ # API Name: Validate
395
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-explain.html
396
+ #
397
+ # -----------------------
398
+ # Elastics::Template::Api
313
399
  # ---
314
400
  # explain:
315
401
  # - GET
@@ -321,15 +407,44 @@ module Elastics
321
407
  # :type => nil,
322
408
  # :id => nil
323
409
  #
410
+ # Notice: You must pass the query to explain as the :data variable. You can pass the parameters as the :params variable.
411
+ #
324
412
  def self.explain(*vars)
325
413
  ## this is a stub, used for reference
326
414
  super
327
415
  end
328
416
 
329
417
 
418
+ # ########## Elastics.delete_percolator ##########
419
+ #
420
+ # API Name: Percolator
421
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-percolate.html
422
+ #
423
+ # -----------------------
424
+ # Elastics::Template::Api
425
+ # ---
426
+ # delete_percolator:
427
+ # - DELETE
428
+ # - "/<<index>>/.percolator/<<id>>"
429
+ #
430
+ #
431
+ # Usage:
432
+ # Elastics.delete_percolator :id => id, # required
433
+ # :index => nil
434
+ #
435
+ def self.delete_percolator(*vars)
436
+ ## this is a stub, used for reference
437
+ super
438
+ end
439
+
440
+
330
441
  # ########## Elastics.percolate ##########
331
- # ------------------
332
- # Elastics::Template
442
+ #
443
+ # API Name: Percolator
444
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-percolate.html
445
+ #
446
+ # -----------------------
447
+ # Elastics::Template::Api
333
448
  # ---
334
449
  # percolate:
335
450
  # - GET
@@ -340,6 +455,8 @@ module Elastics
340
455
  # Elastics.percolate :index => nil,
341
456
  # :type => nil
342
457
  #
458
+ # Notice: You must pass the the document (and additional queries) as :data variable.
459
+ #
343
460
  def self.percolate(*vars)
344
461
  ## this is a stub, used for reference
345
462
  super
@@ -347,8 +464,12 @@ module Elastics
347
464
 
348
465
 
349
466
  # ########## Elastics.percolate_count ##########
350
- # ------------------
351
- # Elastics::Template
467
+ #
468
+ # API Name: Percolator
469
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-percolate.html
470
+ #
471
+ # -----------------------
472
+ # Elastics::Template::Api
352
473
  # ---
353
474
  # percolate_count:
354
475
  # - GET
@@ -359,6 +480,8 @@ module Elastics
359
480
  # Elastics.percolate_count :index => nil,
360
481
  # :type => nil
361
482
  #
483
+ # Notice: You must pass the the document (and additional queries) as :data variable.
484
+ #
362
485
  def self.percolate_count(*vars)
363
486
  ## this is a stub, used for reference
364
487
  super
@@ -366,8 +489,12 @@ module Elastics
366
489
 
367
490
 
368
491
  # ########## Elastics.put_percolator ##########
369
- # ------------------
370
- # Elastics::Template
492
+ #
493
+ # API Name: Percolator
494
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-percolate.html
495
+ #
496
+ # -----------------------
497
+ # Elastics::Template::Api
371
498
  # ---
372
499
  # put_percolator:
373
500
  # - PUT
@@ -378,34 +505,21 @@ module Elastics
378
505
  # Elastics.put_percolator :id => id, # required
379
506
  # :index => nil
380
507
  #
508
+ # Notice: You must pass the the document (and additional queries) as :data variable.
509
+ #
381
510
  def self.put_percolator(*vars)
382
511
  ## this is a stub, used for reference
383
512
  super
384
513
  end
385
514
 
386
515
 
387
- # ########## Elastics.delete_percolator ##########
388
- # ------------------
389
- # Elastics::Template
390
- # ---
391
- # delete_percolator:
392
- # - DELETE
393
- # - "/<<index>>/.percolator/<<id>>"
394
- #
516
+ # ########## Elastics.more_like_this ##########
395
517
  #
396
- # Usage:
397
- # Elastics.delete_percolator :id => id, # required
398
- # :index => nil
518
+ # API Name: More Like This
519
+ # API URL: http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-more-like-this.html
399
520
  #
400
- def self.delete_percolator(*vars)
401
- ## this is a stub, used for reference
402
- super
403
- end
404
-
405
-
406
- # ########## Elastics.more_like_this ##########
407
- # ------------------
408
- # Elastics::Template
521
+ # -----------------------
522
+ # Elastics::Template::Api
409
523
  # ---
410
524
  # more_like_this:
411
525
  # - GET
@@ -417,6 +531,8 @@ module Elastics
417
531
  # :type => nil,
418
532
  # :index => nil
419
533
  #
534
+ # Notice: You can pass the search API as :data variable.
535
+ #
420
536
  def self.more_like_this(*vars)
421
537
  ## this is a stub, used for reference
422
538
  super
@@ -425,8 +541,12 @@ module Elastics
425
541
 
426
542
 
427
543
  # ########## Elastics.put_index ##########
428
- # ------------------
429
- # Elastics::Template
544
+ #
545
+ # API Name: Create Index
546
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html
547
+ #
548
+ # -----------------------
549
+ # Elastics::Template::Api
430
550
  # ---
431
551
  # put_index:
432
552
  # - PUT
@@ -441,6 +561,8 @@ module Elastics
441
561
  # :number_of_shards => 5,
442
562
  # :number_of_replicas => 1
443
563
  #
564
+ # Notice: You can also pass the complete data structure as :data variable, so passing settings, mappings, warmers, aliases, ...
565
+ #
444
566
  def self.put_index(*vars)
445
567
  ## this is a stub, used for reference
446
568
  super
@@ -449,8 +571,12 @@ module Elastics
449
571
 
450
572
 
451
573
  # ########## Elastics.post_index ##########
452
- # ------------------
453
- # Elastics::Template
574
+ #
575
+ # API Name: Create Index
576
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html
577
+ #
578
+ # -----------------------
579
+ # Elastics::Template::Api
454
580
  # ---
455
581
  # post_index:
456
582
  # - POST
@@ -465,15 +591,22 @@ module Elastics
465
591
  # :number_of_shards => 5,
466
592
  # :number_of_replicas => 1
467
593
  #
594
+ # Notice: You can also pass the complete data structure as :data variable, so passing settings, mappings, warmers, aliases, ...
595
+ #
468
596
  def self.post_index(*vars)
469
597
  ## this is a stub, used for reference
470
598
  super
471
599
  end
600
+ # also aliased by: :create_index
472
601
 
473
602
 
474
603
  # ########## Elastics.delete_index ##########
475
- # ------------------
476
- # Elastics::Template
604
+ #
605
+ # API Name: Delete Index
606
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-index.html
607
+ #
608
+ # -----------------------
609
+ # Elastics::Template::Api
477
610
  # ---
478
611
  # delete_index:
479
612
  # - DELETE
@@ -490,8 +623,12 @@ module Elastics
490
623
 
491
624
 
492
625
  # ########## Elastics.get_index ##########
493
- # ------------------
494
- # Elastics::Template
626
+ #
627
+ # API Name: Get Index
628
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html
629
+ #
630
+ # -----------------------
631
+ # Elastics::Template::Api
495
632
  # ---
496
633
  # get_index:
497
634
  # - GET
@@ -509,8 +646,12 @@ module Elastics
509
646
 
510
647
 
511
648
  # ########## Elastics.indices_exists ##########
512
- # ------------------
513
- # Elastics::Template
649
+ #
650
+ # API Name: Indices Exists
651
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-exists.html
652
+ #
653
+ # -----------------------
654
+ # Elastics::Template::Api
514
655
  # ---
515
656
  # indices_exists:
516
657
  # - HEAD
@@ -528,8 +669,12 @@ module Elastics
528
669
 
529
670
 
530
671
  # ########## Elastics.close_index ##########
531
- # ------------------
532
- # Elastics::Template
672
+ #
673
+ # API Name: Open/Close Index
674
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html
675
+ #
676
+ # -----------------------
677
+ # Elastics::Template::Api
533
678
  # ---
534
679
  # close_index:
535
680
  # - POST
@@ -546,8 +691,12 @@ module Elastics
546
691
 
547
692
 
548
693
  # ########## Elastics.open_index ##########
549
- # ------------------
550
- # Elastics::Template
694
+ #
695
+ # API Name: Open/Close Index
696
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html
697
+ #
698
+ # -----------------------
699
+ # Elastics::Template::Api
551
700
  # ---
552
701
  # open_index:
553
702
  # - POST
@@ -564,8 +713,12 @@ module Elastics
564
713
 
565
714
 
566
715
  # ########## Elastics.put_index_mapping ##########
567
- # ------------------
568
- # Elastics::Template
716
+ #
717
+ # API Name: Put Mappings
718
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-mapping.html
719
+ #
720
+ # -----------------------
721
+ # Elastics::Template::Api
569
722
  # ---
570
723
  # put_index_mapping:
571
724
  # - PUT
@@ -583,12 +736,16 @@ module Elastics
583
736
  ## this is a stub, used for reference
584
737
  super
585
738
  end
586
- # also aliased by: :put_mapping
739
+ # also aliased by: :put_mappings
587
740
 
588
741
 
589
742
  # ########## Elastics.get_index_mapping ##########
590
- # ------------------
591
- # Elastics::Template
743
+ #
744
+ # API Name: Get Mappings
745
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-mapping.html
746
+ #
747
+ # -----------------------
748
+ # Elastics::Template::Api
592
749
  # ---
593
750
  # get_index_mapping:
594
751
  # - GET
@@ -606,8 +763,12 @@ module Elastics
606
763
 
607
764
 
608
765
  # ########## Elastics.get_field_mapping ##########
609
- # ------------------
610
- # Elastics::Template
766
+ #
767
+ # API Name: Get Field Mappings
768
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html
769
+ #
770
+ # -----------------------
771
+ # Elastics::Template::Api
611
772
  # ---
612
773
  # get_field_mapping:
613
774
  # - GET
@@ -626,8 +787,12 @@ module Elastics
626
787
 
627
788
 
628
789
  # ########## Elastics.types_exists ##########
629
- # ------------------
630
- # Elastics::Template
790
+ #
791
+ # API Name: Types Exists
792
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-types-exists.html
793
+ #
794
+ # -----------------------
795
+ # Elastics::Template::Api
631
796
  # ---
632
797
  # types_exists:
633
798
  # - HEAD
@@ -646,8 +811,12 @@ module Elastics
646
811
 
647
812
 
648
813
  # ########## Elastics.delete_index_mapping ##########
649
- # ------------------
650
- # Elastics::Template
814
+ #
815
+ # API Name: Delete Mappings
816
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-mapping.html
817
+ #
818
+ # -----------------------
819
+ # Elastics::Template::Api
651
820
  # ---
652
821
  # delete_index_mapping:
653
822
  # - DELETE
@@ -664,28 +833,13 @@ module Elastics
664
833
  end
665
834
 
666
835
 
667
- # ########## Elastics.post_index_aliases ##########
668
- # ------------------
669
- # Elastics::Template
670
- # ---
671
- # post_index_aliases:
672
- # - POST
673
- # - "/_aliases"
674
- # - actions: "<<actions>>"
836
+ # ########## Elastics.get_index_aliases ##########
675
837
  #
838
+ # API Name: Index Aliases
839
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
676
840
  #
677
- # Usage:
678
- # Elastics.post_index_aliases :actions => actions # required
679
- #
680
- def self.post_index_aliases(*vars)
681
- ## this is a stub, used for reference
682
- super
683
- end
684
-
685
-
686
- # ########## Elastics.get_index_aliases ##########
687
- # ------------------
688
- # Elastics::Template
841
+ # -----------------------
842
+ # Elastics::Template::Api
689
843
  # ---
690
844
  # get_index_aliases:
691
845
  # - GET
@@ -701,28 +855,38 @@ module Elastics
701
855
  end
702
856
 
703
857
 
704
- # ########## Elastics.put_index_alias ##########
705
- # ------------------
706
- # Elastics::Template
858
+ # ########## Elastics.post_index_aliases ##########
859
+ #
860
+ # API Name: Index Aliases
861
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
862
+ #
863
+ # -----------------------
864
+ # Elastics::Template::Api
707
865
  # ---
708
- # put_index_alias:
709
- # - PUT
710
- # - "/<<index>>/_alias/<<alias>>"
866
+ # post_index_aliases:
867
+ # - POST
868
+ # - "/_aliases"
869
+ # - actions: "<<actions>>"
711
870
  #
712
871
  #
713
872
  # Usage:
714
- # Elastics.put_index_alias :alias => alias, # required
715
- # :index => nil
873
+ # Elastics.post_index_aliases :actions => actions # required
716
874
  #
717
- def self.put_index_alias(*vars)
875
+ # Notice: This is the generic interface allowing all the options. You can pass the :actions array or the aliases API structure as the :data variable.
876
+ #
877
+ def self.post_index_aliases(*vars)
718
878
  ## this is a stub, used for reference
719
879
  super
720
880
  end
721
881
 
722
882
 
723
883
  # ########## Elastics.delete_index_alias ##########
724
- # ------------------
725
- # Elastics::Template
884
+ #
885
+ # API Name: Index Aliases
886
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
887
+ #
888
+ # -----------------------
889
+ # Elastics::Template::Api
726
890
  # ---
727
891
  # delete_index_alias:
728
892
  # - DELETE
@@ -740,8 +904,12 @@ module Elastics
740
904
 
741
905
 
742
906
  # ########## Elastics.get_index_alias ##########
743
- # ------------------
744
- # Elastics::Template
907
+ #
908
+ # API Name: Index Aliases
909
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
910
+ #
911
+ # -----------------------
912
+ # Elastics::Template::Api
745
913
  # ---
746
914
  # get_index_alias:
747
915
  # - GET
@@ -758,64 +926,86 @@ module Elastics
758
926
  end
759
927
 
760
928
 
761
- # ########## Elastics.update_index_settings ##########
762
- # ------------------
763
- # Elastics::Template
929
+ # ########## Elastics.put_index_alias ##########
930
+ #
931
+ # API Name: Index Aliases
932
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
933
+ #
934
+ # -----------------------
935
+ # Elastics::Template::Api
764
936
  # ---
765
- # update_index_settings:
937
+ # put_index_alias:
766
938
  # - PUT
767
- # - "/<<index>>/_settings"
939
+ # - "/<<index>>/_alias/<<alias>>"
768
940
  #
769
941
  #
770
942
  # Usage:
771
- # Elastics.update_index_settings :index => nil
943
+ # Elastics.put_index_alias :alias => alias, # required
944
+ # :index => nil
772
945
  #
773
- def self.update_index_settings(*vars)
946
+ # Notice: This is the single index alias. You can pass other options as the :data variable.
947
+ #
948
+ def self.put_index_alias(*vars)
774
949
  ## this is a stub, used for reference
775
950
  super
776
951
  end
777
- # also aliased by: :put_index_settings
778
952
 
779
953
 
780
- # ########## Elastics.get_index_settings ##########
781
- # ------------------
782
- # Elastics::Template
954
+ # ########## Elastics.update_index_settings ##########
955
+ #
956
+ # API Name: Update Indices Settings
957
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html
958
+ #
959
+ # -----------------------
960
+ # Elastics::Template::Api
783
961
  # ---
784
- # get_index_settings:
785
- # - GET
962
+ # update_index_settings:
963
+ # - PUT
786
964
  # - "/<<index>>/_settings"
787
965
  #
788
966
  #
789
967
  # Usage:
790
- # Elastics.get_index_settings :index => nil
968
+ # Elastics.update_index_settings :index => nil
791
969
  #
792
- def self.get_index_settings(*vars)
970
+ # Notice: You can pass the settings structure as the :data variable.
971
+ #
972
+ def self.update_index_settings(*vars)
793
973
  ## this is a stub, used for reference
794
974
  super
795
975
  end
976
+ # also aliased by: :put_index_settings
796
977
 
797
978
 
798
- # ########## Elastics.get_settings ##########
799
- # ------------------
800
- # Elastics::Template
979
+ # ########## Elastics.get_index_settings ##########
980
+ #
981
+ # API Name: Get Indices Settings
982
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-settings.html
983
+ #
984
+ # -----------------------
985
+ # Elastics::Template::Api
801
986
  # ---
802
- # get_settings:
987
+ # get_index_settings:
803
988
  # - GET
804
989
  # - "/<<index>>/_settings"
805
990
  #
806
991
  #
807
992
  # Usage:
808
- # Elastics.get_settings :index => nil
993
+ # Elastics.get_index_settings :index => nil
809
994
  #
810
- def self.get_settings(*vars)
995
+ def self.get_index_settings(*vars)
811
996
  ## this is a stub, used for reference
812
997
  super
813
998
  end
999
+ # also aliased by: :get_settings
814
1000
 
815
1001
 
816
1002
  # ########## Elastics.analyze_index ##########
817
- # ------------------
818
- # Elastics::Template
1003
+ #
1004
+ # API Name: Analyze
1005
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html
1006
+ #
1007
+ # -----------------------
1008
+ # Elastics::Template::Api
819
1009
  # ---
820
1010
  # analyze_index:
821
1011
  # - GET
@@ -825,33 +1015,21 @@ module Elastics
825
1015
  # Usage:
826
1016
  # Elastics.analyze_index :index => nil
827
1017
  #
1018
+ # Notice: You can pass the text to analyze as the :data variable (or the param :text). You can pass the parameters as the :params variable.
1019
+ #
828
1020
  def self.analyze_index(*vars)
829
1021
  ## this is a stub, used for reference
830
1022
  super
831
1023
  end
832
1024
 
833
1025
 
834
- # ########## Elastics.put_index_template ##########
835
- # ------------------
836
- # Elastics::Template
837
- # ---
838
- # put_index_template:
839
- # - PUT
840
- # - "/_template/<<template>>"
841
- #
1026
+ # ########## Elastics.delete_index_template ##########
842
1027
  #
843
- # Usage:
844
- # Elastics.put_index_template :template => template # required
1028
+ # API Name: Index Templates
1029
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html
845
1030
  #
846
- def self.put_index_template(*vars)
847
- ## this is a stub, used for reference
848
- super
849
- end
850
-
851
-
852
- # ########## Elastics.delete_index_template ##########
853
- # ------------------
854
- # Elastics::Template
1031
+ # -----------------------
1032
+ # Elastics::Template::Api
855
1033
  # ---
856
1034
  # delete_index_template:
857
1035
  # - DELETE
@@ -868,8 +1046,12 @@ module Elastics
868
1046
 
869
1047
 
870
1048
  # ########## Elastics.get_index_template ##########
871
- # ------------------
872
- # Elastics::Template
1049
+ #
1050
+ # API Name: Index Templates
1051
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html
1052
+ #
1053
+ # -----------------------
1054
+ # Elastics::Template::Api
873
1055
  # ---
874
1056
  # get_index_template:
875
1057
  # - GET
@@ -886,8 +1068,12 @@ module Elastics
886
1068
 
887
1069
 
888
1070
  # ########## Elastics.index_template_exists ##########
889
- # ------------------
890
- # Elastics::Template
1071
+ #
1072
+ # API Name: Index Templates
1073
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html
1074
+ #
1075
+ # -----------------------
1076
+ # Elastics::Template::Api
891
1077
  # ---
892
1078
  # index_template_exists:
893
1079
  # - HEAD
@@ -903,29 +1089,37 @@ module Elastics
903
1089
  end
904
1090
 
905
1091
 
906
- # ########## Elastics.put_index_warmer ##########
907
- # ------------------
908
- # Elastics::Template
1092
+ # ########## Elastics.put_index_template ##########
1093
+ #
1094
+ # API Name: Index Templates
1095
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html
1096
+ #
1097
+ # -----------------------
1098
+ # Elastics::Template::Api
909
1099
  # ---
910
- # put_index_warmer:
1100
+ # put_index_template:
911
1101
  # - PUT
912
- # - "/<<index>>/<<type>>/_warmer/<<warmer>>"
1102
+ # - "/_template/<<template>>"
913
1103
  #
914
1104
  #
915
1105
  # Usage:
916
- # Elastics.put_index_warmer :warmer => warmer, # required
917
- # :type => nil,
918
- # :index => nil
1106
+ # Elastics.put_index_template :template => template # required
919
1107
  #
920
- def self.put_index_warmer(*vars)
1108
+ # Notice: You must pass the template structure as the :data variable.
1109
+ #
1110
+ def self.put_index_template(*vars)
921
1111
  ## this is a stub, used for reference
922
1112
  super
923
1113
  end
924
1114
 
925
1115
 
926
1116
  # ########## Elastics.delete_index_warmer ##########
927
- # ------------------
928
- # Elastics::Template
1117
+ #
1118
+ # API Name: Warmers
1119
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-warmers.html
1120
+ #
1121
+ # -----------------------
1122
+ # Elastics::Template::Api
929
1123
  # ---
930
1124
  # delete_index_warmer:
931
1125
  # - DELETE
@@ -942,9 +1136,39 @@ module Elastics
942
1136
  end
943
1137
 
944
1138
 
1139
+ # ########## Elastics.put_index_warmer ##########
1140
+ #
1141
+ # API Name: Warmers
1142
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-warmers.html
1143
+ #
1144
+ # -----------------------
1145
+ # Elastics::Template::Api
1146
+ # ---
1147
+ # put_index_warmer:
1148
+ # - PUT
1149
+ # - "/<<index>>/<<type>>/_warmer/<<warmer>>"
1150
+ #
1151
+ #
1152
+ # Usage:
1153
+ # Elastics.put_index_warmer :warmer => warmer, # required
1154
+ # :type => nil,
1155
+ # :index => nil
1156
+ #
1157
+ # Notice: You must pass the warmer structure as the :data variable.
1158
+ #
1159
+ def self.put_index_warmer(*vars)
1160
+ ## this is a stub, used for reference
1161
+ super
1162
+ end
1163
+
1164
+
945
1165
  # ########## Elastics.get_index_warmer ##########
946
- # ------------------
947
- # Elastics::Template
1166
+ #
1167
+ # API Name: Warmers
1168
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-warmers.html
1169
+ #
1170
+ # -----------------------
1171
+ # Elastics::Template::Api
948
1172
  # ---
949
1173
  # get_index_warmer:
950
1174
  # - GET
@@ -962,8 +1186,12 @@ module Elastics
962
1186
 
963
1187
 
964
1188
  # ########## Elastics.index_status ##########
965
- # ------------------
966
- # Elastics::Template
1189
+ #
1190
+ # API Name: Status
1191
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-status.html
1192
+ #
1193
+ # -----------------------
1194
+ # Elastics::Template::Api
967
1195
  # ---
968
1196
  # index_status:
969
1197
  # - GET
@@ -980,8 +1208,12 @@ module Elastics
980
1208
 
981
1209
 
982
1210
  # ########## Elastics.index_stats ##########
983
- # ------------------
984
- # Elastics::Template
1211
+ #
1212
+ # API Name: Stats
1213
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-stats.html
1214
+ #
1215
+ # -----------------------
1216
+ # Elastics::Template::Api
985
1217
  # ---
986
1218
  # index_stats:
987
1219
  # - GET
@@ -999,8 +1231,12 @@ module Elastics
999
1231
 
1000
1232
 
1001
1233
  # ########## Elastics.index_segments ##########
1002
- # ------------------
1003
- # Elastics::Template
1234
+ #
1235
+ # API Name: Segments
1236
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-segments.html
1237
+ #
1238
+ # -----------------------
1239
+ # Elastics::Template::Api
1004
1240
  # ---
1005
1241
  # index_segments:
1006
1242
  # - GET
@@ -1017,8 +1253,12 @@ module Elastics
1017
1253
 
1018
1254
 
1019
1255
  # ########## Elastics.index_recovery ##########
1020
- # ------------------
1021
- # Elastics::Template
1256
+ #
1257
+ # API Name: Recovery
1258
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-recovery.html
1259
+ #
1260
+ # -----------------------
1261
+ # Elastics::Template::Api
1022
1262
  # ---
1023
1263
  # index_recovery:
1024
1264
  # - GET
@@ -1035,8 +1275,12 @@ module Elastics
1035
1275
 
1036
1276
 
1037
1277
  # ########## Elastics.index_clearcache ##########
1038
- # ------------------
1039
- # Elastics::Template
1278
+ #
1279
+ # API Name: Recovery
1280
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-clearcache.html
1281
+ #
1282
+ # -----------------------
1283
+ # Elastics::Template::Api
1040
1284
  # ---
1041
1285
  # index_clearcache:
1042
1286
  # - POST
@@ -1053,8 +1297,12 @@ module Elastics
1053
1297
 
1054
1298
 
1055
1299
  # ########## Elastics.flush_index ##########
1056
- # ------------------
1057
- # Elastics::Template
1300
+ #
1301
+ # API Name: Flush
1302
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-flush.html
1303
+ #
1304
+ # -----------------------
1305
+ # Elastics::Template::Api
1058
1306
  # ---
1059
1307
  # flush_index:
1060
1308
  # - POST
@@ -1064,6 +1312,8 @@ module Elastics
1064
1312
  # Usage:
1065
1313
  # Elastics.flush_index :index => nil
1066
1314
  #
1315
+ # Notice: You can pass the parameters as the :params variable.
1316
+ #
1067
1317
  def self.flush_index(*vars)
1068
1318
  ## this is a stub, used for reference
1069
1319
  super
@@ -1071,8 +1321,12 @@ module Elastics
1071
1321
 
1072
1322
 
1073
1323
  # ########## Elastics.synced_flush_index ##########
1074
- # ------------------
1075
- # Elastics::Template
1324
+ #
1325
+ # API Name: Synced Flush
1326
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-synced-flush.html
1327
+ #
1328
+ # -----------------------
1329
+ # Elastics::Template::Api
1076
1330
  # ---
1077
1331
  # synced_flush_index:
1078
1332
  # - POST
@@ -1082,6 +1336,8 @@ module Elastics
1082
1336
  # Usage:
1083
1337
  # Elastics.synced_flush_index :index => nil
1084
1338
  #
1339
+ # Notice: You can pass the parameters as the :params variable.
1340
+ #
1085
1341
  def self.synced_flush_index(*vars)
1086
1342
  ## this is a stub, used for reference
1087
1343
  super
@@ -1089,8 +1345,12 @@ module Elastics
1089
1345
 
1090
1346
 
1091
1347
  # ########## Elastics.refresh_index ##########
1092
- # ------------------
1093
- # Elastics::Template
1348
+ #
1349
+ # API Name: Refresh
1350
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-refresh.html
1351
+ #
1352
+ # -----------------------
1353
+ # Elastics::Template::Api
1094
1354
  # ---
1095
1355
  # refresh_index:
1096
1356
  # - POST
@@ -1107,8 +1367,12 @@ module Elastics
1107
1367
 
1108
1368
 
1109
1369
  # ########## Elastics.optimize_index ##########
1110
- # ------------------
1111
- # Elastics::Template
1370
+ #
1371
+ # API Name: Optimize
1372
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-optimize.html
1373
+ #
1374
+ # -----------------------
1375
+ # Elastics::Template::Api
1112
1376
  # ---
1113
1377
  # optimize_index:
1114
1378
  # - POST
@@ -1118,6 +1382,8 @@ module Elastics
1118
1382
  # Usage:
1119
1383
  # Elastics.optimize_index :index => nil
1120
1384
  #
1385
+ # Notice: You can pass the parameters as the :params variable.
1386
+ #
1121
1387
  def self.optimize_index(*vars)
1122
1388
  ## this is a stub, used for reference
1123
1389
  super
@@ -1125,8 +1391,12 @@ module Elastics
1125
1391
 
1126
1392
 
1127
1393
  # ########## Elastics.upgrade_index ##########
1128
- # ------------------
1129
- # Elastics::Template
1394
+ #
1395
+ # API Name: Upgrade
1396
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-upgrade.html
1397
+ #
1398
+ # -----------------------
1399
+ # Elastics::Template::Api
1130
1400
  # ---
1131
1401
  # upgrade_index:
1132
1402
  # - POST
@@ -1136,15 +1406,44 @@ module Elastics
1136
1406
  # Usage:
1137
1407
  # Elastics.upgrade_index :index => nil
1138
1408
  #
1409
+ # Notice: You can pass the parameters as the :params variable.
1410
+ #
1139
1411
  def self.upgrade_index(*vars)
1140
1412
  ## this is a stub, used for reference
1141
1413
  super
1142
1414
  end
1143
1415
 
1144
1416
 
1417
+ # ########## Elastics.cat ##########
1418
+ #
1419
+ # API Name: Cat API
1420
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/cat.html
1421
+ #
1422
+ # -----------------------
1423
+ # Elastics::Template::Api
1424
+ # ---
1425
+ # cat:
1426
+ # - GET
1427
+ # - "/"
1428
+ #
1429
+ #
1430
+ # Usage:
1431
+ # Elastics.cat
1432
+ # Notice: You must pass the :path variable or you can pass it as a simple string argument: Elastics.cat('/path')
1433
+ #
1434
+ def self.cat(*vars)
1435
+ ## this is a stub, used for reference
1436
+ super
1437
+ end
1438
+
1439
+
1145
1440
  # ########## Elastics.cluster_health ##########
1146
- # ------------------
1147
- # Elastics::Template
1441
+ #
1442
+ # API Name: Health
1443
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html
1444
+ #
1445
+ # -----------------------
1446
+ # Elastics::Template::Api
1148
1447
  # ---
1149
1448
  # cluster_health:
1150
1449
  # - GET
@@ -1154,6 +1453,8 @@ module Elastics
1154
1453
  # Usage:
1155
1454
  # Elastics.cluster_health :index => nil
1156
1455
  #
1456
+ # Notice: You can pass the params as the :params variable.
1457
+ #
1157
1458
  def self.cluster_health(*vars)
1158
1459
  ## this is a stub, used for reference
1159
1460
  super
@@ -1161,8 +1462,12 @@ module Elastics
1161
1462
 
1162
1463
 
1163
1464
  # ########## Elastics.cluster_state ##########
1164
- # ------------------
1165
- # Elastics::Template
1465
+ #
1466
+ # API Name: State
1467
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-state.html
1468
+ #
1469
+ # -----------------------
1470
+ # Elastics::Template::Api
1166
1471
  # ---
1167
1472
  # cluster_state:
1168
1473
  # - GET
@@ -1173,6 +1478,8 @@ module Elastics
1173
1478
  # Elastics.cluster_state :metrics => "_all",
1174
1479
  # :index => nil
1175
1480
  #
1481
+ # Notice: You can pass the metrics as the :metrics variable.
1482
+ #
1176
1483
  def self.cluster_state(*vars)
1177
1484
  ## this is a stub, used for reference
1178
1485
  super
@@ -1180,8 +1487,12 @@ module Elastics
1180
1487
 
1181
1488
 
1182
1489
  # ########## Elastics.cluster_stats ##########
1183
- # ------------------
1184
- # Elastics::Template
1490
+ #
1491
+ # API Name: Stats
1492
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-stats.html
1493
+ #
1494
+ # -----------------------
1495
+ # Elastics::Template::Api
1185
1496
  # ---
1186
1497
  # cluster_stats:
1187
1498
  # - GET
@@ -1190,6 +1501,7 @@ module Elastics
1190
1501
  #
1191
1502
  # Usage:
1192
1503
  # Elastics.cluster_stats
1504
+ # Notice: You can pass the params as the :params variable.
1193
1505
  #
1194
1506
  def self.cluster_stats(*vars)
1195
1507
  ## this is a stub, used for reference
@@ -1198,8 +1510,12 @@ module Elastics
1198
1510
 
1199
1511
 
1200
1512
  # ########## Elastics.cluster_pending_tasks ##########
1201
- # ------------------
1202
- # Elastics::Template
1513
+ #
1514
+ # API Name: Pending Cluster Tasks
1515
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-pending.html
1516
+ #
1517
+ # -----------------------
1518
+ # Elastics::Template::Api
1203
1519
  # ---
1204
1520
  # cluster_pending_tasks:
1205
1521
  # - GET
@@ -1208,6 +1524,7 @@ module Elastics
1208
1524
  #
1209
1525
  # Usage:
1210
1526
  # Elastics.cluster_pending_tasks
1527
+ # Notice: You can pass the params as the :params variable.
1211
1528
  #
1212
1529
  def self.cluster_pending_tasks(*vars)
1213
1530
  ## this is a stub, used for reference
@@ -1216,8 +1533,12 @@ module Elastics
1216
1533
 
1217
1534
 
1218
1535
  # ########## Elastics.cluster_reroute ##########
1219
- # ------------------
1220
- # Elastics::Template
1536
+ #
1537
+ # API Name: Cluster Reroute
1538
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-reroute.html
1539
+ #
1540
+ # -----------------------
1541
+ # Elastics::Template::Api
1221
1542
  # ---
1222
1543
  # cluster_reroute:
1223
1544
  # - POST
@@ -1226,6 +1547,7 @@ module Elastics
1226
1547
  #
1227
1548
  # Usage:
1228
1549
  # Elastics.cluster_reroute
1550
+ # Notice: You must pass the data structure as the :data variable.
1229
1551
  #
1230
1552
  def self.cluster_reroute(*vars)
1231
1553
  ## this is a stub, used for reference
@@ -1233,45 +1555,57 @@ module Elastics
1233
1555
  end
1234
1556
 
1235
1557
 
1236
- # ########## Elastics.put_cluster_settings ##########
1237
- # ------------------
1238
- # Elastics::Template
1558
+ # ########## Elastics.get_cluster_settings ##########
1559
+ #
1560
+ # API Name: Cluster Update Settings
1561
+ # API URL: http://www.elasticsearch.org/guide/reference/api/admin-cluster-update-settings
1562
+ #
1563
+ # -----------------------
1564
+ # Elastics::Template::Api
1239
1565
  # ---
1240
- # put_cluster_settings:
1241
- # - PUT
1566
+ # get_cluster_settings:
1567
+ # - GET
1242
1568
  # - "/_cluster/settings"
1243
1569
  #
1244
1570
  #
1245
1571
  # Usage:
1246
- # Elastics.put_cluster_settings
1247
- #
1248
- def self.put_cluster_settings(*vars)
1572
+ # Elastics.get_cluster_settings
1573
+ def self.get_cluster_settings(*vars)
1249
1574
  ## this is a stub, used for reference
1250
1575
  super
1251
1576
  end
1252
1577
 
1253
1578
 
1254
- # ########## Elastics.get_cluster_settings ##########
1255
- # ------------------
1256
- # Elastics::Template
1579
+ # ########## Elastics.put_cluster_settings ##########
1580
+ #
1581
+ # API Name: Cluster Update Settings
1582
+ # API URL: http://www.elasticsearch.org/guide/reference/api/admin-cluster-update-settings
1583
+ #
1584
+ # -----------------------
1585
+ # Elastics::Template::Api
1257
1586
  # ---
1258
- # get_cluster_settings:
1259
- # - GET
1587
+ # put_cluster_settings:
1588
+ # - PUT
1260
1589
  # - "/_cluster/settings"
1261
1590
  #
1262
1591
  #
1263
1592
  # Usage:
1264
- # Elastics.get_cluster_settings
1593
+ # Elastics.put_cluster_settings
1594
+ # Notice: You must pass the data structure as the :data variable.
1265
1595
  #
1266
- def self.get_cluster_settings(*vars)
1596
+ def self.put_cluster_settings(*vars)
1267
1597
  ## this is a stub, used for reference
1268
1598
  super
1269
1599
  end
1270
1600
 
1271
1601
 
1272
1602
  # ########## Elastics.cluster_nodes_stats ##########
1273
- # ------------------
1274
- # Elastics::Template
1603
+ #
1604
+ # API Name: Nodes Stats
1605
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html
1606
+ #
1607
+ # -----------------------
1608
+ # Elastics::Template::Api
1275
1609
  # ---
1276
1610
  # cluster_nodes_stats:
1277
1611
  # - GET
@@ -1282,6 +1616,8 @@ module Elastics
1282
1616
  # Elastics.cluster_nodes_stats :nodes => nil,
1283
1617
  # :stats => nil
1284
1618
  #
1619
+ # Notice: You can pass the params as the :params variable. You must pass the data structure as the :data variable.
1620
+ #
1285
1621
  def self.cluster_nodes_stats(*vars)
1286
1622
  ## this is a stub, used for reference
1287
1623
  super
@@ -1289,8 +1625,12 @@ module Elastics
1289
1625
 
1290
1626
 
1291
1627
  # ########## Elastics.cluster_nodes_info ##########
1292
- # ------------------
1293
- # Elastics::Template
1628
+ #
1629
+ # API Name: Nodes Info
1630
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html
1631
+ #
1632
+ # -----------------------
1633
+ # Elastics::Template::Api
1294
1634
  # ---
1295
1635
  # cluster_nodes_info:
1296
1636
  # - GET
@@ -1301,6 +1641,8 @@ module Elastics
1301
1641
  # Elastics.cluster_nodes_info :nodes => nil,
1302
1642
  # :info => nil
1303
1643
  #
1644
+ # Notice: This template uses the _nodes shortcut.
1645
+ #
1304
1646
  def self.cluster_nodes_info(*vars)
1305
1647
  ## this is a stub, used for reference
1306
1648
  super
@@ -1308,8 +1650,12 @@ module Elastics
1308
1650
 
1309
1651
 
1310
1652
  # ########## Elastics.cluster_nodes_hot_threads ##########
1311
- # ------------------
1312
- # Elastics::Template
1653
+ #
1654
+ # API Name: Nodes Hot Threads
1655
+ # API URL: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html
1656
+ #
1657
+ # -----------------------
1658
+ # Elastics::Template::Api
1313
1659
  # ---
1314
1660
  # cluster_nodes_hot_threads:
1315
1661
  # - GET
@@ -1326,8 +1672,12 @@ module Elastics
1326
1672
 
1327
1673
 
1328
1674
  # ########## Elastics.match_all ##########
1329
- # ------------------
1330
- # Elastics::Template
1675
+ #
1676
+ # API Name:
1677
+ # API URL:
1678
+ #
1679
+ # -----------------------
1680
+ # Elastics::Template::Api
1331
1681
  # ---
1332
1682
  # match_all:
1333
1683
  # - GET
@@ -1340,6 +1690,8 @@ module Elastics
1340
1690
  # Elastics.match_all :index => nil,
1341
1691
  # :type => nil
1342
1692
  #
1693
+ # Notice: Not a real API method, but handy.
1694
+ #
1343
1695
  def self.match_all(*vars)
1344
1696
  ## this is a stub, used for reference
1345
1697
  super
@@ -1347,8 +1699,12 @@ module Elastics
1347
1699
 
1348
1700
 
1349
1701
  # ########## Elastics.search_by_id ##########
1350
- # ------------------
1351
- # Elastics::Template
1702
+ #
1703
+ # API Name:
1704
+ # API URL:
1705
+ #
1706
+ # -----------------------
1707
+ # Elastics::Template::Api
1352
1708
  # ---
1353
1709
  # search_by_id:
1354
1710
  # - GET
@@ -1363,9 +1719,12 @@ module Elastics
1363
1719
  # :type => nil,
1364
1720
  # :index => nil
1365
1721
  #
1722
+ # Notice: Get a document without using the get API and without raising any error if it is missing.
1723
+ #
1366
1724
  def self.search_by_id(*vars)
1367
1725
  ## this is a stub, used for reference
1368
1726
  super
1369
1727
  end
1728
+
1370
1729
  end
1371
1730
  end