From 65e56de52d71a176604c222a302af23eea462e6e Mon Sep 17 00:00:00 2001 From: Nik Everett Date: Fri, 29 Mar 2019 03:50:08 -0400 Subject: [PATCH] Docs: Fix the API reference (#799) --- docs/index.asciidoc | 3 + docs/reference.asciidoc | 2857 ++++++++++++++++++++++++++++++++- scripts/utils/generateDocs.js | 37 +- 3 files changed, 2885 insertions(+), 12 deletions(-) diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 9995ab490..8569a45b3 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -1,5 +1,8 @@ = @elastic/elasticsearch +:branch: master +include::{asciidoc-dir}/../../shared/attributes.asciidoc[] + include::introduction.asciidoc[] include::usage.asciidoc[] include::configuration.asciidoc[] diff --git a/docs/reference.asciidoc b/docs/reference.asciidoc index e865b4ef0..d98d1676d 100644 --- a/docs/reference.asciidoc +++ b/docs/reference.asciidoc @@ -10,7 +10,8 @@ node scripts/run.js --tag v7.0.0-beta === Common parameters Parameters that are accepted by all API endpoints. -https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html + +link:{ref}/common-options.html[Reference] [cols=2*] |=== |`pretty` @@ -35,7 +36,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.h ---- client.bulk([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-bulk.html +======= +link:{ref}/docs-bulk.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -84,7 +89,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-bulk.html ---- client.cat.aliases([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-alias.html +======= +link:{ref}/cat-alias.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`name` @@ -118,7 +127,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-alias.html ---- client.cat.allocation([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-allocation.html +======= +link:{ref}/cat-allocation.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`node_id` or `nodeId` @@ -155,7 +168,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-allocation.html ---- client.cat.count([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-count.html +======= +link:{ref}/cat-count.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -189,7 +206,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-count.html ---- client.cat.fielddata([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-fielddata.html +======= +link:{ref}/cat-fielddata.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`fields` @@ -229,7 +250,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-fielddata.html ---- client.cat.health([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-health.html +======= +link:{ref}/cat-health.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`format` @@ -264,7 +289,11 @@ _Default:_ `true` ---- client.cat.help([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat.html +======= +link:{ref}/cat.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`help` @@ -280,7 +309,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat.html ---- client.cat.indices([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-indices.html +======= +link:{ref}/cat-indices.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -323,7 +356,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-indices.html ---- client.cat.master([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-master.html +======= +link:{ref}/cat-master.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`format` @@ -354,7 +391,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-master.html ---- client.cat.nodeattrs([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-nodeattrs.html +======= +link:{ref}/cat-nodeattrs.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`format` @@ -385,7 +426,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-nodeattrs.html ---- client.cat.nodes([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-nodes.html +======= +link:{ref}/cat-nodes.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`format` @@ -419,7 +464,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-nodes.html ---- client.cat.pendingTasks([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-pending-tasks.html +======= +link:{ref}/cat-pending-tasks.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`format` @@ -450,7 +499,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-pending-tasks.ht ---- client.cat.plugins([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-plugins.html +======= +link:{ref}/cat-plugins.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`format` @@ -481,7 +534,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-plugins.html ---- client.cat.recovery([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-recovery.html +======= +link:{ref}/cat-recovery.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -515,7 +572,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-recovery.html ---- client.cat.repositories([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-repositories.html +======= +link:{ref}/cat-repositories.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`format` @@ -546,7 +607,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-repositories.htm ---- client.cat.segments([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-segments.html +======= +link:{ref}/cat-segments.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -577,7 +642,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-segments.html ---- client.cat.shards([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-shards.html +======= +link:{ref}/cat-shards.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -614,7 +683,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-shards.html ---- client.cat.snapshots([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-snapshots.html +======= +link:{ref}/cat-snapshots.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`repository` @@ -648,7 +721,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-snapshots.html ---- client.cat.tasks([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/tasks.html +======= +link:{ref}/tasks.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`format` @@ -688,7 +765,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/tasks.html ---- client.cat.templates([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-templates.html +======= +link:{ref}/cat-templates.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`name` @@ -722,7 +803,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-templates.html ---- client.cat.threadPool([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-thread-pool.html +======= +link:{ref}/cat-thread-pool.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`thread_pool_patterns` or `threadPoolPatterns` @@ -759,7 +844,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cat-thread-pool.html ---- client.clearScroll([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/search-request-scroll.html +======= +link:{ref}/search-request-scroll.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`scroll_id` or `scrollId` @@ -775,7 +864,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/search-request-scrol ---- client.cluster.allocationExplain([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-allocation-explain.html +======= +link:{ref}/cluster-allocation-explain.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`include_yes_decisions` or `includeYesDecisions` @@ -794,7 +887,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-allocation-e ---- client.cluster.getSettings([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-update-settings.html +======= +link:{ref}/cluster-update-settings.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`flat_settings` or `flatSettings` @@ -816,7 +913,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-update-setti ---- client.cluster.health([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-health.html +======= +link:{ref}/cluster-health.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -857,7 +958,11 @@ _Default:_ `cluster` ---- client.cluster.pendingTasks([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-pending.html +======= +link:{ref}/cluster-pending.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`local` @@ -873,7 +978,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-pending.html ---- client.cluster.putSettings([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-update-settings.html +======= +link:{ref}/cluster-update-settings.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`flat_settings` or `flatSettings` @@ -895,7 +1004,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-update-setti ---- client.cluster.remoteInfo([params] [, options] [, callback]) ---- +<<<<<<< HEAD http://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-remote-info.html +======= +link:{ref}/cluster-remote-info.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) === cluster.reroute @@ -903,7 +1016,11 @@ http://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-remote-info.h ---- client.cluster.reroute([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-reroute.html +======= +link:{ref}/cluster-reroute.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`dry_run` or `dryRun` @@ -934,7 +1051,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-reroute.html ---- client.cluster.state([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-state.html +======= +link:{ref}/cluster-state.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -969,7 +1090,11 @@ _Default:_ `open` ---- client.cluster.stats([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-stats.html +======= +link:{ref}/cluster-stats.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`node_id` or `nodeId` @@ -988,7 +1113,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-stats.html ---- client.count([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/search-count.html +======= +link:{ref}/search-count.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -1098,7 +1227,11 @@ _Default:_ `open` ---- client.create([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-index_.html +======= +link:{ref}/docs-index_.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`id` @@ -1150,7 +1283,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-index_.html ---- client.delete([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-delete.html +======= +link:{ref}/docs-delete.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`id` @@ -1190,7 +1327,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-delete.html ---- client.deleteByQuery([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-delete-by-query.html +======= +link:{ref}/docs-delete-by-query.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -1306,12 +1447,35 @@ _Default:_ `1` |=== +<<<<<<< HEAD +======= +=== deleteByQueryRethrottle +[source,js] +---- +client.deleteByQueryRethrottle([params] [, options] [, callback]) +---- +link:{ref}/docs-delete-by-query.html[Reference] +[cols=2*] +|=== +|`task_id` or `taskId` +|`string` - The task id to rethrottle + +|`requests_per_second` or `requestsPerSecond` +|`number` - The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. + +|=== + +>>>>>>> c92b156... Docs: Fix the API reference (#799) === deleteScript [source,js] ---- client.deleteScript([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-scripting.html +======= +link:{ref}/modules-scripting.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`id` @@ -1346,7 +1510,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/search-template.html ---- client.exists([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-get.html +======= +link:{ref}/docs-get.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`id` @@ -1398,7 +1566,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-get.html ---- client.existsSource([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html +link:{ref}/docs-get.html[Reference] [cols=2*] |=== |`id` @@ -1447,7 +1615,11 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html ---- client.explain([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/search-explain.html +======= +link:{ref}/search-explain.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`id` @@ -1509,7 +1681,11 @@ _Default:_ `OR` ---- client.fieldCaps([params] [, options] [, callback]) ---- +<<<<<<< HEAD http://www.elastic.co/guide/en/elasticsearch/reference/5.6/search-field-caps.html +======= +link:{ref}/search-field-caps.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -1571,7 +1747,11 @@ _Default:_ `open` ---- client.get([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-get.html +======= +link:{ref}/docs-get.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`id` @@ -1623,7 +1803,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-get.html ---- client.getScript([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-scripting.html +======= +link:{ref}/modules-scripting.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`id` @@ -1639,7 +1823,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-scripting.ht ---- client.getSource([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-get.html +======= +link:{ref}/docs-get.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`id` @@ -1701,7 +1889,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/search-template.html ---- client.index([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-index_.html +======= +link:{ref}/docs-index_.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`id` @@ -1757,7 +1949,11 @@ _Default:_ `index` ---- client.indices.analyze([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-analyze.html +======= +link:{ref}/indices-analyze.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -1807,7 +2003,11 @@ _Default:_ `detailed` ---- client.indices.clearCache([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-clearcache.html +======= +link:{ref}/indices-clearcache.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -1854,7 +2054,11 @@ _Default:_ `open` ---- client.indices.close([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-open-close.html +======= +link:{ref}/indices-open-close.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -1883,7 +2087,11 @@ _Default:_ `open` ---- client.indices.create([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-create-index.html +======= +link:{ref}/indices-create-index.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -1911,7 +2119,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-create-index ---- client.indices.delete([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-delete-index.html +======= +link:{ref}/indices-delete-index.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -1930,7 +2142,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-delete-index ---- client.indices.deleteAlias([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-aliases.html +======= +link:{ref}/indices-aliases.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -1952,7 +2168,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-aliases.html ---- client.indices.deleteTemplate([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-templates.html +======= +link:{ref}/indices-templates.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`name` @@ -1971,7 +2191,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-templates.ht ---- client.indices.exists([params] [, options] [, callback]) ---- +<<<<<<< HEAD http://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-exists.html +======= +link:{ref}/indices-exists.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2003,7 +2227,11 @@ _Default:_ `open` ---- client.indices.existsAlias([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-aliases.html +======= +link:{ref}/indices-aliases.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2032,7 +2260,11 @@ _Default:_ `all` ---- client.indices.existsTemplate([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-templates.html +======= +link:{ref}/indices-templates.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`name` @@ -2054,7 +2286,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-templates.ht ---- client.indices.existsType([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-types-exists.html +======= +link:{ref}/indices-types-exists.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2083,7 +2319,11 @@ _Default:_ `open` ---- client.indices.flush([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-flush.html +======= +link:{ref}/indices-flush.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2112,7 +2352,11 @@ _Default:_ `open` ---- client.indices.flushSynced([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-synced-flush.html +======= +link:{ref}/indices-synced-flush.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2135,7 +2379,11 @@ _Default:_ `open` ---- client.indices.forcemerge([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-forcemerge.html +======= +link:{ref}/indices-forcemerge.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2173,7 +2421,11 @@ _Default:_ `open` ---- client.indices.get([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-get-index.html +======= +link:{ref}/indices-get-index.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2208,7 +2460,11 @@ _Default:_ `open` ---- client.indices.getAlias([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-aliases.html +======= +link:{ref}/indices-aliases.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2237,7 +2493,11 @@ _Default:_ `all` ---- client.indices.getFieldMapping([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-get-field-mapping.html +======= +link:{ref}/indices-get-field-mapping.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2272,7 +2532,11 @@ _Default:_ `open` ---- client.indices.getMapping([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-get-mapping.html +======= +link:{ref}/indices-get-mapping.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2301,7 +2565,11 @@ _Default:_ `open` ---- client.indices.getSettings([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-get-settings.html +======= +link:{ref}/indices-get-settings.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2336,7 +2604,11 @@ _Default:_ `open,closed` ---- client.indices.getTemplate([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-templates.html +======= +link:{ref}/indices-templates.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`name` @@ -2358,7 +2630,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-templates.ht ---- client.indices.getUpgrade([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-upgrade.html +======= +link:{ref}/indices-upgrade.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2381,7 +2657,11 @@ _Default:_ `open` ---- client.indices.open([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-open-close.html +======= +link:{ref}/indices-open-close.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2410,7 +2690,11 @@ _Default:_ `closed` ---- client.indices.putAlias([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-aliases.html +======= +link:{ref}/indices-aliases.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2435,7 +2719,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-aliases.html ---- client.indices.putMapping([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-put-mapping.html +======= +link:{ref}/indices-put-mapping.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2473,7 +2761,11 @@ _Default:_ `open` ---- client.indices.putSettings([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-update-settings.html +======= +link:{ref}/indices-update-settings.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2508,7 +2800,11 @@ _Default:_ `open` ---- client.indices.putTemplate([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-templates.html +======= +link:{ref}/indices-templates.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`name` @@ -2539,7 +2835,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-templates.ht ---- client.indices.recovery([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-recovery.html +======= +link:{ref}/indices-recovery.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2558,7 +2858,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-recovery.htm ---- client.indices.refresh([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-refresh.html +======= +link:{ref}/indices-refresh.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2581,7 +2885,11 @@ _Default:_ `open` ---- client.indices.rollover([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-rollover-index.html +======= +link:{ref}/indices-rollover-index.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`alias` @@ -2612,7 +2920,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-rollover-ind ---- client.indices.segments([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-segments.html +======= +link:{ref}/indices-segments.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2641,7 +2953,11 @@ _Default:_ `open` ---- client.indices.shardStores([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-shards-stores.html +======= +link:{ref}/indices-shards-stores.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2670,7 +2986,11 @@ _Default:_ `open` ---- client.indices.shrink([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-shrink-index.html +======= +link:{ref}/indices-shrink-index.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2693,12 +3013,47 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-shrink-index |=== +<<<<<<< HEAD +======= +=== indices.split +[source,js] +---- +client.indices.split([params] [, options] [, callback]) +---- +link:{ref}/indices-split-index.html[Reference] +[cols=2*] +|=== +|`index` +|`string` - The name of the source index to split + +|`target` +|`string` - The name of the target index to split into + +|`timeout` +|`string` - Explicit operation timeout + +|`master_timeout` or `masterTimeout` +|`string` - Specify timeout for connection to master + +|`wait_for_active_shards` or `waitForActiveShards` +|`string` - Set the number of active shards to wait for on the shrunken index before the operation returns. + +|`body` +|`object` - The configuration for the target index (`settings` and `aliases`) + +|=== + +>>>>>>> c92b156... Docs: Fix the API reference (#799) === indices.stats [source,js] ---- client.indices.stats([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-stats.html +======= +link:{ref}/indices-stats.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2736,7 +3091,11 @@ _Default:_ `indices` ---- client.indices.updateAliases([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-aliases.html +======= +link:{ref}/indices-aliases.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`timeout` @@ -2755,7 +3114,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-aliases.html ---- client.indices.upgrade([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/indices-upgrade.html +======= +link:{ref}/indices-upgrade.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2784,7 +3147,11 @@ _Default:_ `open` ---- client.indices.validateQuery([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/search-validate.html +======= +link:{ref}/search-validate.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2844,7 +3211,11 @@ _Default:_ `OR` ---- client.info([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/ +======= +link:http://www.elastic.co/guide/[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) === ingest.deletePipeline @@ -2852,7 +3223,11 @@ https://www.elastic.co/guide/ ---- client.ingest.deletePipeline([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/plugins/5.6/ingest.html +======= +link:https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`id` @@ -2871,7 +3246,11 @@ https://www.elastic.co/guide/en/elasticsearch/plugins/5.6/ingest.html ---- client.ingest.getPipeline([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/plugins/5.6/ingest.html +======= +link:https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`id` @@ -2887,7 +3266,7 @@ https://www.elastic.co/guide/en/elasticsearch/plugins/5.6/ingest.html ---- client.ingest.processorGrok([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html +link:https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html[Reference] === ingest.putPipeline @@ -2895,7 +3274,11 @@ https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html ---- client.ingest.putPipeline([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/plugins/5.6/ingest.html +======= +link:https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`id` @@ -2917,7 +3300,11 @@ https://www.elastic.co/guide/en/elasticsearch/plugins/5.6/ingest.html ---- client.ingest.simulate([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/plugins/5.6/ingest.html +======= +link:https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`id` @@ -2936,7 +3323,11 @@ https://www.elastic.co/guide/en/elasticsearch/plugins/5.6/ingest.html ---- client.mget([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-multi-get.html +======= +link:{ref}/docs-multi-get.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -2979,7 +3370,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-multi-get.html ---- client.mpercolate([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/search-percolate.html +======= +link:{ref}/search-multi-search.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -3040,7 +3435,11 @@ _Default:_ `128` ---- client.msearchTemplate([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html +======= +link:{ref}/search-multi-search.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -3068,7 +3467,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template. ---- client.mtermvectors([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-multi-termvectors.html +======= +link:{ref}/docs-multi-termvectors.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -3130,7 +3533,11 @@ _Default:_ `true` ---- client.nodes.hotThreads([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-nodes-hot-threads.html +======= +link:{ref}/cluster-nodes-hot-threads.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`node_id` or `nodeId` @@ -3161,7 +3568,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-nodes-hot-th ---- client.nodes.info([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-nodes-info.html +======= +link:{ref}/cluster-nodes-info.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`node_id` or `nodeId` @@ -3178,12 +3589,35 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-nodes-info.h |=== +<<<<<<< HEAD +======= +=== nodes.reloadSecureSettings +[source,js] +---- +client.nodes.reloadSecureSettings([params] [, options] [, callback]) +---- +link:https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings[Reference] +[cols=2*] +|=== +|`node_id` or `nodeId` +|`string, string[]` - A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes. + +|`timeout` +|`string` - Explicit operation timeout + +|=== + +>>>>>>> c92b156... Docs: Fix the API reference (#799) === nodes.stats [source,js] ---- client.nodes.stats([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-nodes-stats.html +======= +link:{ref}/cluster-nodes-stats.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`metric` @@ -3227,7 +3661,11 @@ _Default:_ `node` ---- client.percolate([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/search-percolate.html +======= +link:{ref}/cluster-nodes-usage.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -3286,7 +3724,11 @@ _Default:_ `open` ---- client.ping([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/ +======= +link:http://www.elastic.co/guide/[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) === putScript @@ -3294,7 +3736,11 @@ https://www.elastic.co/guide/ ---- client.putScript([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-scripting.html +======= +link:{ref}/modules-scripting.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`id` @@ -3319,7 +3765,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-scripting.ht ---- client.putTemplate([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/search-template.html +======= +link:{ref}/search-rank-eval.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`id` @@ -3335,7 +3785,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/search-template.html ---- client.reindex([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-reindex.html +======= +link:{ref}/docs-reindex.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`refresh` @@ -3369,7 +3823,11 @@ _Default:_ `1` ---- client.reindexRethrottle([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-reindex.html +======= +link:{ref}/docs-reindex.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`task_id` or `taskId` @@ -3385,7 +3843,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-reindex.html ---- client.renderSearchTemplate([params] [, options] [, callback]) ---- +<<<<<<< HEAD http://www.elasticsearch.org/guide/en/elasticsearch/reference/5.6/search-template.html +======= +link:{ref}/search-template.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`id` @@ -3396,12 +3858,44 @@ http://www.elasticsearch.org/guide/en/elasticsearch/reference/5.6/search-templat |=== +<<<<<<< HEAD +======= +=== scriptsPainlessContext +[source,js] +---- +client.scriptsPainlessContext([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`context` +|`string` - Select a specific context to retrieve API information about + +|=== + +=== scriptsPainlessExecute +[source,js] +---- +client.scriptsPainlessExecute([params] [, options] [, callback]) +---- +link:https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html[Reference] +[cols=2*] +|=== +|`body` +|`object` - The script to execute + +|=== + +>>>>>>> c92b156... Docs: Fix the API reference (#799) === scroll [source,js] ---- client.scroll([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/search-request-scroll.html +======= +link:{ref}/search-request-scroll.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`scroll_id` or `scrollId` @@ -3423,7 +3917,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/search-request-scrol ---- client.search([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/search-search.html +======= +link:{ref}/search-search.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -3559,7 +4057,11 @@ _Default:_ `128` ---- client.searchShards([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/search-shards.html +======= +link:{ref}/search-shards.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -3594,7 +4096,11 @@ _Default:_ `open` ---- client.searchTemplate([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html +======= +link:{ref}/search-template.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -3644,7 +4150,11 @@ _Default:_ `open` ---- client.snapshot.create([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-snapshots.html +======= +link:{ref}/modules-snapshots.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`repository` @@ -3669,7 +4179,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-snapshots.ht ---- client.snapshot.createRepository([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-snapshots.html +======= +link:{ref}/modules-snapshots.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`repository` @@ -3694,7 +4208,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-snapshots.ht ---- client.snapshot.delete([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-snapshots.html +======= +link:{ref}/modules-snapshots.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`repository` @@ -3713,7 +4231,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-snapshots.ht ---- client.snapshot.deleteRepository([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-snapshots.html +======= +link:{ref}/modules-snapshots.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`repository` @@ -3732,7 +4254,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-snapshots.ht ---- client.snapshot.get([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-snapshots.html +======= +link:{ref}/modules-snapshots.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`repository` @@ -3757,7 +4283,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-snapshots.ht ---- client.snapshot.getRepository([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-snapshots.html +======= +link:{ref}/modules-snapshots.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`repository` @@ -3776,7 +4306,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-snapshots.ht ---- client.snapshot.restore([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-snapshots.html +======= +link:{ref}/modules-snapshots.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`repository` @@ -3801,7 +4335,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-snapshots.ht ---- client.snapshot.status([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-snapshots.html +======= +link:{ref}/modules-snapshots.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`repository` @@ -3823,7 +4361,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-snapshots.ht ---- client.snapshot.verifyRepository([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-snapshots.html +======= +link:{ref}/modules-snapshots.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`repository` @@ -3874,7 +4416,11 @@ _Default:_ `open` ---- client.tasks.cancel([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/tasks.html +======= +link:{ref}/tasks.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`task_id` or `taskId` @@ -3899,7 +4445,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/tasks.html ---- client.tasks.get([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/tasks.html +======= +link:{ref}/tasks.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`task_id` or `taskId` @@ -3915,7 +4465,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/tasks.html ---- client.tasks.list([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/tasks.html +======= +link:{ref}/tasks.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`nodes` @@ -3947,7 +4501,11 @@ _Default:_ `nodes` ---- client.termvectors([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-termvectors.html +======= +link:{ref}/docs-termvectors.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -4009,7 +4567,11 @@ _Default:_ `true` ---- client.update([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-update.html +======= +link:{ref}/docs-update.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`id` @@ -4076,7 +4638,11 @@ https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-update.html ---- client.updateByQuery([params] [, options] [, callback]) ---- +<<<<<<< HEAD https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-update-by-query.html +======= +link:{ref}/docs-update-by-query.html[Reference] +>>>>>>> c92b156... Docs: Fix the API reference (#799) [cols=2*] |=== |`index` @@ -4197,3 +4763,2288 @@ _Default:_ `1` |`object` - The search definition using the Query DSL |=== +<<<<<<< HEAD +======= + +=== updateByQueryRethrottle +[source,js] +---- +client.updateByQueryRethrottle([params] [, options] [, callback]) +---- +link:{ref}/docs-update-by-query.html[Reference] +[cols=2*] +|=== +|`task_id` or `taskId` +|`string` - The task id to rethrottle + +|`requests_per_second` or `requestsPerSecond` +|`number` - The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. + +|=== + +=== ccr.deleteAutoFollowPattern +[source,js] +---- +client.ccr.deleteAutoFollowPattern([params] [, options] [, callback]) +---- +link:{ref}/ccr-delete-auto-follow-pattern.html[Reference] +[cols=2*] +|=== +|`name` +|`string` - The name of the auto follow pattern. + +|=== + +=== ccr.follow +[source,js] +---- +client.ccr.follow([params] [, options] [, callback]) +---- +link:{ref}/ccr-put-follow.html[Reference] +[cols=2*] +|=== +|`index` +|`string` - The name of the follower index + +|`wait_for_active_shards` or `waitForActiveShards` +|`string` - Sets the number of shard copies that must be active before returning. Defaults to 0. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) + +_Default:_ `0` + +|`body` +|`object` - The name of the leader index and other optional ccr related parameters + +|=== + +=== ccr.followInfo +[source,js] +---- +client.ccr.followInfo([params] [, options] [, callback]) +---- +link:{ref}/ccr-get-follow-info.html[Reference] +[cols=2*] +|=== +|`index` +|`string, string[]` - A comma-separated list of index patterns; use `_all` to perform the operation on all indices + +|=== + +=== ccr.followStats +[source,js] +---- +client.ccr.followStats([params] [, options] [, callback]) +---- +link:{ref}/ccr-get-follow-stats.html[Reference] +[cols=2*] +|=== +|`index` +|`string, string[]` - A comma-separated list of index patterns; use `_all` to perform the operation on all indices + +|=== + +=== ccr.forgetFollower +[source,js] +---- +client.ccr.forgetFollower([params] [, options] [, callback]) +---- +link:http://www.elastic.co/guide/en/elasticsearch/reference/current[Reference] +[cols=2*] +|=== +|`index` +|`string` - the name of the leader index for which specified follower retention leases should be removed + +|`body` +|`object` - the name and UUID of the follower index, the name of the cluster containing the follower index, and the alias from the perspective of that cluster for the remote cluster containing the leader index + +|=== + +=== ccr.getAutoFollowPattern +[source,js] +---- +client.ccr.getAutoFollowPattern([params] [, options] [, callback]) +---- +link:{ref}/ccr-get-auto-follow-pattern.html[Reference] +[cols=2*] +|=== +|`name` +|`string` - The name of the auto follow pattern. + +|=== + +=== ccr.pauseFollow +[source,js] +---- +client.ccr.pauseFollow([params] [, options] [, callback]) +---- +link:{ref}/ccr-post-pause-follow.html[Reference] +[cols=2*] +|=== +|`index` +|`string` - The name of the follower index that should pause following its leader index. + +|=== + +=== ccr.putAutoFollowPattern +[source,js] +---- +client.ccr.putAutoFollowPattern([params] [, options] [, callback]) +---- +link:{ref}/ccr-put-auto-follow-pattern.html[Reference] +[cols=2*] +|=== +|`name` +|`string` - The name of the auto follow pattern. + +|`body` +|`object` - The specification of the auto follow pattern + +|=== + +=== ccr.resumeFollow +[source,js] +---- +client.ccr.resumeFollow([params] [, options] [, callback]) +---- +link:{ref}/ccr-post-resume-follow.html[Reference] +[cols=2*] +|=== +|`index` +|`string` - The name of the follow index to resume following. + +|`body` +|`object` - The name of the leader index and other optional ccr related parameters + +|=== + +=== ccr.stats +[source,js] +---- +client.ccr.stats([params] [, options] [, callback]) +---- +link:{ref}/ccr-get-stats.html[Reference] + + +=== ccr.unfollow +[source,js] +---- +client.ccr.unfollow([params] [, options] [, callback]) +---- +link:http://www.elastic.co/guide/en/elasticsearch/reference/current[Reference] +[cols=2*] +|=== +|`index` +|`string` - The name of the follower index that should be turned into a regular index. + +|=== + +=== dataFrame.deleteDataFrameTransform +[source,js] +---- +client.dataFrame.deleteDataFrameTransform([params] [, options] [, callback]) +---- +link:{ref}/delete-data-frame-transform.html[Reference] +[cols=2*] +|=== +|`transform_id` or `transformId` +|`string` - The id of the transform to delete + +|=== + +=== dataFrame.getDataFrameTransform +[source,js] +---- +client.dataFrame.getDataFrameTransform([params] [, options] [, callback]) +---- +link:{ref}/get-data-frame-transform.html[Reference] +[cols=2*] +|=== +|`transform_id` or `transformId` +|`string` - The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms + +|`from` +|`number` - skips a number of transform configs, defaults to 0 + +|`size` +|`number` - specifies a max number of transforms to get, defaults to 100 + +|=== + +=== dataFrame.getDataFrameTransformStats +[source,js] +---- +client.dataFrame.getDataFrameTransformStats([params] [, options] [, callback]) +---- +link:{ref}/get-data-frame-transform-stats.html[Reference] +[cols=2*] +|=== +|`transform_id` or `transformId` +|`string` - The id of the transform for which to get stats. '_all' or '*' implies all transforms + +|=== + +=== dataFrame.previewDataFrameTransform +[source,js] +---- +client.dataFrame.previewDataFrameTransform([params] [, options] [, callback]) +---- +link:{ref}/preview-data-frame-transform.html[Reference] +[cols=2*] +|=== +|`body` +|`object` - The definition for the data_frame transform to preview + +|=== + +=== dataFrame.putDataFrameTransform +[source,js] +---- +client.dataFrame.putDataFrameTransform([params] [, options] [, callback]) +---- +link:{ref}/put-data-frame-transform.html[Reference] +[cols=2*] +|=== +|`transform_id` or `transformId` +|`string` - The id of the new transform. + +|`body` +|`object` - The data frame transform definition + +|=== + +=== dataFrame.startDataFrameTransform +[source,js] +---- +client.dataFrame.startDataFrameTransform([params] [, options] [, callback]) +---- +link:{ref}/start-data-frame-transform.html[Reference] +[cols=2*] +|=== +|`transform_id` or `transformId` +|`string` - The id of the transform to start + +|`timeout` +|`string` - Controls the time to wait for the transform to start + +|=== + +=== dataFrame.stopDataFrameTransform +[source,js] +---- +client.dataFrame.stopDataFrameTransform([params] [, options] [, callback]) +---- +link:{ref}/stop-data-frame-transform.html[Reference] +[cols=2*] +|=== +|`transform_id` or `transformId` +|`string` - The id of the transform to stop + +|`wait_for_completion` or `waitForCompletion` +|`boolean` - Whether to wait for the transform to fully stop before returning or not. Default to false + +|`timeout` +|`string` - Controls the time to wait until the transform has stopped. Default to 30 seconds + +|=== + +=== graph.explore +[source,js] +---- +client.graph.explore([params] [, options] [, callback]) +---- +link:{ref}/graph-explore-api.html[Reference] +[cols=2*] +|=== +|`index` +|`string, string[]` - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices + +|`type` +|`string, string[]` - A comma-separated list of document types to search; leave empty to perform the operation on all types + +|`routing` +|`string` - Specific routing value + +|`timeout` +|`string` - Explicit operation timeout + +|`body` +|`object` - Graph Query DSL + +|=== + +=== ilm.deleteLifecycle +[source,js] +---- +client.ilm.deleteLifecycle([params] [, options] [, callback]) +---- +link:{ref}/ilm-delete-lifecycle.html[Reference] +[cols=2*] +|=== +|`policy` +|`string` - The name of the index lifecycle policy + +|=== + +=== ilm.explainLifecycle +[source,js] +---- +client.ilm.explainLifecycle([params] [, options] [, callback]) +---- +link:{ref}/ilm-explain-lifecycle.html[Reference] +[cols=2*] +|=== +|`index` +|`string` - The name of the index to explain + +|=== + +=== ilm.getLifecycle +[source,js] +---- +client.ilm.getLifecycle([params] [, options] [, callback]) +---- +link:{ref}/ilm-get-lifecycle.html[Reference] +[cols=2*] +|=== +|`policy` +|`string` - The name of the index lifecycle policy + +|=== + +=== ilm.getStatus +[source,js] +---- +client.ilm.getStatus([params] [, options] [, callback]) +---- +link:{ref}/ilm-get-status.html[Reference] + + +=== ilm.moveToStep +[source,js] +---- +client.ilm.moveToStep([params] [, options] [, callback]) +---- +link:{ref}/ilm-move-to-step.html[Reference] +[cols=2*] +|=== +|`index` +|`string` - The name of the index whose lifecycle step is to change + +|`body` +|`object` - The new lifecycle step to move to + +|=== + +=== ilm.putLifecycle +[source,js] +---- +client.ilm.putLifecycle([params] [, options] [, callback]) +---- +link:{ref}/ilm-put-lifecycle.html[Reference] +[cols=2*] +|=== +|`policy` +|`string` - The name of the index lifecycle policy + +|`body` +|`object` - The lifecycle policy definition to register + +|=== + +=== ilm.removePolicy +[source,js] +---- +client.ilm.removePolicy([params] [, options] [, callback]) +---- +link:{ref}/ilm-remove-policy.html[Reference] +[cols=2*] +|=== +|`index` +|`string` - The name of the index to remove policy on + +|=== + +=== ilm.retry +[source,js] +---- +client.ilm.retry([params] [, options] [, callback]) +---- +link:{ref}/ilm-retry-policy.html[Reference] +[cols=2*] +|=== +|`index` +|`string` - The name of the indices (comma-separated) whose failed lifecycle step is to be retry + +|=== + +=== ilm.start +[source,js] +---- +client.ilm.start([params] [, options] [, callback]) +---- +link:{ref}/ilm-start.html[Reference] + + +=== ilm.stop +[source,js] +---- +client.ilm.stop([params] [, options] [, callback]) +---- +link:{ref}/ilm-stop.html[Reference] + + +=== indices.freeze +[source,js] +---- +client.indices.freeze([params] [, options] [, callback]) +---- +link:{ref}/freeze-index-api.html[Reference] +[cols=2*] +|=== +|`index` +|`string` - The name of the index to freeze + +|`timeout` +|`string` - Explicit operation timeout + +|`master_timeout` or `masterTimeout` +|`string` - Specify timeout for connection to master + +|`ignore_unavailable` or `ignoreUnavailable` +|`boolean` - Whether specified concrete indices should be ignored when unavailable (missing or closed) + +|`allow_no_indices` or `allowNoIndices` +|`boolean` - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + +|`expand_wildcards` or `expandWildcards` +|`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + +_Default:_ `closed` + +|`wait_for_active_shards` or `waitForActiveShards` +|`string` - Sets the number of active shards to wait for before the operation returns. + +|=== + +=== indices.unfreeze +[source,js] +---- +client.indices.unfreeze([params] [, options] [, callback]) +---- +link:{ref}/freeze-index-api.html[Reference] +[cols=2*] +|=== +|`index` +|`string` - The name of the index to unfreeze + +|`timeout` +|`string` - Explicit operation timeout + +|`master_timeout` or `masterTimeout` +|`string` - Specify timeout for connection to master + +|`ignore_unavailable` or `ignoreUnavailable` +|`boolean` - Whether specified concrete indices should be ignored when unavailable (missing or closed) + +|`allow_no_indices` or `allowNoIndices` +|`boolean` - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + +|`expand_wildcards` or `expandWildcards` +|`'open', 'closed', 'none', 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. + +_Default:_ `closed` + +|`wait_for_active_shards` or `waitForActiveShards` +|`string` - Sets the number of active shards to wait for before the operation returns. + +|=== + +=== license.delete +[source,js] +---- +client.license.delete([params] [, options] [, callback]) +---- +link:{ref}/delete-license.html[Reference] + + +=== license.get +[source,js] +---- +client.license.get([params] [, options] [, callback]) +---- +link:{ref}/get-license.html[Reference] +[cols=2*] +|=== +|`local` +|`boolean` - Return local information, do not retrieve the state from master node (default: false) + +|=== + +=== license.getBasicStatus +[source,js] +---- +client.license.getBasicStatus([params] [, options] [, callback]) +---- +link:{ref}/get-basic-status.html[Reference] + + +=== license.getTrialStatus +[source,js] +---- +client.license.getTrialStatus([params] [, options] [, callback]) +---- +link:{ref}/get-trial-status.html[Reference] + + +=== license.post +[source,js] +---- +client.license.post([params] [, options] [, callback]) +---- +link:{ref}/update-license.html[Reference] +[cols=2*] +|=== +|`acknowledge` +|`boolean` - whether the user has acknowledged acknowledge messages (default: false) + +|`body` +|`object` - licenses to be installed + +|=== + +=== license.postStartBasic +[source,js] +---- +client.license.postStartBasic([params] [, options] [, callback]) +---- +link:{ref}/start-basic.html[Reference] +[cols=2*] +|=== +|`acknowledge` +|`boolean` - whether the user has acknowledged acknowledge messages (default: false) + +|=== + +=== license.postStartTrial +[source,js] +---- +client.license.postStartTrial([params] [, options] [, callback]) +---- +link:{ref}/start-trial.html[Reference] +[cols=2*] +|=== +|`type` +|`string` - The type of trial license to generate (default: "trial") + +|`acknowledge` +|`boolean` - whether the user has acknowledged acknowledge messages (default: false) + +|=== + +=== migration.deprecations +[source,js] +---- +client.migration.deprecations([params] [, options] [, callback]) +---- +link:{ref}/migration-api-deprecation.html[Reference] +[cols=2*] +|=== +|`index` +|`string` - Index pattern + +|=== + +=== ml.closeJob +[source,js] +---- +client.ml.closeJob([params] [, options] [, callback]) +---- +link:{ref}/ml-close-job.html[Reference] +[cols=2*] +|=== +|`job_id` or `jobId` +|`string` - The name of the job to close + +|`allow_no_jobs` or `allowNoJobs` +|`boolean` - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) + +|`force` +|`boolean` - True if the job should be forcefully closed + +|`timeout` +|`string` - Controls the time to wait until a job has closed. Default to 30 minutes + +|`body` +|`object` - The URL params optionally sent in the body + +|=== + +=== ml.deleteCalendar +[source,js] +---- +client.ml.deleteCalendar([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`calendar_id` or `calendarId` +|`string` - The ID of the calendar to delete + +|=== + +=== ml.deleteCalendarEvent +[source,js] +---- +client.ml.deleteCalendarEvent([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`calendar_id` or `calendarId` +|`string` - The ID of the calendar to modify + +|`event_id` or `eventId` +|`string` - The ID of the event to remove from the calendar + +|=== + +=== ml.deleteCalendarJob +[source,js] +---- +client.ml.deleteCalendarJob([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`calendar_id` or `calendarId` +|`string` - The ID of the calendar to modify + +|`job_id` or `jobId` +|`string` - The ID of the job to remove from the calendar + +|=== + +=== ml.deleteDatafeed +[source,js] +---- +client.ml.deleteDatafeed([params] [, options] [, callback]) +---- +link:{ref}/ml-delete-datafeed.html[Reference] +[cols=2*] +|=== +|`datafeed_id` or `datafeedId` +|`string` - The ID of the datafeed to delete + +|`force` +|`boolean` - True if the datafeed should be forcefully deleted + +|=== + +=== ml.deleteExpiredData +[source,js] +---- +client.ml.deleteExpiredData([params] [, options] [, callback]) +---- + + +=== ml.deleteFilter +[source,js] +---- +client.ml.deleteFilter([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`filter_id` or `filterId` +|`string` - The ID of the filter to delete + +|=== + +=== ml.deleteForecast +[source,js] +---- +client.ml.deleteForecast([params] [, options] [, callback]) +---- +link:{ref}/ml-delete-forecast.html[Reference] +[cols=2*] +|=== +|`job_id` or `jobId` +|`string` - The ID of the job from which to delete forecasts + +|`forecast_id` or `forecastId` +|`string` - The ID of the forecast to delete, can be comma delimited list. Leaving blank implies `_all` + +|`allow_no_forecasts` or `allowNoForecasts` +|`boolean` - Whether to ignore if `_all` matches no forecasts + +|`timeout` +|`string` - Controls the time to wait until the forecast(s) are deleted. Default to 30 seconds + +|=== + +=== ml.deleteJob +[source,js] +---- +client.ml.deleteJob([params] [, options] [, callback]) +---- +link:{ref}/ml-delete-job.html[Reference] +[cols=2*] +|=== +|`job_id` or `jobId` +|`string` - The ID of the job to delete + +|`force` +|`boolean` - True if the job should be forcefully deleted + +|`wait_for_completion` or `waitForCompletion` +|`boolean` - Should this request wait until the operation has completed before returning + +_Default:_ `true` + +|=== + +=== ml.deleteModelSnapshot +[source,js] +---- +client.ml.deleteModelSnapshot([params] [, options] [, callback]) +---- +link:{ref}/ml-delete-snapshot.html[Reference] +[cols=2*] +|=== +|`job_id` or `jobId` +|`string` - The ID of the job to fetch + +|`snapshot_id` or `snapshotId` +|`string` - The ID of the snapshot to delete + +|=== + +=== ml.findFileStructure +[source,js] +---- +client.ml.findFileStructure([params] [, options] [, callback]) +---- +link:{ref}/ml-find-file-structure.html[Reference] +[cols=2*] +|=== +|`lines_to_sample` or `linesToSample` +|`number` - How many lines of the file should be included in the analysis + +_Default:_ `1000` + +|`timeout` +|`string` - Timeout after which the analysis will be aborted + +_Default:_ `25s` + +|`charset` +|`string` - Optional parameter to specify the character set of the file + +|`format` +|`'ndjson', 'xml', 'delimited', 'semi_structured_text'` - Optional parameter to specify the high level file format + +|`has_header_row` or `hasHeaderRow` +|`boolean` - Optional parameter to specify whether a delimited file includes the column names in its first row + +|`column_names` or `columnNames` +|`string, string[]` - Optional parameter containing a comma separated list of the column names for a delimited file + +|`delimiter` +|`string` - Optional parameter to specify the delimiter character for a delimited file - must be a single character + +|`quote` +|`string` - Optional parameter to specify the quote character for a delimited file - must be a single character + +|`should_trim_fields` or `shouldTrimFields` +|`boolean` - Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them + +|`grok_pattern` or `grokPattern` +|`string` - Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file + +|`timestamp_field` or `timestampField` +|`string` - Optional parameter to specify the timestamp field in the file + +|`timestamp_format` or `timestampFormat` +|`string` - Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format + +|`explain` +|`boolean` - Whether to include a commentary on how the structure was derived + +|`body` +|`object` - The contents of the file to be analyzed + +|=== + +=== ml.flushJob +[source,js] +---- +client.ml.flushJob([params] [, options] [, callback]) +---- +link:{ref}/ml-flush-job.html[Reference] +[cols=2*] +|=== +|`job_id` or `jobId` +|`string` - The name of the job to flush + +|`calc_interim` or `calcInterim` +|`boolean` - Calculates interim results for the most recent bucket or all buckets within the latency period + +|`start` +|`string` - When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results + +|`end` +|`string` - When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results + +|`advance_time` or `advanceTime` +|`string` - Advances time to the given value generating results and updating the model for the advanced interval + +|`skip_time` or `skipTime` +|`string` - Skips time to the given value without generating results or updating the model for the skipped interval + +|`body` +|`object` - Flush parameters + +|=== + +=== ml.forecast +[source,js] +---- +client.ml.forecast([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`job_id` or `jobId` +|`string` - The ID of the job to forecast for + +|`duration` +|`string` - The duration of the forecast + +|`expires_in` or `expiresIn` +|`string` - The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity. + +|=== + +=== ml.getBuckets +[source,js] +---- +client.ml.getBuckets([params] [, options] [, callback]) +---- +link:{ref}/ml-get-bucket.html[Reference] +[cols=2*] +|=== +|`job_id` or `jobId` +|`string` - ID of the job to get bucket results from + +|`timestamp` +|`string` - The timestamp of the desired single bucket result + +|`expand` +|`boolean` - Include anomaly records + +|`exclude_interim` or `excludeInterim` +|`boolean` - Exclude interim results + +|`from` +|`number` - skips a number of buckets + +|`size` +|`number` - specifies a max number of buckets to get + +|`start` +|`string` - Start time filter for buckets + +|`end` +|`string` - End time filter for buckets + +|`anomaly_score` or `anomalyScore` +|`number` - Filter for the most anomalous buckets + +|`sort` +|`string` - Sort buckets by a particular field + +|`desc` +|`boolean` - Set the sort direction + +|`body` +|`object` - Bucket selection details if not provided in URI + +|=== + +=== ml.getCalendarEvents +[source,js] +---- +client.ml.getCalendarEvents([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`calendar_id` or `calendarId` +|`string` - The ID of the calendar containing the events + +|`job_id` or `jobId` +|`string` - Get events for the job. When this option is used calendar_id must be '_all' + +|`start` +|`string` - Get events after this time + +|`end` +|`string` - Get events before this time + +|`from` +|`number` - Skips a number of events + +|`size` +|`number` - Specifies a max number of events to get + +|=== + +=== ml.getCalendars +[source,js] +---- +client.ml.getCalendars([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`calendar_id` or `calendarId` +|`string` - The ID of the calendar to fetch + +|`from` +|`number` - skips a number of calendars + +|`size` +|`number` - specifies a max number of calendars to get + +|`body` +|`object` - The from and size parameters optionally sent in the body + +|=== + +=== ml.getCategories +[source,js] +---- +client.ml.getCategories([params] [, options] [, callback]) +---- +link:{ref}/ml-get-category.html[Reference] +[cols=2*] +|=== +|`job_id` or `jobId` +|`string` - The name of the job + +|`category_id` or `categoryId` +|`number` - The identifier of the category definition of interest + +|`from` +|`number` - skips a number of categories + +|`size` +|`number` - specifies a max number of categories to get + +|`body` +|`object` - Category selection details if not provided in URI + +|=== + +=== ml.getDatafeedStats +[source,js] +---- +client.ml.getDatafeedStats([params] [, options] [, callback]) +---- +link:{ref}/ml-get-datafeed-stats.html[Reference] +[cols=2*] +|=== +|`datafeed_id` or `datafeedId` +|`string` - The ID of the datafeeds stats to fetch + +|`allow_no_datafeeds` or `allowNoDatafeeds` +|`boolean` - Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) + +|=== + +=== ml.getDatafeeds +[source,js] +---- +client.ml.getDatafeeds([params] [, options] [, callback]) +---- +link:{ref}/ml-get-datafeed.html[Reference] +[cols=2*] +|=== +|`datafeed_id` or `datafeedId` +|`string` - The ID of the datafeeds to fetch + +|`allow_no_datafeeds` or `allowNoDatafeeds` +|`boolean` - Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) + +|=== + +=== ml.getFilters +[source,js] +---- +client.ml.getFilters([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`filter_id` or `filterId` +|`string` - The ID of the filter to fetch + +|`from` +|`number` - skips a number of filters + +|`size` +|`number` - specifies a max number of filters to get + +|=== + +=== ml.getInfluencers +[source,js] +---- +client.ml.getInfluencers([params] [, options] [, callback]) +---- +link:{ref}/ml-get-influencer.html[Reference] +[cols=2*] +|=== +|`job_id` or `jobId` +|`string` - undefined + +|`exclude_interim` or `excludeInterim` +|`boolean` - Exclude interim results + +|`from` +|`number` - skips a number of influencers + +|`size` +|`number` - specifies a max number of influencers to get + +|`start` +|`string` - start timestamp for the requested influencers + +|`end` +|`string` - end timestamp for the requested influencers + +|`influencer_score` or `influencerScore` +|`number` - influencer score threshold for the requested influencers + +|`sort` +|`string` - sort field for the requested influencers + +|`desc` +|`boolean` - whether the results should be sorted in decending order + +|`body` +|`object` - Influencer selection criteria + +|=== + +=== ml.getJobStats +[source,js] +---- +client.ml.getJobStats([params] [, options] [, callback]) +---- +link:{ref}/ml-get-job-stats.html[Reference] +[cols=2*] +|=== +|`job_id` or `jobId` +|`string` - The ID of the jobs stats to fetch + +|`allow_no_jobs` or `allowNoJobs` +|`boolean` - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) + +|=== + +=== ml.getJobs +[source,js] +---- +client.ml.getJobs([params] [, options] [, callback]) +---- +link:{ref}/ml-get-job.html[Reference] +[cols=2*] +|=== +|`job_id` or `jobId` +|`string` - The ID of the jobs to fetch + +|`allow_no_jobs` or `allowNoJobs` +|`boolean` - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) + +|=== + +=== ml.getModelSnapshots +[source,js] +---- +client.ml.getModelSnapshots([params] [, options] [, callback]) +---- +link:{ref}/ml-get-snapshot.html[Reference] +[cols=2*] +|=== +|`job_id` or `jobId` +|`string` - The ID of the job to fetch + +|`snapshot_id` or `snapshotId` +|`string` - The ID of the snapshot to fetch + +|`from` +|`number` - Skips a number of documents + +|`size` +|`number` - The default number of documents returned in queries as a string. + +|`start` +|`string` - The filter 'start' query parameter + +|`end` +|`string` - The filter 'end' query parameter + +|`sort` +|`string` - Name of the field to sort on + +|`desc` +|`boolean` - True if the results should be sorted in descending order + +|`body` +|`object` - Model snapshot selection criteria + +|=== + +=== ml.getOverallBuckets +[source,js] +---- +client.ml.getOverallBuckets([params] [, options] [, callback]) +---- +link:{ref}/ml-get-overall-buckets.html[Reference] +[cols=2*] +|=== +|`job_id` or `jobId` +|`string` - The job IDs for which to calculate overall bucket results + +|`top_n` or `topN` +|`number` - The number of top job bucket scores to be used in the overall_score calculation + +|`bucket_span` or `bucketSpan` +|`string` - The span of the overall buckets. Defaults to the longest job bucket_span + +|`overall_score` or `overallScore` +|`number` - Returns overall buckets with overall scores higher than this value + +|`exclude_interim` or `excludeInterim` +|`boolean` - If true overall buckets that include interim buckets will be excluded + +|`start` +|`string` - Returns overall buckets with timestamps after this time + +|`end` +|`string` - Returns overall buckets with timestamps earlier than this time + +|`allow_no_jobs` or `allowNoJobs` +|`boolean` - Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) + +|`body` +|`object` - Overall bucket selection details if not provided in URI + +|=== + +=== ml.getRecords +[source,js] +---- +client.ml.getRecords([params] [, options] [, callback]) +---- +link:{ref}/ml-get-record.html[Reference] +[cols=2*] +|=== +|`job_id` or `jobId` +|`string` - undefined + +|`exclude_interim` or `excludeInterim` +|`boolean` - Exclude interim results + +|`from` +|`number` - skips a number of records + +|`size` +|`number` - specifies a max number of records to get + +|`start` +|`string` - Start time filter for records + +|`end` +|`string` - End time filter for records + +|`record_score` or `recordScore` +|`number` - undefined + +|`sort` +|`string` - Sort records by a particular field + +|`desc` +|`boolean` - Set the sort direction + +|`body` +|`object` - Record selection criteria + +|=== + +=== ml.info +[source,js] +---- +client.ml.info([params] [, options] [, callback]) +---- + + +=== ml.openJob +[source,js] +---- +client.ml.openJob([params] [, options] [, callback]) +---- +link:{ref}/ml-open-job.html[Reference] +[cols=2*] +|=== +|`job_id` or `jobId` +|`string` - The ID of the job to open + +|`ignore_downtime` or `ignoreDowntime` +|`boolean` - Controls if gaps in data are treated as anomalous or as a maintenance window after a job re-start + +|`timeout` +|`string` - Controls the time to wait until a job has opened. Default to 30 minutes + +|=== + +=== ml.postCalendarEvents +[source,js] +---- +client.ml.postCalendarEvents([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`calendar_id` or `calendarId` +|`string` - The ID of the calendar to modify + +|`body` +|`object` - A list of events + +|=== + +=== ml.postData +[source,js] +---- +client.ml.postData([params] [, options] [, callback]) +---- +link:{ref}/ml-post-data.html[Reference] +[cols=2*] +|=== +|`job_id` or `jobId` +|`string` - The name of the job receiving the data + +|`reset_start` or `resetStart` +|`string` - Optional parameter to specify the start of the bucket resetting range + +|`reset_end` or `resetEnd` +|`string` - Optional parameter to specify the end of the bucket resetting range + +|`body` +|`object` - The data to process + +|=== + +=== ml.previewDatafeed +[source,js] +---- +client.ml.previewDatafeed([params] [, options] [, callback]) +---- +link:{ref}/ml-preview-datafeed.html[Reference] +[cols=2*] +|=== +|`datafeed_id` or `datafeedId` +|`string` - The ID of the datafeed to preview + +|=== + +=== ml.putCalendar +[source,js] +---- +client.ml.putCalendar([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`calendar_id` or `calendarId` +|`string` - The ID of the calendar to create + +|`body` +|`object` - The calendar details + +|=== + +=== ml.putCalendarJob +[source,js] +---- +client.ml.putCalendarJob([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`calendar_id` or `calendarId` +|`string` - The ID of the calendar to modify + +|`job_id` or `jobId` +|`string` - The ID of the job to add to the calendar + +|=== + +=== ml.putDatafeed +[source,js] +---- +client.ml.putDatafeed([params] [, options] [, callback]) +---- +link:{ref}/ml-put-datafeed.html[Reference] +[cols=2*] +|=== +|`datafeed_id` or `datafeedId` +|`string` - The ID of the datafeed to create + +|`body` +|`object` - The datafeed config + +|=== + +=== ml.putFilter +[source,js] +---- +client.ml.putFilter([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`filter_id` or `filterId` +|`string` - The ID of the filter to create + +|`body` +|`object` - The filter details + +|=== + +=== ml.putJob +[source,js] +---- +client.ml.putJob([params] [, options] [, callback]) +---- +link:{ref}/ml-put-job.html[Reference] +[cols=2*] +|=== +|`job_id` or `jobId` +|`string` - The ID of the job to create + +|`body` +|`object` - The job + +|=== + +=== ml.revertModelSnapshot +[source,js] +---- +client.ml.revertModelSnapshot([params] [, options] [, callback]) +---- +link:{ref}/ml-revert-snapshot.html[Reference] +[cols=2*] +|=== +|`job_id` or `jobId` +|`string` - The ID of the job to fetch + +|`snapshot_id` or `snapshotId` +|`string` - The ID of the snapshot to revert to + +|`delete_intervening_results` or `deleteInterveningResults` +|`boolean` - Should we reset the results back to the time of the snapshot? + +|`body` +|`object` - Reversion options + +|=== + +=== ml.setUpgradeMode +[source,js] +---- +client.ml.setUpgradeMode([params] [, options] [, callback]) +---- +link:{ref}/ml-set-upgrade-mode.html[Reference] +[cols=2*] +|=== +|`enabled` +|`boolean` - Whether to enable upgrade_mode ML setting or not. Defaults to false. + +|`timeout` +|`string` - Controls the time to wait before action times out. Defaults to 30 seconds + +|=== + +=== ml.startDatafeed +[source,js] +---- +client.ml.startDatafeed([params] [, options] [, callback]) +---- +link:{ref}/ml-start-datafeed.html[Reference] +[cols=2*] +|=== +|`datafeed_id` or `datafeedId` +|`string` - The ID of the datafeed to start + +|`start` +|`string` - The start time from where the datafeed should begin + +|`end` +|`string` - The end time when the datafeed should stop. When not set, the datafeed continues in real time + +|`timeout` +|`string` - Controls the time to wait until a datafeed has started. Default to 20 seconds + +|`body` +|`object` - The start datafeed parameters + +|=== + +=== ml.stopDatafeed +[source,js] +---- +client.ml.stopDatafeed([params] [, options] [, callback]) +---- +link:{ref}/ml-stop-datafeed.html[Reference] +[cols=2*] +|=== +|`datafeed_id` or `datafeedId` +|`string` - The ID of the datafeed to stop + +|`allow_no_datafeeds` or `allowNoDatafeeds` +|`boolean` - Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) + +|`force` +|`boolean` - True if the datafeed should be forcefully stopped. + +|`timeout` +|`string` - Controls the time to wait until a datafeed has stopped. Default to 20 seconds + +|=== + +=== ml.updateDatafeed +[source,js] +---- +client.ml.updateDatafeed([params] [, options] [, callback]) +---- +link:{ref}/ml-update-datafeed.html[Reference] +[cols=2*] +|=== +|`datafeed_id` or `datafeedId` +|`string` - The ID of the datafeed to update + +|`body` +|`object` - The datafeed update settings + +|=== + +=== ml.updateFilter +[source,js] +---- +client.ml.updateFilter([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`filter_id` or `filterId` +|`string` - The ID of the filter to update + +|`body` +|`object` - The filter update + +|=== + +=== ml.updateJob +[source,js] +---- +client.ml.updateJob([params] [, options] [, callback]) +---- +link:{ref}/ml-update-job.html[Reference] +[cols=2*] +|=== +|`job_id` or `jobId` +|`string` - The ID of the job to create + +|`body` +|`object` - The job update settings + +|=== + +=== ml.updateModelSnapshot +[source,js] +---- +client.ml.updateModelSnapshot([params] [, options] [, callback]) +---- +link:{ref}/ml-update-snapshot.html[Reference] +[cols=2*] +|=== +|`job_id` or `jobId` +|`string` - The ID of the job to fetch + +|`snapshot_id` or `snapshotId` +|`string` - The ID of the snapshot to update + +|`body` +|`object` - The model snapshot properties to update + +|=== + +=== ml.validate +[source,js] +---- +client.ml.validate([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`body` +|`object` - The job config + +|=== + +=== ml.validateDetector +[source,js] +---- +client.ml.validateDetector([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`body` +|`object` - The detector + +|=== + +=== monitoring.bulk +[source,js] +---- +client.monitoring.bulk([params] [, options] [, callback]) +---- +link:{ref}/es-monitoring.html[Reference] +[cols=2*] +|=== +|`type` +|`string` - Default document type for items which don't provide one + +|`system_id` or `systemId` +|`string` - Identifier of the monitored system + +|`system_api_version` or `systemApiVersion` +|`string` - API Version of the monitored system + +|`interval` +|`string` - Collection interval (e.g., '10s' or '10000ms') of the payload + +|`body` +|`object` - The operation definition and data (action-data pairs), separated by newlines + +|=== + +=== rollup.deleteJob +[source,js] +---- +client.rollup.deleteJob([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`id` +|`string` - The ID of the job to delete + +|=== + +=== rollup.getJobs +[source,js] +---- +client.rollup.getJobs([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`id` +|`string` - The ID of the job(s) to fetch. Accepts glob patterns, or left blank for all jobs + +|=== + +=== rollup.getRollupCaps +[source,js] +---- +client.rollup.getRollupCaps([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`id` +|`string` - The ID of the index to check rollup capabilities on, or left blank for all jobs + +|=== + +=== rollup.getRollupIndexCaps +[source,js] +---- +client.rollup.getRollupIndexCaps([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`index` +|`string` - The rollup index or index pattern to obtain rollup capabilities from. + +|=== + +=== rollup.putJob +[source,js] +---- +client.rollup.putJob([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`id` +|`string` - The ID of the job to create + +|`body` +|`object` - The job configuration + +|=== + +=== rollup.rollupSearch +[source,js] +---- +client.rollup.rollupSearch([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`index` +|`string, string[]` - The indices or index-pattern(s) (containing rollup or regular data) that should be searched + +|`type` +|`string` - The doc type inside the index + +|`typed_keys` or `typedKeys` +|`boolean` - Specify whether aggregation and suggester names should be prefixed by their respective types in the response + +|`rest_total_hits_as_int` or `restTotalHitsAsInt` +|`boolean` - Indicates whether hits.total should be rendered as an integer or an object in the rest search response + +|`body` +|`object` - The search request body + +|=== + +=== rollup.startJob +[source,js] +---- +client.rollup.startJob([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`id` +|`string` - The ID of the job to start + +|=== + +=== rollup.stopJob +[source,js] +---- +client.rollup.stopJob([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`id` +|`string` - The ID of the job to stop + +|`wait_for_completion` or `waitForCompletion` +|`boolean` - True if the API should block until the job has fully stopped, false if should be executed async. Defaults to false. + +|`timeout` +|`string` - Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s. + +|=== + +=== security.authenticate +[source,js] +---- +client.security.authenticate([params] [, options] [, callback]) +---- +link:{ref}/security-api-authenticate.html[Reference] + + +=== security.changePassword +[source,js] +---- +client.security.changePassword([params] [, options] [, callback]) +---- +link:{ref}/security-api-change-password.html[Reference] +[cols=2*] +|=== +|`username` +|`string` - The username of the user to change the password for + +|`refresh` +|`'true', 'false', 'wait_for'` - If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + +|`body` +|`object` - the new password for the user + +|=== + +=== security.clearCachedRealms +[source,js] +---- +client.security.clearCachedRealms([params] [, options] [, callback]) +---- +link:{ref}/security-api-clear-cache.html[Reference] +[cols=2*] +|=== +|`realms` +|`string, string[]` - Comma-separated list of realms to clear + +|`usernames` +|`string, string[]` - Comma-separated list of usernames to clear from the cache + +|=== + +=== security.clearCachedRoles +[source,js] +---- +client.security.clearCachedRoles([params] [, options] [, callback]) +---- +link:{ref}/security-api-clear-role-cache.html[Reference] +[cols=2*] +|=== +|`name` +|`string, string[]` - Role name + +|=== + +=== security.createApiKey +[source,js] +---- +client.security.createApiKey([params] [, options] [, callback]) +---- +link:{ref}/security-api-create-api-key.html[Reference] +[cols=2*] +|=== +|`refresh` +|`'true', 'false', 'wait_for'` - If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + +|`body` +|`object` - The api key request to create an API key + +|=== + +=== security.deletePrivileges +[source,js] +---- +client.security.deletePrivileges([params] [, options] [, callback]) +---- +link:TODO[Reference] +[cols=2*] +|=== +|`application` +|`string` - Application name + +|`name` +|`string` - Privilege name + +|`refresh` +|`'true', 'false', 'wait_for'` - If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + +|=== + +=== security.deleteRole +[source,js] +---- +client.security.deleteRole([params] [, options] [, callback]) +---- +link:{ref}/security-api-delete-role.html[Reference] +[cols=2*] +|=== +|`name` +|`string` - Role name + +|`refresh` +|`'true', 'false', 'wait_for'` - If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + +|=== + +=== security.deleteRoleMapping +[source,js] +---- +client.security.deleteRoleMapping([params] [, options] [, callback]) +---- +link:{ref}/security-api-delete-role-mapping.html[Reference] +[cols=2*] +|=== +|`name` +|`string` - Role-mapping name + +|`refresh` +|`'true', 'false', 'wait_for'` - If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + +|=== + +=== security.deleteUser +[source,js] +---- +client.security.deleteUser([params] [, options] [, callback]) +---- +link:{ref}/security-api-delete-user.html[Reference] +[cols=2*] +|=== +|`username` +|`string` - username + +|`refresh` +|`'true', 'false', 'wait_for'` - If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + +|=== + +=== security.disableUser +[source,js] +---- +client.security.disableUser([params] [, options] [, callback]) +---- +link:{ref}/security-api-disable-user.html[Reference] +[cols=2*] +|=== +|`username` +|`string` - The username of the user to disable + +|`refresh` +|`'true', 'false', 'wait_for'` - If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + +|=== + +=== security.enableUser +[source,js] +---- +client.security.enableUser([params] [, options] [, callback]) +---- +link:{ref}/security-api-enable-user.html[Reference] +[cols=2*] +|=== +|`username` +|`string` - The username of the user to enable + +|`refresh` +|`'true', 'false', 'wait_for'` - If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + +|=== + +=== security.getApiKey +[source,js] +---- +client.security.getApiKey([params] [, options] [, callback]) +---- +link:{ref}/security-api-get-api-key.html[Reference] +[cols=2*] +|=== +|`id` +|`string` - API key id of the API key to be retrieved + +|`name` +|`string` - API key name of the API key to be retrieved + +|`username` +|`string` - user name of the user who created this API key to be retrieved + +|`realm_name` or `realmName` +|`string` - realm name of the user who created this API key to be retrieved + +|=== + +=== security.getPrivileges +[source,js] +---- +client.security.getPrivileges([params] [, options] [, callback]) +---- +link:TODO[Reference] +[cols=2*] +|=== +|`application` +|`string` - Application name + +|`name` +|`string` - Privilege name + +|=== + +=== security.getRole +[source,js] +---- +client.security.getRole([params] [, options] [, callback]) +---- +link:{ref}/security-api-get-role.html[Reference] +[cols=2*] +|=== +|`name` +|`string` - Role name + +|=== + +=== security.getRoleMapping +[source,js] +---- +client.security.getRoleMapping([params] [, options] [, callback]) +---- +link:{ref}/security-api-get-role-mapping.html[Reference] +[cols=2*] +|=== +|`name` +|`string` - Role-Mapping name + +|=== + +=== security.getToken +[source,js] +---- +client.security.getToken([params] [, options] [, callback]) +---- +link:{ref}/security-api-get-token.html[Reference] +[cols=2*] +|=== +|`body` +|`object` - The token request to get + +|=== + +=== security.getUser +[source,js] +---- +client.security.getUser([params] [, options] [, callback]) +---- +link:{ref}/security-api-get-user.html[Reference] +[cols=2*] +|=== +|`username` +|`string, string[]` - A comma-separated list of usernames + +|=== + +=== security.getUserPrivileges +[source,js] +---- +client.security.getUserPrivileges([params] [, options] [, callback]) +---- +link:{ref}/security-api-get-privileges.html[Reference] + + +=== security.hasPrivileges +[source,js] +---- +client.security.hasPrivileges([params] [, options] [, callback]) +---- +link:{ref}/security-api-has-privileges.html[Reference] +[cols=2*] +|=== +|`user` +|`string` - Username + +|`body` +|`object` - The privileges to test + +|=== + +=== security.invalidateApiKey +[source,js] +---- +client.security.invalidateApiKey([params] [, options] [, callback]) +---- +link:{ref}/security-api-invalidate-api-key.html[Reference] +[cols=2*] +|=== +|`body` +|`object` - The api key request to invalidate API key(s) + +|=== + +=== security.invalidateToken +[source,js] +---- +client.security.invalidateToken([params] [, options] [, callback]) +---- +link:{ref}/security-api-invalidate-token.html[Reference] +[cols=2*] +|=== +|`body` +|`object` - The token to invalidate + +|=== + +=== security.putPrivileges +[source,js] +---- +client.security.putPrivileges([params] [, options] [, callback]) +---- +link:TODO[Reference] +[cols=2*] +|=== +|`refresh` +|`'true', 'false', 'wait_for'` - If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + +|`body` +|`object` - The privilege(s) to add + +|=== + +=== security.putRole +[source,js] +---- +client.security.putRole([params] [, options] [, callback]) +---- +link:{ref}/security-api-put-role.html[Reference] +[cols=2*] +|=== +|`name` +|`string` - Role name + +|`refresh` +|`'true', 'false', 'wait_for'` - If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + +|`body` +|`object` - The role to add + +|=== + +=== security.putRoleMapping +[source,js] +---- +client.security.putRoleMapping([params] [, options] [, callback]) +---- +link:{ref}/security-api-put-role-mapping.html[Reference] +[cols=2*] +|=== +|`name` +|`string` - Role-mapping name + +|`refresh` +|`'true', 'false', 'wait_for'` - If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + +|`body` +|`object` - The role mapping to add + +|=== + +=== security.putUser +[source,js] +---- +client.security.putUser([params] [, options] [, callback]) +---- +link:{ref}/security-api-put-user.html[Reference] +[cols=2*] +|=== +|`username` +|`string` - The username of the User + +|`refresh` +|`'true', 'false', 'wait_for'` - If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + +|`body` +|`object` - The user to add + +|=== + +=== sql.clearCursor +[source,js] +---- +client.sql.clearCursor([params] [, options] [, callback]) +---- +link:Clear SQL cursor[Reference] +[cols=2*] +|=== +|`body` +|`object` - Specify the cursor value in the `cursor` element to clean the cursor. + +|=== + +=== sql.query +[source,js] +---- +client.sql.query([params] [, options] [, callback]) +---- +link:Execute SQL[Reference] +[cols=2*] +|=== +|`format` +|`string` - a short version of the Accept header, e.g. json, yaml + +|`body` +|`object` - Use the `query` element to start a query. Use the `cursor` element to continue a query. + +|=== + +=== sql.translate +[source,js] +---- +client.sql.translate([params] [, options] [, callback]) +---- +link:Translate SQL into Elasticsearch queries[Reference] +[cols=2*] +|=== +|`body` +|`object` - Specify the query in the `query` element. + +|=== + +=== ssl.certificates +[source,js] +---- +client.ssl.certificates([params] [, options] [, callback]) +---- +link:{ref}/security-api-ssl.html[Reference] + + +=== watcher.ackWatch +[source,js] +---- +client.watcher.ackWatch([params] [, options] [, callback]) +---- +link:{ref}/watcher-api-ack-watch.html[Reference] +[cols=2*] +|=== +|`watch_id` or `watchId` +|`string` - Watch ID + +|`action_id` or `actionId` +|`string, string[]` - A comma-separated list of the action ids to be acked + +|=== + +=== watcher.activateWatch +[source,js] +---- +client.watcher.activateWatch([params] [, options] [, callback]) +---- +link:{ref}/watcher-api-activate-watch.html[Reference] +[cols=2*] +|=== +|`watch_id` or `watchId` +|`string` - Watch ID + +|=== + +=== watcher.deactivateWatch +[source,js] +---- +client.watcher.deactivateWatch([params] [, options] [, callback]) +---- +link:{ref}/watcher-api-deactivate-watch.html[Reference] +[cols=2*] +|=== +|`watch_id` or `watchId` +|`string` - Watch ID + +|=== + +=== watcher.deleteWatch +[source,js] +---- +client.watcher.deleteWatch([params] [, options] [, callback]) +---- +link:{ref}/watcher-api-delete-watch.html[Reference] +[cols=2*] +|=== +|`id` +|`string` - Watch ID + +|=== + +=== watcher.executeWatch +[source,js] +---- +client.watcher.executeWatch([params] [, options] [, callback]) +---- +link:{ref}/watcher-api-execute-watch.html[Reference] +[cols=2*] +|=== +|`id` +|`string` - Watch ID + +|`debug` +|`boolean` - indicates whether the watch should execute in debug mode + +|`body` +|`object` - Execution control + +|=== + +=== watcher.getWatch +[source,js] +---- +client.watcher.getWatch([params] [, options] [, callback]) +---- +link:{ref}/watcher-api-get-watch.html[Reference] +[cols=2*] +|=== +|`id` +|`string` - Watch ID + +|=== + +=== watcher.putWatch +[source,js] +---- +client.watcher.putWatch([params] [, options] [, callback]) +---- +link:{ref}/watcher-api-put-watch.html[Reference] +[cols=2*] +|=== +|`id` +|`string` - Watch ID + +|`active` +|`boolean` - Specify whether the watch is in/active by default + +|`version` +|`number` - Explicit version number for concurrency control + +|`if_seq_no` or `ifSeqNo` +|`number` - only update the watch if the last operation that has changed the watch has the specified sequence number + +|`if_primary_term` or `ifPrimaryTerm` +|`number` - only update the watch if the last operation that has changed the watch has the specified primary term + +|`body` +|`object` - The watch + +|=== + +=== watcher.start +[source,js] +---- +client.watcher.start([params] [, options] [, callback]) +---- +link:{ref}/watcher-api-start.html[Reference] + + +=== watcher.stats +[source,js] +---- +client.watcher.stats([params] [, options] [, callback]) +---- +link:{ref}/watcher-api-stats.html[Reference] +[cols=2*] +|=== +|`metric` +|`string, string[]` - Controls what additional stat metrics should be include in the response + +|`metric` +|`string, string[]` - Controls what additional stat metrics should be include in the response + +|`emit_stacktraces` or `emitStacktraces` +|`boolean` - Emits stack traces of currently running watches + +|=== + +=== watcher.stop +[source,js] +---- +client.watcher.stop([params] [, options] [, callback]) +---- +link:{ref}/watcher-api-stop.html[Reference] + + +=== xpack.info +[source,js] +---- +client.xpack.info([params] [, options] [, callback]) +---- +link:{ref}/info-api.html[Reference] +[cols=2*] +|=== +|`categories` +|`string, string[]` - Comma-separated list of info categories. Can be any of: build, license, features + +|=== + +=== xpack.usage +[source,js] +---- +client.xpack.usage([params] [, options] [, callback]) +---- +link:Retrieve information about xpack features usage[Reference] +[cols=2*] +|=== +|`master_timeout` or `masterTimeout` +|`string` - Specify timeout for watch write operation + +|=== +>>>>>>> c92b156... Docs: Fix the API reference (#799) diff --git a/scripts/utils/generateDocs.js b/scripts/utils/generateDocs.js index fc0dd8797..c9d531f20 100644 --- a/scripts/utils/generateDocs.js +++ b/scripts/utils/generateDocs.js @@ -43,7 +43,8 @@ function commonParameters (spec) { var doc = dedent` === Common parameters Parameters that are accepted by all API endpoints. - https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html + + link:{ref}/common-options.html[Reference] [cols=2*] |===\n` Object.keys(spec.params).forEach(key => { @@ -69,7 +70,7 @@ function commonParameters (spec) { function generateApiDoc (spec) { const name = Object.keys(spec)[0] - const documentationUrl = fixLink(spec[name].documentation) + const documentationUrl = fixLink(name, spec[name].documentation) const params = [] // url params const urlParts = spec[name].url.parts @@ -113,8 +114,10 @@ function generateApiDoc (spec) { [source,js] ---- client.${camelify(name)}([params] [, options] [, callback]) - ---- - ${documentationUrl || ''}\n` + ----\n` + if (documentationUrl) { + doc += `link:${documentationUrl}[Reference]\n` + } if (params.length !== 0) { doc += dedent`[cols=2*] @@ -140,13 +143,29 @@ function generateApiDoc (spec) { return doc } +const LINK_OVERRIDES = { + 'license.delete': '{ref}/delete-license.html', + 'license.get': '{ref}/get-license.html', + 'license.get_basic_status': '{ref}/get-basic-status.html', + 'license.get_trial_status': '{ref}/get-trial-status.html', + 'license.post': '{ref}/update-license.html', + 'license.post_start_basic': '{ref}/start-basic.html', + 'license.post_start_trial': '{ref}/start-trial.html', + 'migration.deprecations': '{ref}/migration-api-deprecation.html', + 'monitoring.bulk': '{ref}/es-monitoring.html' +} // Fixes bad urls in the JSON spec -function fixLink (str) { +function fixLink (name, str) { + const override = LINK_OVERRIDES[name] + if (override) return override if (!str) return '' - if (str.includes('/5.x/')) { - // fixes wrong url in ES5 - str = str.replace(/5\.x/, '5.6') - } + /* Replace references to the guide with the attribute {ref} because + * the json files in the Elasticsearch repo are a bit of a mess. */ + str = str.replace(/^.+guide\/en\/elasticsearch\/reference\/[^/]+\/([^./]*\.html)$/, '{ref}/$1') + str = str.replace(/frozen\.html/, 'freeze-index-api.html') + str = str.replace(/ml-file-structure\.html/, 'ml-find-file-structure.html') + str = str.replace(/security-api-get-user-privileges\.html/, 'security-api-get-privileges.html') + str = str.replace(/security-api-get-user-privileges\.html/, 'security-api-get-privileges.html') return str }