From af544e8a55357dabdb9a113bd4d6702c05a84a5e 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 | 609 ++++++++++++++++++++-------------- scripts/utils/generateDocs.js | 37 ++- 3 files changed, 387 insertions(+), 262 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 30c811b46..e01fd1cec 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,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.h ---- client.bulk([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html +link:{ref}/docs-bulk.html[Reference] [cols=2*] |=== |`index` @@ -81,7 +82,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html ---- client.cat.aliases([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html +link:{ref}/cat-alias.html[Reference] [cols=2*] |=== |`name` @@ -115,7 +116,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html ---- client.cat.allocation([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html +link:{ref}/cat-allocation.html[Reference] [cols=2*] |=== |`node_id` or `nodeId` @@ -152,7 +153,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.htm ---- client.cat.count([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html +link:{ref}/cat-count.html[Reference] [cols=2*] |=== |`index` @@ -186,7 +187,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html ---- client.cat.fielddata([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html +link:{ref}/cat-fielddata.html[Reference] [cols=2*] |=== |`fields` @@ -226,7 +227,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html ---- client.cat.health([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html +link:{ref}/cat-health.html[Reference] [cols=2*] |=== |`format` @@ -261,7 +262,7 @@ _Default:_ `true` ---- client.cat.help([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html +link:{ref}/cat.html[Reference] [cols=2*] |=== |`help` @@ -277,7 +278,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html ---- client.cat.indices([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html +link:{ref}/cat-indices.html[Reference] [cols=2*] |=== |`index` @@ -320,7 +321,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html ---- client.cat.master([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html +link:{ref}/cat-master.html[Reference] [cols=2*] |=== |`format` @@ -351,7 +352,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html ---- client.cat.nodeattrs([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html +link:{ref}/cat-nodeattrs.html[Reference] [cols=2*] |=== |`format` @@ -382,7 +383,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html ---- client.cat.nodes([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html +link:{ref}/cat-nodes.html[Reference] [cols=2*] |=== |`format` @@ -416,7 +417,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html ---- client.cat.pendingTasks([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html +link:{ref}/cat-pending-tasks.html[Reference] [cols=2*] |=== |`format` @@ -447,7 +448,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks. ---- client.cat.plugins([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html +link:{ref}/cat-plugins.html[Reference] [cols=2*] |=== |`format` @@ -478,7 +479,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html ---- client.cat.recovery([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html +link:{ref}/cat-recovery.html[Reference] [cols=2*] |=== |`index` @@ -512,7 +513,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html ---- client.cat.repositories([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html +link:{ref}/cat-repositories.html[Reference] [cols=2*] |=== |`format` @@ -543,7 +544,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.h ---- client.cat.segments([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html +link:{ref}/cat-segments.html[Reference] [cols=2*] |=== |`index` @@ -574,7 +575,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html ---- client.cat.shards([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html +link:{ref}/cat-shards.html[Reference] [cols=2*] |=== |`index` @@ -611,7 +612,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html ---- client.cat.snapshots([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html +link:{ref}/cat-snapshots.html[Reference] [cols=2*] |=== |`repository` @@ -645,7 +646,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html ---- client.cat.tasks([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html +link:{ref}/tasks.html[Reference] [cols=2*] |=== |`format` @@ -682,7 +683,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html ---- client.cat.templates([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html +link:{ref}/cat-templates.html[Reference] [cols=2*] |=== |`name` @@ -716,7 +717,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html ---- client.cat.threadPool([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html +link:{ref}/cat-thread-pool.html[Reference] [cols=2*] |=== |`thread_pool_patterns` or `threadPoolPatterns` @@ -753,7 +754,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.ht ---- client.clearScroll([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html +link:{ref}/search-request-scroll.html[Reference] [cols=2*] |=== |`scroll_id` or `scrollId` @@ -769,7 +770,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scr ---- client.cluster.allocationExplain([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html +link:{ref}/cluster-allocation-explain.html[Reference] [cols=2*] |=== |`include_yes_decisions` or `includeYesDecisions` @@ -788,7 +789,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation ---- client.cluster.getSettings([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html +link:{ref}/cluster-update-settings.html[Reference] [cols=2*] |=== |`flat_settings` or `flatSettings` @@ -810,7 +811,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-set ---- client.cluster.health([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html +link:{ref}/cluster-health.html[Reference] [cols=2*] |=== |`index` @@ -854,7 +855,7 @@ _Default:_ `cluster` ---- client.cluster.pendingTasks([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html +link:{ref}/cluster-pending.html[Reference] [cols=2*] |=== |`local` @@ -870,7 +871,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.ht ---- client.cluster.putSettings([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html +link:{ref}/cluster-update-settings.html[Reference] [cols=2*] |=== |`flat_settings` or `flatSettings` @@ -892,7 +893,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-set ---- client.cluster.remoteInfo([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html +link:{ref}/cluster-remote-info.html[Reference] === cluster.reroute @@ -900,7 +901,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-inf ---- client.cluster.reroute([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html +link:{ref}/cluster-reroute.html[Reference] [cols=2*] |=== |`dry_run` or `dryRun` @@ -931,7 +932,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.ht ---- client.cluster.state([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html +link:{ref}/cluster-state.html[Reference] [cols=2*] |=== |`index` @@ -972,7 +973,7 @@ _Default:_ `open` ---- client.cluster.stats([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html +link:{ref}/cluster-stats.html[Reference] [cols=2*] |=== |`node_id` or `nodeId` @@ -991,7 +992,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html ---- client.count([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html +link:{ref}/search-count.html[Reference] [cols=2*] |=== |`index` @@ -1054,7 +1055,7 @@ _Default:_ `OR` ---- client.create([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html +link:{ref}/docs-index_.html[Reference] [cols=2*] |=== |`id` @@ -1100,7 +1101,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html ---- client.delete([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html +link:{ref}/docs-delete.html[Reference] [cols=2*] |=== |`id` @@ -1146,7 +1147,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html ---- client.deleteByQuery([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html +link:{ref}/docs-delete-by-query.html[Reference] [cols=2*] |=== |`index` @@ -1267,7 +1268,7 @@ _Default:_ `1` ---- client.deleteByQueryRethrottle([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html +link:{ref}/docs-delete-by-query.html[Reference] [cols=2*] |=== |`task_id` or `taskId` @@ -1283,7 +1284,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-q ---- client.deleteScript([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html +link:{ref}/modules-scripting.html[Reference] [cols=2*] |=== |`id` @@ -1302,7 +1303,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting. ---- client.exists([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html +link:{ref}/docs-get.html[Reference] [cols=2*] |=== |`id` @@ -1354,7 +1355,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/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` @@ -1403,7 +1404,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html ---- client.explain([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html +link:{ref}/search-explain.html[Reference] [cols=2*] |=== |`id` @@ -1465,7 +1466,7 @@ _Default:_ `OR` ---- client.fieldCaps([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html +link:{ref}/search-field-caps.html[Reference] [cols=2*] |=== |`index` @@ -1491,7 +1492,7 @@ _Default:_ `open` ---- client.get([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html +link:{ref}/docs-get.html[Reference] [cols=2*] |=== |`id` @@ -1549,7 +1550,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html ---- client.getScript([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html +link:{ref}/modules-scripting.html[Reference] [cols=2*] |=== |`id` @@ -1565,7 +1566,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting. ---- client.getSource([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html +link:{ref}/docs-get.html[Reference] [cols=2*] |=== |`id` @@ -1614,7 +1615,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html ---- client.index([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html +link:{ref}/docs-index_.html[Reference] [cols=2*] |=== |`id` @@ -1670,7 +1671,7 @@ _Default:_ `index` ---- client.indices.analyze([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html +link:{ref}/indices-analyze.html[Reference] [cols=2*] |=== |`index` @@ -1689,7 +1690,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.ht ---- client.indices.clearCache([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html +link:{ref}/indices-clearcache.html[Reference] [cols=2*] |=== |`index` @@ -1727,7 +1728,7 @@ _Default:_ `open` ---- client.indices.close([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html +link:{ref}/indices-open-close.html[Reference] [cols=2*] |=== |`index` @@ -1756,7 +1757,7 @@ _Default:_ `open` ---- client.indices.create([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html +link:{ref}/indices-create-index.html[Reference] [cols=2*] |=== |`index` @@ -1784,7 +1785,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-ind ---- client.indices.delete([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html +link:{ref}/indices-delete-index.html[Reference] [cols=2*] |=== |`index` @@ -1813,7 +1814,7 @@ _Default:_ `open` ---- client.indices.deleteAlias([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html +link:{ref}/indices-aliases.html[Reference] [cols=2*] |=== |`index` @@ -1835,7 +1836,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.ht ---- client.indices.deleteTemplate([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html +link:{ref}/indices-templates.html[Reference] [cols=2*] |=== |`name` @@ -1854,7 +1855,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates. ---- client.indices.exists([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html +link:{ref}/indices-exists.html[Reference] [cols=2*] |=== |`index` @@ -1886,7 +1887,7 @@ _Default:_ `open` ---- client.indices.existsAlias([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html +link:{ref}/indices-aliases.html[Reference] [cols=2*] |=== |`index` @@ -1915,7 +1916,7 @@ _Default:_ `all` ---- client.indices.existsTemplate([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html +link:{ref}/indices-templates.html[Reference] [cols=2*] |=== |`name` @@ -1937,7 +1938,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates. ---- client.indices.existsType([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html +link:{ref}/indices-types-exists.html[Reference] [cols=2*] |=== |`index` @@ -1966,7 +1967,7 @@ _Default:_ `open` ---- client.indices.flush([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html +link:{ref}/indices-flush.html[Reference] [cols=2*] |=== |`index` @@ -1995,7 +1996,7 @@ _Default:_ `open` ---- client.indices.flushSynced([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-synced-flush.html +link:{ref}/indices-synced-flush.html[Reference] [cols=2*] |=== |`index` @@ -2018,7 +2019,7 @@ _Default:_ `open` ---- client.indices.forcemerge([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html +link:{ref}/indices-forcemerge.html[Reference] [cols=2*] |=== |`index` @@ -2050,7 +2051,7 @@ _Default:_ `open` ---- client.indices.get([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html +link:{ref}/indices-get-index.html[Reference] [cols=2*] |=== |`index` @@ -2088,7 +2089,7 @@ _Default:_ `open` ---- client.indices.getAlias([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html +link:{ref}/indices-aliases.html[Reference] [cols=2*] |=== |`index` @@ -2117,7 +2118,7 @@ _Default:_ `all` ---- client.indices.getFieldMapping([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html +link:{ref}/indices-get-field-mapping.html[Reference] [cols=2*] |=== |`index` @@ -2155,7 +2156,7 @@ _Default:_ `open` ---- client.indices.getMapping([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html +link:{ref}/indices-get-mapping.html[Reference] [cols=2*] |=== |`index` @@ -2190,7 +2191,7 @@ _Default:_ `open` ---- client.indices.getSettings([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html +link:{ref}/indices-get-settings.html[Reference] [cols=2*] |=== |`index` @@ -2228,7 +2229,7 @@ _Default:_ `open,closed` ---- client.indices.getTemplate([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html +link:{ref}/indices-templates.html[Reference] [cols=2*] |=== |`name` @@ -2253,7 +2254,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates. ---- client.indices.getUpgrade([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html +link:{ref}/indices-upgrade.html[Reference] [cols=2*] |=== |`index` @@ -2276,7 +2277,7 @@ _Default:_ `open` ---- client.indices.open([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html +link:{ref}/indices-open-close.html[Reference] [cols=2*] |=== |`index` @@ -2308,7 +2309,7 @@ _Default:_ `closed` ---- client.indices.putAlias([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html +link:{ref}/indices-aliases.html[Reference] [cols=2*] |=== |`index` @@ -2333,7 +2334,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.ht ---- client.indices.putMapping([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html +link:{ref}/indices-put-mapping.html[Reference] [cols=2*] |=== |`index` @@ -2371,7 +2372,7 @@ _Default:_ `open` ---- client.indices.putSettings([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html +link:{ref}/indices-update-settings.html[Reference] [cols=2*] |=== |`index` @@ -2409,7 +2410,7 @@ _Default:_ `open` ---- client.indices.putTemplate([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html +link:{ref}/indices-templates.html[Reference] [cols=2*] |=== |`name` @@ -2443,7 +2444,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates. ---- client.indices.recovery([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html +link:{ref}/indices-recovery.html[Reference] [cols=2*] |=== |`index` @@ -2462,7 +2463,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.h ---- client.indices.refresh([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html +link:{ref}/indices-refresh.html[Reference] [cols=2*] |=== |`index` @@ -2485,7 +2486,7 @@ _Default:_ `open` ---- client.indices.rollover([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-index.html +link:{ref}/indices-rollover-index.html[Reference] [cols=2*] |=== |`alias` @@ -2519,7 +2520,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-i ---- client.indices.segments([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html +link:{ref}/indices-segments.html[Reference] [cols=2*] |=== |`index` @@ -2545,7 +2546,7 @@ _Default:_ `open` ---- client.indices.shardStores([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html +link:{ref}/indices-shards-stores.html[Reference] [cols=2*] |=== |`index` @@ -2571,7 +2572,7 @@ _Default:_ `open` ---- client.indices.shrink([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shrink-index.html +link:{ref}/indices-shrink-index.html[Reference] [cols=2*] |=== |`index` @@ -2602,7 +2603,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shrink-ind ---- client.indices.split([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-split-index.html +link:{ref}/indices-split-index.html[Reference] [cols=2*] |=== |`index` @@ -2633,7 +2634,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-split-inde ---- client.indices.stats([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html +link:{ref}/indices-stats.html[Reference] [cols=2*] |=== |`index` @@ -2671,7 +2672,7 @@ _Default:_ `indices` ---- client.indices.updateAliases([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html +link:{ref}/indices-aliases.html[Reference] [cols=2*] |=== |`timeout` @@ -2690,7 +2691,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.ht ---- client.indices.upgrade([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html +link:{ref}/indices-upgrade.html[Reference] [cols=2*] |=== |`index` @@ -2719,7 +2720,7 @@ _Default:_ `open` ---- client.indices.validateQuery([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html +link:{ref}/search-validate.html[Reference] [cols=2*] |=== |`index` @@ -2776,7 +2777,7 @@ _Default:_ `OR` ---- client.info([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/ +link:http://www.elastic.co/guide/[Reference] === ingest.deletePipeline @@ -2784,7 +2785,7 @@ http://www.elastic.co/guide/ ---- client.ingest.deletePipeline([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] [cols=2*] |=== |`id` @@ -2803,7 +2804,7 @@ https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html ---- client.ingest.getPipeline([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] [cols=2*] |=== |`id` @@ -2819,7 +2820,7 @@ https://www.elastic.co/guide/en/elasticsearch/plugins/master/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 @@ -2827,7 +2828,7 @@ https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html ---- client.ingest.putPipeline([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] [cols=2*] |=== |`id` @@ -2849,7 +2850,7 @@ https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html ---- client.ingest.simulate([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] [cols=2*] |=== |`id` @@ -2868,7 +2869,7 @@ https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html ---- client.mget([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html +link:{ref}/docs-multi-get.html[Reference] [cols=2*] |=== |`index` @@ -2911,7 +2912,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.htm ---- client.msearch([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html +link:{ref}/search-multi-search.html[Reference] [cols=2*] |=== |`index` @@ -2954,7 +2955,7 @@ _Default:_ `true` ---- client.msearchTemplate([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html +link:{ref}/search-multi-search.html[Reference] [cols=2*] |=== |`index` @@ -2989,7 +2990,7 @@ _Default:_ `true` ---- client.mtermvectors([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html +link:{ref}/docs-multi-termvectors.html[Reference] [cols=2*] |=== |`index` @@ -3051,7 +3052,7 @@ _Default:_ `true` ---- client.nodes.hotThreads([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html +link:{ref}/cluster-nodes-hot-threads.html[Reference] [cols=2*] |=== |`node_id` or `nodeId` @@ -3082,7 +3083,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot- ---- client.nodes.info([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html +link:{ref}/cluster-nodes-info.html[Reference] [cols=2*] |=== |`node_id` or `nodeId` @@ -3104,7 +3105,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info ---- client.nodes.reloadSecureSettings([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings +link:https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings[Reference] [cols=2*] |=== |`node_id` or `nodeId` @@ -3120,7 +3121,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.h ---- client.nodes.stats([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html +link:{ref}/cluster-nodes-stats.html[Reference] [cols=2*] |=== |`metric` @@ -3164,7 +3165,7 @@ _Default:_ `node` ---- client.nodes.usage([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-usage.html +link:{ref}/cluster-nodes-usage.html[Reference] [cols=2*] |=== |`metric` @@ -3183,7 +3184,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-usag ---- client.ping([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/ +link:http://www.elastic.co/guide/[Reference] === putScript @@ -3191,7 +3192,7 @@ http://www.elastic.co/guide/ ---- client.putScript([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html +link:{ref}/modules-scripting.html[Reference] [cols=2*] |=== |`id` @@ -3219,7 +3220,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting. ---- client.rankEval([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html +link:{ref}/search-rank-eval.html[Reference] [cols=2*] |=== |`index` @@ -3245,7 +3246,7 @@ _Default:_ `open` ---- client.reindex([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html +link:{ref}/docs-reindex.html[Reference] [cols=2*] |=== |`refresh` @@ -3283,7 +3284,7 @@ _Default:_ `1` ---- client.reindexRethrottle([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html +link:{ref}/docs-reindex.html[Reference] [cols=2*] |=== |`task_id` or `taskId` @@ -3299,7 +3300,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html ---- client.renderSearchTemplate([params] [, options] [, callback]) ---- -http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html +link:{ref}/search-template.html[Reference] [cols=2*] |=== |`id` @@ -3310,12 +3311,27 @@ http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-temp |=== +<<<<<<< HEAD +======= +=== scriptsPainlessContext +[source,js] +---- +client.scriptsPainlessContext([params] [, options] [, callback]) +---- +[cols=2*] +|=== +|`context` +|`string` - Select a specific context to retrieve API information about + +|=== + +>>>>>>> c92b156... Docs: Fix the API reference (#799) === scriptsPainlessExecute [source,js] ---- client.scriptsPainlessExecute([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html +link:https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html[Reference] [cols=2*] |=== |`body` @@ -3328,7 +3344,7 @@ https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-a ---- client.scroll([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html +link:{ref}/search-request-scroll.html[Reference] [cols=2*] |=== |`scroll_id` or `scrollId` @@ -3353,7 +3369,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scr ---- client.search([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html +link:{ref}/search-search.html[Reference] [cols=2*] |=== |`index` @@ -3506,7 +3522,7 @@ _Default:_ `128` ---- client.searchShards([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html +link:{ref}/search-shards.html[Reference] [cols=2*] |=== |`index` @@ -3538,7 +3554,7 @@ _Default:_ `open` ---- client.searchTemplate([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html +link:{ref}/search-template.html[Reference] [cols=2*] |=== |`index` @@ -3598,7 +3614,7 @@ _Default:_ `true` ---- client.snapshot.create([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html +link:{ref}/modules-snapshots.html[Reference] [cols=2*] |=== |`repository` @@ -3623,7 +3639,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots. ---- client.snapshot.createRepository([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html +link:{ref}/modules-snapshots.html[Reference] [cols=2*] |=== |`repository` @@ -3648,7 +3664,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots. ---- client.snapshot.delete([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html +link:{ref}/modules-snapshots.html[Reference] [cols=2*] |=== |`repository` @@ -3667,7 +3683,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots. ---- client.snapshot.deleteRepository([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html +link:{ref}/modules-snapshots.html[Reference] [cols=2*] |=== |`repository` @@ -3686,7 +3702,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots. ---- client.snapshot.get([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html +link:{ref}/modules-snapshots.html[Reference] [cols=2*] |=== |`repository` @@ -3711,7 +3727,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots. ---- client.snapshot.getRepository([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html +link:{ref}/modules-snapshots.html[Reference] [cols=2*] |=== |`repository` @@ -3730,7 +3746,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots. ---- client.snapshot.restore([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html +link:{ref}/modules-snapshots.html[Reference] [cols=2*] |=== |`repository` @@ -3755,7 +3771,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots. ---- client.snapshot.status([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html +link:{ref}/modules-snapshots.html[Reference] [cols=2*] |=== |`repository` @@ -3777,7 +3793,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots. ---- client.snapshot.verifyRepository([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html +link:{ref}/modules-snapshots.html[Reference] [cols=2*] |=== |`repository` @@ -3796,7 +3812,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots. ---- client.tasks.cancel([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html +link:{ref}/tasks.html[Reference] [cols=2*] |=== |`task_id` or `taskId` @@ -3818,7 +3834,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html ---- client.tasks.get([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html +link:{ref}/tasks.html[Reference] [cols=2*] |=== |`task_id` or `taskId` @@ -3837,7 +3853,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html ---- client.tasks.list([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html +link:{ref}/tasks.html[Reference] [cols=2*] |=== |`nodes` @@ -3869,7 +3885,7 @@ _Default:_ `nodes` ---- client.termvectors([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html +link:{ref}/docs-termvectors.html[Reference] [cols=2*] |=== |`index` @@ -3931,7 +3947,7 @@ _Default:_ `true` ---- client.update([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html +link:{ref}/docs-update.html[Reference] [cols=2*] |=== |`id` @@ -3989,7 +4005,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html ---- client.updateByQuery([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html +link:{ref}/docs-update-by-query.html[Reference] [cols=2*] |=== |`index` @@ -4116,7 +4132,7 @@ _Default:_ `1` ---- client.updateByQueryRethrottle([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html +link:{ref}/docs-update-by-query.html[Reference] [cols=2*] |=== |`task_id` or `taskId` @@ -4132,7 +4148,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-q ---- client.ccr.deleteAutoFollowPattern([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html +link:{ref}/ccr-delete-auto-follow-pattern.html[Reference] [cols=2*] |=== |`name` @@ -4145,7 +4161,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto- ---- client.ccr.follow([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html +link:{ref}/ccr-put-follow.html[Reference] [cols=2*] |=== |`index` @@ -4165,7 +4181,7 @@ _Default:_ `0` ---- client.ccr.followInfo([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html +link:{ref}/ccr-get-follow-info.html[Reference] [cols=2*] |=== |`index` @@ -4178,7 +4194,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-i ---- client.ccr.followStats([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html +link:{ref}/ccr-get-follow-stats.html[Reference] [cols=2*] |=== |`index` @@ -4191,7 +4207,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-s ---- client.ccr.forgetFollower([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current +link:http://www.elastic.co/guide/en/elasticsearch/reference/current[Reference] [cols=2*] |=== |`index` @@ -4207,7 +4223,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current ---- client.ccr.getAutoFollowPattern([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-auto-follow-pattern.html +link:{ref}/ccr-get-auto-follow-pattern.html[Reference] [cols=2*] |=== |`name` @@ -4220,7 +4236,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-auto-fol ---- client.ccr.pauseFollow([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-pause-follow.html +link:{ref}/ccr-post-pause-follow.html[Reference] [cols=2*] |=== |`index` @@ -4233,7 +4249,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-pause-f ---- client.ccr.putAutoFollowPattern([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-auto-follow-pattern.html +link:{ref}/ccr-put-auto-follow-pattern.html[Reference] [cols=2*] |=== |`name` @@ -4249,7 +4265,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-auto-fol ---- client.ccr.resumeFollow([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-resume-follow.html +link:{ref}/ccr-post-resume-follow.html[Reference] [cols=2*] |=== |`index` @@ -4265,7 +4281,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-resume- ---- client.ccr.stats([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.html +link:{ref}/ccr-get-stats.html[Reference] === ccr.unfollow @@ -4273,7 +4289,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.ht ---- client.ccr.unfollow([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current +link:http://www.elastic.co/guide/en/elasticsearch/reference/current[Reference] [cols=2*] |=== |`index` @@ -4281,12 +4297,124 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current |=== +<<<<<<< HEAD +======= +=== 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 + +|=== + +>>>>>>> c92b156... Docs: Fix the API reference (#799) === graph.explore [source,js] ---- client.graph.explore([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html +link:{ref}/graph-explore-api.html[Reference] [cols=2*] |=== |`index` @@ -4311,7 +4439,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-ap ---- client.ilm.deleteLifecycle([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html +link:{ref}/ilm-delete-lifecycle.html[Reference] [cols=2*] |=== |`policy` @@ -4324,7 +4452,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifec ---- client.ilm.explainLifecycle([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html +link:{ref}/ilm-explain-lifecycle.html[Reference] [cols=2*] |=== |`index` @@ -4337,7 +4465,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-life ---- client.ilm.getLifecycle([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html +link:{ref}/ilm-get-lifecycle.html[Reference] [cols=2*] |=== |`policy` @@ -4350,7 +4478,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycl ---- client.ilm.getStatus([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html +link:{ref}/ilm-get-status.html[Reference] === ilm.moveToStep @@ -4358,7 +4486,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.h ---- client.ilm.moveToStep([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html +link:{ref}/ilm-move-to-step.html[Reference] [cols=2*] |=== |`index` @@ -4374,7 +4502,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step ---- client.ilm.putLifecycle([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html +link:{ref}/ilm-put-lifecycle.html[Reference] [cols=2*] |=== |`policy` @@ -4390,7 +4518,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycl ---- client.ilm.removePolicy([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html +link:{ref}/ilm-remove-policy.html[Reference] [cols=2*] |=== |`index` @@ -4403,7 +4531,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-polic ---- client.ilm.retry([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html +link:{ref}/ilm-retry-policy.html[Reference] [cols=2*] |=== |`index` @@ -4416,7 +4544,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy ---- client.ilm.start([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html +link:{ref}/ilm-start.html[Reference] === ilm.stop @@ -4424,7 +4552,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html ---- client.ilm.stop([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html +link:{ref}/ilm-stop.html[Reference] === indices.freeze @@ -4432,7 +4560,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html ---- client.indices.freeze([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/frozen.html +link:{ref}/freeze-index-api.html[Reference] [cols=2*] |=== |`index` @@ -4464,7 +4592,7 @@ _Default:_ `closed` ---- client.indices.unfreeze([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/frozen.html +link:{ref}/freeze-index-api.html[Reference] [cols=2*] |=== |`index` @@ -4496,7 +4624,7 @@ _Default:_ `closed` ---- client.license.delete([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/x-pack/current/license-management.html +link:{ref}/delete-license.html[Reference] === license.get @@ -4504,7 +4632,7 @@ https://www.elastic.co/guide/en/x-pack/current/license-management.html ---- client.license.get([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/x-pack/current/license-management.html +link:{ref}/get-license.html[Reference] [cols=2*] |=== |`local` @@ -4517,7 +4645,7 @@ https://www.elastic.co/guide/en/x-pack/current/license-management.html ---- client.license.getBasicStatus([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/x-pack/current/license-management.html +link:{ref}/get-basic-status.html[Reference] === license.getTrialStatus @@ -4525,7 +4653,7 @@ https://www.elastic.co/guide/en/x-pack/current/license-management.html ---- client.license.getTrialStatus([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/x-pack/current/license-management.html +link:{ref}/get-trial-status.html[Reference] === license.post @@ -4533,7 +4661,7 @@ https://www.elastic.co/guide/en/x-pack/current/license-management.html ---- client.license.post([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/x-pack/current/license-management.html +link:{ref}/update-license.html[Reference] [cols=2*] |=== |`acknowledge` @@ -4549,7 +4677,7 @@ https://www.elastic.co/guide/en/x-pack/current/license-management.html ---- client.license.postStartBasic([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/x-pack/current/license-management.html +link:{ref}/start-basic.html[Reference] [cols=2*] |=== |`acknowledge` @@ -4562,7 +4690,7 @@ https://www.elastic.co/guide/en/x-pack/current/license-management.html ---- client.license.postStartTrial([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/x-pack/current/license-management.html +link:{ref}/start-trial.html[Reference] [cols=2*] |=== |`type` @@ -4578,7 +4706,7 @@ https://www.elastic.co/guide/en/x-pack/current/license-management.html ---- client.migration.deprecations([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/migration/current/migration-api-deprecation.html +link:{ref}/migration-api-deprecation.html[Reference] [cols=2*] |=== |`index` @@ -4591,7 +4719,7 @@ http://www.elastic.co/guide/en/migration/current/migration-api-deprecation.html ---- client.ml.closeJob([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html +link:{ref}/ml-close-job.html[Reference] [cols=2*] |=== |`job_id` or `jobId` @@ -4616,7 +4744,6 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html ---- client.ml.deleteCalendar([params] [, options] [, callback]) ---- - [cols=2*] |=== |`calendar_id` or `calendarId` @@ -4629,7 +4756,6 @@ client.ml.deleteCalendar([params] [, options] [, callback]) ---- client.ml.deleteCalendarEvent([params] [, options] [, callback]) ---- - [cols=2*] |=== |`calendar_id` or `calendarId` @@ -4645,7 +4771,6 @@ client.ml.deleteCalendarEvent([params] [, options] [, callback]) ---- client.ml.deleteCalendarJob([params] [, options] [, callback]) ---- - [cols=2*] |=== |`calendar_id` or `calendarId` @@ -4661,7 +4786,7 @@ client.ml.deleteCalendarJob([params] [, options] [, callback]) ---- client.ml.deleteDatafeed([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html +link:{ref}/ml-delete-datafeed.html[Reference] [cols=2*] |=== |`datafeed_id` or `datafeedId` @@ -4679,13 +4804,11 @@ client.ml.deleteExpiredData([params] [, options] [, callback]) ---- - === ml.deleteFilter [source,js] ---- client.ml.deleteFilter([params] [, options] [, callback]) ---- - [cols=2*] |=== |`filter_id` or `filterId` @@ -4698,7 +4821,7 @@ client.ml.deleteFilter([params] [, options] [, callback]) ---- client.ml.deleteForecast([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html +link:{ref}/ml-delete-forecast.html[Reference] [cols=2*] |=== |`job_id` or `jobId` @@ -4720,7 +4843,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecas ---- client.ml.deleteJob([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html +link:{ref}/ml-delete-job.html[Reference] [cols=2*] |=== |`job_id` or `jobId` @@ -4740,7 +4863,7 @@ _Default:_ `true` ---- client.ml.deleteModelSnapshot([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html +link:{ref}/ml-delete-snapshot.html[Reference] [cols=2*] |=== |`job_id` or `jobId` @@ -4756,7 +4879,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapsho ---- client.ml.findFileStructure([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-file-structure.html +link:{ref}/ml-find-file-structure.html[Reference] [cols=2*] |=== |`lines_to_sample` or `linesToSample` @@ -4810,7 +4933,7 @@ _Default:_ `25s` ---- client.ml.flushJob([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html +link:{ref}/ml-flush-job.html[Reference] [cols=2*] |=== |`job_id` or `jobId` @@ -4841,7 +4964,6 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html ---- client.ml.forecast([params] [, options] [, callback]) ---- - [cols=2*] |=== |`job_id` or `jobId` @@ -4860,7 +4982,7 @@ client.ml.forecast([params] [, options] [, callback]) ---- client.ml.getBuckets([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html +link:{ref}/ml-get-bucket.html[Reference] [cols=2*] |=== |`job_id` or `jobId` @@ -4906,7 +5028,6 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.htm ---- client.ml.getCalendarEvents([params] [, options] [, callback]) ---- - [cols=2*] |=== |`calendar_id` or `calendarId` @@ -4934,7 +5055,6 @@ client.ml.getCalendarEvents([params] [, options] [, callback]) ---- client.ml.getCalendars([params] [, options] [, callback]) ---- - [cols=2*] |=== |`calendar_id` or `calendarId` @@ -4956,7 +5076,7 @@ client.ml.getCalendars([params] [, options] [, callback]) ---- client.ml.getCategories([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html +link:{ref}/ml-get-category.html[Reference] [cols=2*] |=== |`job_id` or `jobId` @@ -4981,7 +5101,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.h ---- client.ml.getDatafeedStats([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html +link:{ref}/ml-get-datafeed-stats.html[Reference] [cols=2*] |=== |`datafeed_id` or `datafeedId` @@ -4997,7 +5117,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-s ---- client.ml.getDatafeeds([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html +link:{ref}/ml-get-datafeed.html[Reference] [cols=2*] |=== |`datafeed_id` or `datafeedId` @@ -5013,7 +5133,6 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.h ---- client.ml.getFilters([params] [, options] [, callback]) ---- - [cols=2*] |=== |`filter_id` or `filterId` @@ -5032,7 +5151,7 @@ client.ml.getFilters([params] [, options] [, callback]) ---- client.ml.getInfluencers([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html +link:{ref}/ml-get-influencer.html[Reference] [cols=2*] |=== |`job_id` or `jobId` @@ -5072,7 +5191,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer ---- client.ml.getJobStats([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html +link:{ref}/ml-get-job-stats.html[Reference] [cols=2*] |=== |`job_id` or `jobId` @@ -5088,7 +5207,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats. ---- client.ml.getJobs([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html +link:{ref}/ml-get-job.html[Reference] [cols=2*] |=== |`job_id` or `jobId` @@ -5104,7 +5223,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html ---- client.ml.getModelSnapshots([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html +link:{ref}/ml-get-snapshot.html[Reference] [cols=2*] |=== |`job_id` or `jobId` @@ -5141,7 +5260,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.h ---- client.ml.getOverallBuckets([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html +link:{ref}/ml-get-overall-buckets.html[Reference] [cols=2*] |=== |`job_id` or `jobId` @@ -5178,7 +5297,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-bu ---- client.ml.getRecords([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html +link:{ref}/ml-get-record.html[Reference] [cols=2*] |=== |`job_id` or `jobId` @@ -5220,13 +5339,12 @@ client.ml.info([params] [, options] [, callback]) ---- - === ml.openJob [source,js] ---- client.ml.openJob([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html +link:{ref}/ml-open-job.html[Reference] [cols=2*] |=== |`job_id` or `jobId` @@ -5245,7 +5363,6 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html ---- client.ml.postCalendarEvents([params] [, options] [, callback]) ---- - [cols=2*] |=== |`calendar_id` or `calendarId` @@ -5261,7 +5378,7 @@ client.ml.postCalendarEvents([params] [, options] [, callback]) ---- client.ml.postData([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html +link:{ref}/ml-post-data.html[Reference] [cols=2*] |=== |`job_id` or `jobId` @@ -5283,7 +5400,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html ---- client.ml.previewDatafeed([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html +link:{ref}/ml-preview-datafeed.html[Reference] [cols=2*] |=== |`datafeed_id` or `datafeedId` @@ -5296,7 +5413,6 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafe ---- client.ml.putCalendar([params] [, options] [, callback]) ---- - [cols=2*] |=== |`calendar_id` or `calendarId` @@ -5312,7 +5428,6 @@ client.ml.putCalendar([params] [, options] [, callback]) ---- client.ml.putCalendarJob([params] [, options] [, callback]) ---- - [cols=2*] |=== |`calendar_id` or `calendarId` @@ -5328,7 +5443,7 @@ client.ml.putCalendarJob([params] [, options] [, callback]) ---- client.ml.putDatafeed([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html +link:{ref}/ml-put-datafeed.html[Reference] [cols=2*] |=== |`datafeed_id` or `datafeedId` @@ -5344,7 +5459,6 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.h ---- client.ml.putFilter([params] [, options] [, callback]) ---- - [cols=2*] |=== |`filter_id` or `filterId` @@ -5360,7 +5474,7 @@ client.ml.putFilter([params] [, options] [, callback]) ---- client.ml.putJob([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html +link:{ref}/ml-put-job.html[Reference] [cols=2*] |=== |`job_id` or `jobId` @@ -5376,7 +5490,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html ---- client.ml.revertModelSnapshot([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html +link:{ref}/ml-revert-snapshot.html[Reference] [cols=2*] |=== |`job_id` or `jobId` @@ -5398,7 +5512,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapsho ---- client.ml.setUpgradeMode([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html +link:{ref}/ml-set-upgrade-mode.html[Reference] [cols=2*] |=== |`enabled` @@ -5414,7 +5528,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mo ---- client.ml.startDatafeed([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html +link:{ref}/ml-start-datafeed.html[Reference] [cols=2*] |=== |`datafeed_id` or `datafeedId` @@ -5439,7 +5553,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed ---- client.ml.stopDatafeed([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html +link:{ref}/ml-stop-datafeed.html[Reference] [cols=2*] |=== |`datafeed_id` or `datafeedId` @@ -5461,7 +5575,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed. ---- client.ml.updateDatafeed([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html +link:{ref}/ml-update-datafeed.html[Reference] [cols=2*] |=== |`datafeed_id` or `datafeedId` @@ -5477,7 +5591,6 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafee ---- client.ml.updateFilter([params] [, options] [, callback]) ---- - [cols=2*] |=== |`filter_id` or `filterId` @@ -5493,7 +5606,7 @@ client.ml.updateFilter([params] [, options] [, callback]) ---- client.ml.updateJob([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html +link:{ref}/ml-update-job.html[Reference] [cols=2*] |=== |`job_id` or `jobId` @@ -5509,7 +5622,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.htm ---- client.ml.updateModelSnapshot([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html +link:{ref}/ml-update-snapshot.html[Reference] [cols=2*] |=== |`job_id` or `jobId` @@ -5528,7 +5641,6 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapsho ---- client.ml.validate([params] [, options] [, callback]) ---- - [cols=2*] |=== |`body` @@ -5541,7 +5653,6 @@ client.ml.validate([params] [, options] [, callback]) ---- client.ml.validateDetector([params] [, options] [, callback]) ---- - [cols=2*] |=== |`body` @@ -5554,7 +5665,7 @@ client.ml.validateDetector([params] [, options] [, callback]) ---- client.monitoring.bulk([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/monitoring/current/appendix-api-bulk.html +link:{ref}/es-monitoring.html[Reference] [cols=2*] |=== |`type` @@ -5579,7 +5690,6 @@ http://www.elastic.co/guide/en/monitoring/current/appendix-api-bulk.html ---- client.rollup.deleteJob([params] [, options] [, callback]) ---- - [cols=2*] |=== |`id` @@ -5592,7 +5702,6 @@ client.rollup.deleteJob([params] [, options] [, callback]) ---- client.rollup.getJobs([params] [, options] [, callback]) ---- - [cols=2*] |=== |`id` @@ -5605,7 +5714,6 @@ client.rollup.getJobs([params] [, options] [, callback]) ---- client.rollup.getRollupCaps([params] [, options] [, callback]) ---- - [cols=2*] |=== |`id` @@ -5618,7 +5726,6 @@ client.rollup.getRollupCaps([params] [, options] [, callback]) ---- client.rollup.getRollupIndexCaps([params] [, options] [, callback]) ---- - [cols=2*] |=== |`index` @@ -5631,7 +5738,6 @@ client.rollup.getRollupIndexCaps([params] [, options] [, callback]) ---- client.rollup.putJob([params] [, options] [, callback]) ---- - [cols=2*] |=== |`id` @@ -5647,7 +5753,6 @@ client.rollup.putJob([params] [, options] [, callback]) ---- client.rollup.rollupSearch([params] [, options] [, callback]) ---- - [cols=2*] |=== |`index` @@ -5672,7 +5777,6 @@ client.rollup.rollupSearch([params] [, options] [, callback]) ---- client.rollup.startJob([params] [, options] [, callback]) ---- - [cols=2*] |=== |`id` @@ -5685,7 +5789,6 @@ client.rollup.startJob([params] [, options] [, callback]) ---- client.rollup.stopJob([params] [, options] [, callback]) ---- - [cols=2*] |=== |`id` @@ -5704,7 +5807,7 @@ client.rollup.stopJob([params] [, options] [, callback]) ---- client.security.authenticate([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html +link:{ref}/security-api-authenticate.html[Reference] === security.changePassword @@ -5712,7 +5815,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-aut ---- client.security.changePassword([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html +link:{ref}/security-api-change-password.html[Reference] [cols=2*] |=== |`username` @@ -5731,7 +5834,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-cha ---- client.security.clearCachedRealms([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html +link:{ref}/security-api-clear-cache.html[Reference] [cols=2*] |=== |`realms` @@ -5747,7 +5850,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-cle ---- client.security.clearCachedRoles([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html +link:{ref}/security-api-clear-role-cache.html[Reference] [cols=2*] |=== |`name` @@ -5760,7 +5863,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-cle ---- client.security.createApiKey([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html +link:{ref}/security-api-create-api-key.html[Reference] [cols=2*] |=== |`refresh` @@ -5776,7 +5879,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-cre ---- client.security.deletePrivileges([params] [, options] [, callback]) ---- -TODO +link:TODO[Reference] [cols=2*] |=== |`application` @@ -5795,7 +5898,7 @@ TODO ---- client.security.deleteRole([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html +link:{ref}/security-api-delete-role.html[Reference] [cols=2*] |=== |`name` @@ -5811,7 +5914,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-del ---- client.security.deleteRoleMapping([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html +link:{ref}/security-api-delete-role-mapping.html[Reference] [cols=2*] |=== |`name` @@ -5827,7 +5930,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-del ---- client.security.deleteUser([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html +link:{ref}/security-api-delete-user.html[Reference] [cols=2*] |=== |`username` @@ -5843,7 +5946,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-del ---- client.security.disableUser([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html +link:{ref}/security-api-disable-user.html[Reference] [cols=2*] |=== |`username` @@ -5859,7 +5962,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-dis ---- client.security.enableUser([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html +link:{ref}/security-api-enable-user.html[Reference] [cols=2*] |=== |`username` @@ -5875,7 +5978,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ena ---- client.security.getApiKey([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html +link:{ref}/security-api-get-api-key.html[Reference] [cols=2*] |=== |`id` @@ -5897,7 +6000,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get ---- client.security.getPrivileges([params] [, options] [, callback]) ---- -TODO +link:TODO[Reference] [cols=2*] |=== |`application` @@ -5913,7 +6016,7 @@ TODO ---- client.security.getRole([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html +link:{ref}/security-api-get-role.html[Reference] [cols=2*] |=== |`name` @@ -5926,7 +6029,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get ---- client.security.getRoleMapping([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html +link:{ref}/security-api-get-role-mapping.html[Reference] [cols=2*] |=== |`name` @@ -5939,7 +6042,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get ---- client.security.getToken([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html +link:{ref}/security-api-get-token.html[Reference] [cols=2*] |=== |`body` @@ -5952,7 +6055,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get ---- client.security.getUser([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html +link:{ref}/security-api-get-user.html[Reference] [cols=2*] |=== |`username` @@ -5965,7 +6068,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get ---- client.security.getUserPrivileges([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html +link:{ref}/security-api-get-privileges.html[Reference] === security.hasPrivileges @@ -5973,7 +6076,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get ---- client.security.hasPrivileges([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html +link:{ref}/security-api-has-privileges.html[Reference] [cols=2*] |=== |`user` @@ -5989,7 +6092,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has ---- client.security.invalidateApiKey([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html +link:{ref}/security-api-invalidate-api-key.html[Reference] [cols=2*] |=== |`body` @@ -6002,7 +6105,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-inv ---- client.security.invalidateToken([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html +link:{ref}/security-api-invalidate-token.html[Reference] [cols=2*] |=== |`body` @@ -6015,7 +6118,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-inv ---- client.security.putPrivileges([params] [, options] [, callback]) ---- -TODO +link:TODO[Reference] [cols=2*] |=== |`refresh` @@ -6031,7 +6134,7 @@ TODO ---- client.security.putRole([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html +link:{ref}/security-api-put-role.html[Reference] [cols=2*] |=== |`name` @@ -6050,7 +6153,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put ---- client.security.putRoleMapping([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html +link:{ref}/security-api-put-role-mapping.html[Reference] [cols=2*] |=== |`name` @@ -6069,7 +6172,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put ---- client.security.putUser([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html +link:{ref}/security-api-put-user.html[Reference] [cols=2*] |=== |`username` @@ -6088,7 +6191,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put ---- client.sql.clearCursor([params] [, options] [, callback]) ---- -Clear SQL cursor +link:Clear SQL cursor[Reference] [cols=2*] |=== |`body` @@ -6101,7 +6204,7 @@ Clear SQL cursor ---- client.sql.query([params] [, options] [, callback]) ---- -Execute SQL +link:Execute SQL[Reference] [cols=2*] |=== |`format` @@ -6117,7 +6220,7 @@ Execute SQL ---- client.sql.translate([params] [, options] [, callback]) ---- -Translate SQL into Elasticsearch queries +link:Translate SQL into Elasticsearch queries[Reference] [cols=2*] |=== |`body` @@ -6130,7 +6233,7 @@ Translate SQL into Elasticsearch queries ---- client.ssl.certificates([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html +link:{ref}/security-api-ssl.html[Reference] === watcher.ackWatch @@ -6138,7 +6241,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl ---- client.watcher.ackWatch([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html +link:{ref}/watcher-api-ack-watch.html[Reference] [cols=2*] |=== |`watch_id` or `watchId` @@ -6154,7 +6257,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-w ---- client.watcher.activateWatch([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html +link:{ref}/watcher-api-activate-watch.html[Reference] [cols=2*] |=== |`watch_id` or `watchId` @@ -6167,7 +6270,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-acti ---- client.watcher.deactivateWatch([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html +link:{ref}/watcher-api-deactivate-watch.html[Reference] [cols=2*] |=== |`watch_id` or `watchId` @@ -6180,7 +6283,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deac ---- client.watcher.deleteWatch([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html +link:{ref}/watcher-api-delete-watch.html[Reference] [cols=2*] |=== |`id` @@ -6193,7 +6296,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delet ---- client.watcher.executeWatch([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html +link:{ref}/watcher-api-execute-watch.html[Reference] [cols=2*] |=== |`id` @@ -6212,7 +6315,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execu ---- client.watcher.getWatch([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html +link:{ref}/watcher-api-get-watch.html[Reference] [cols=2*] |=== |`id` @@ -6225,7 +6328,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-w ---- client.watcher.putWatch([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html +link:{ref}/watcher-api-put-watch.html[Reference] [cols=2*] |=== |`id` @@ -6253,7 +6356,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-w ---- client.watcher.start([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html +link:{ref}/watcher-api-start.html[Reference] === watcher.stats @@ -6261,7 +6364,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start ---- client.watcher.stats([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html +link:{ref}/watcher-api-stats.html[Reference] [cols=2*] |=== |`metric` @@ -6280,7 +6383,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats ---- client.watcher.stop([params] [, options] [, callback]) ---- -http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html +link:{ref}/watcher-api-stop.html[Reference] === xpack.info @@ -6288,7 +6391,7 @@ http://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop. ---- client.xpack.info([params] [, options] [, callback]) ---- -https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html +link:{ref}/info-api.html[Reference] [cols=2*] |=== |`categories` @@ -6301,7 +6404,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html ---- client.xpack.usage([params] [, options] [, callback]) ---- -Retrieve information about xpack features usage +link:Retrieve information about xpack features usage[Reference] [cols=2*] |=== |`master_timeout` or `masterTimeout` 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 }