diff --git a/docs/examples/index.asciidoc b/docs/examples/index.asciidoc index 747a068c6..fdc60a660 100644 --- a/docs/examples/index.asciidoc +++ b/docs/examples/index.asciidoc @@ -7,6 +7,10 @@ Following you can find some examples on how to use the client. * Executing a <> request; * Executing a <> request; * Executing a <> request; +* Executing a <> request; +* Executing a <> request; +* Executing a <> request; +* Executing a <> request; * Use of the <> parameter; * Executing a <> request; * How do I <>? @@ -26,3 +30,7 @@ include::search.asciidoc[] include::suggest.asciidoc[] include::transport.request.asciidoc[] include::typescript.asciidoc[] +include::sql.query.asciidoc[] +include::update.asciidoc[] +include::update_by_query.asciidoc[] +include::reindex.asciidoc[] diff --git a/docs/examples/sql.asciidoc b/docs/examples/sql.query.asciidoc similarity index 97% rename from docs/examples/sql.asciidoc rename to docs/examples/sql.query.asciidoc index cccc641ae..e6bee5f4f 100644 --- a/docs/examples/sql.asciidoc +++ b/docs/examples/sql.query.asciidoc @@ -1,9 +1,9 @@ -[[sql_examples]] +[[sql_query_examples]] == SQL Elasticsearch SQL is an X-Pack component that allows SQL-like queries to be executed in real-time against Elasticsearch. Whether using the REST interface, command-line or JDBC, any client can use SQL to search and aggregate data natively inside Elasticsearch. One can think of Elasticsearch SQL as a translator, one that understands both SQL and Elasticsearch and makes it easy to read and process data in real-time, at scale by leveraging Elasticsearch capabilities. -In the following example we will search all the documents that has the field `house` equals to `stark`, log the result with the tabular view and then manipulate the result to obtain an object easy to navigate. +In the following example we will search all the documents that has the field `house` equals to `stark`, log the result with the tabular view and then manipulate the result to obtain an object easy to navigate. [source,js] ---- diff --git a/docs/examples/update-by-query.asciidoc b/docs/examples/update_by_query.asciidoc similarity index 100% rename from docs/examples/update-by-query.asciidoc rename to docs/examples/update_by_query.asciidoc diff --git a/docs/reference.asciidoc b/docs/reference.asciidoc index 23f4df9c0..e914edb87 100644 --- a/docs/reference.asciidoc +++ b/docs/reference.asciidoc @@ -75,7 +75,7 @@ In this document, you will find the reference of every parameter accepted by the === Common parameters Parameters that are accepted by all API endpoints. -link:{ref}/common-options.html[Reference] +link:{ref}/common-options.html[Documentation] [cols=2*] |=== |`pretty` @@ -113,7 +113,8 @@ client.bulk({ body: object }) ---- -link:{ref}/docs-bulk.html[Reference] +link:{ref}/docs-bulk.html[Documentation] + +{jsclient}/bulk_examples.html[Code Example] + [cols=2*] |=== |`index` @@ -165,7 +166,7 @@ client.cat.aliases({ v: boolean }) ---- -link:{ref}/cat-alias.html[Reference] +link:{ref}/cat-alias.html[Documentation] + [cols=2*] |=== |`name` @@ -207,7 +208,7 @@ client.cat.allocation({ v: boolean }) ---- -link:{ref}/cat-allocation.html[Reference] +link:{ref}/cat-allocation.html[Documentation] + [cols=2*] |=== |`node_id` or `nodeId` @@ -252,7 +253,7 @@ client.cat.count({ v: boolean }) ---- -link:{ref}/cat-count.html[Reference] +link:{ref}/cat-count.html[Documentation] + [cols=2*] |=== |`index` @@ -289,7 +290,7 @@ client.cat.fielddata({ v: boolean }) ---- -link:{ref}/cat-fielddata.html[Reference] +link:{ref}/cat-fielddata.html[Documentation] + [cols=2*] |=== |`fields` @@ -329,7 +330,7 @@ client.cat.health({ v: boolean }) ---- -link:{ref}/cat-health.html[Reference] +link:{ref}/cat-health.html[Documentation] + [cols=2*] |=== |`format` @@ -365,7 +366,7 @@ client.cat.help({ s: string | string[] }) ---- -link:{ref}/cat.html[Reference] +link:{ref}/cat.html[Documentation] + [cols=2*] |=== |`help` @@ -396,7 +397,7 @@ client.cat.indices({ include_unloaded_segments: boolean }) ---- -link:{ref}/cat-indices.html[Reference] +link:{ref}/cat-indices.html[Documentation] + [cols=2*] |=== |`index` @@ -454,7 +455,7 @@ client.cat.master({ v: boolean }) ---- -link:{ref}/cat-master.html[Reference] +link:{ref}/cat-master.html[Documentation] + [cols=2*] |=== |`format` @@ -494,7 +495,7 @@ client.cat.nodeattrs({ v: boolean }) ---- -link:{ref}/cat-nodeattrs.html[Reference] +link:{ref}/cat-nodeattrs.html[Documentation] + [cols=2*] |=== |`format` @@ -536,7 +537,7 @@ client.cat.nodes({ v: boolean }) ---- -link:{ref}/cat-nodes.html[Reference] +link:{ref}/cat-nodes.html[Documentation] + [cols=2*] |=== |`bytes` @@ -583,7 +584,7 @@ client.cat.pendingTasks({ v: boolean }) ---- -link:{ref}/cat-pending-tasks.html[Reference] +link:{ref}/cat-pending-tasks.html[Documentation] + [cols=2*] |=== |`format` @@ -626,7 +627,7 @@ client.cat.plugins({ v: boolean }) ---- -link:{ref}/cat-plugins.html[Reference] +link:{ref}/cat-plugins.html[Documentation] + [cols=2*] |=== |`format` @@ -669,7 +670,7 @@ client.cat.recovery({ v: boolean }) ---- -link:{ref}/cat-recovery.html[Reference] +link:{ref}/cat-recovery.html[Documentation] + [cols=2*] |=== |`index` @@ -718,7 +719,7 @@ client.cat.repositories({ v: boolean }) ---- -link:{ref}/cat-repositories.html[Reference] +link:{ref}/cat-repositories.html[Documentation] + [cols=2*] |=== |`format` @@ -758,7 +759,7 @@ client.cat.segments({ v: boolean }) ---- -link:{ref}/cat-segments.html[Reference] +link:{ref}/cat-segments.html[Documentation] + [cols=2*] |=== |`index` @@ -801,7 +802,7 @@ client.cat.shards({ v: boolean }) ---- -link:{ref}/cat-shards.html[Reference] +link:{ref}/cat-shards.html[Documentation] + [cols=2*] |=== |`index` @@ -852,7 +853,7 @@ client.cat.snapshots({ v: boolean }) ---- -link:{ref}/cat-snapshots.html[Reference] +link:{ref}/cat-snapshots.html[Documentation] + [cols=2*] |=== |`repository` @@ -901,7 +902,7 @@ client.cat.tasks({ v: boolean }) ---- -link:{ref}/tasks.html[Reference] +link:{ref}/tasks.html[Documentation] + [cols=2*] |=== |`format` @@ -951,7 +952,7 @@ client.cat.templates({ v: boolean }) ---- -link:{ref}/cat-templates.html[Reference] +link:{ref}/cat-templates.html[Documentation] + [cols=2*] |=== |`name` @@ -996,7 +997,7 @@ client.cat.threadPool({ v: boolean }) ---- -link:{ref}/cat-thread-pool.html[Reference] +link:{ref}/cat-thread-pool.html[Documentation] + [cols=2*] |=== |`thread_pool_patterns` or `threadPoolPatterns` @@ -1037,7 +1038,7 @@ client.clearScroll({ body: object }) ---- -link:{ref}/search-request-body.html#_clear_scroll_api[Reference] +link:{ref}/search-request-body.html#_clear_scroll_api[Documentation] + [cols=2*] |=== |`scroll_id` or `scrollId` @@ -1060,7 +1061,7 @@ client.cluster.allocationExplain({ body: object }) ---- -link:{ref}/cluster-allocation-explain.html[Reference] +link:{ref}/cluster-allocation-explain.html[Documentation] + [cols=2*] |=== |`include_yes_decisions` or `includeYesDecisions` @@ -1085,7 +1086,7 @@ client.cluster.getSettings({ include_defaults: boolean }) ---- -link:{ref}/cluster-update-settings.html[Reference] +link:{ref}/cluster-update-settings.html[Documentation] + [cols=2*] |=== |`flat_settings` or `flatSettings` @@ -1121,7 +1122,7 @@ client.cluster.health({ wait_for_status: 'green' | 'yellow' | 'red' }) ---- -link:{ref}/cluster-health.html[Reference] +link:{ref}/cluster-health.html[Documentation] + [cols=2*] |=== |`index` @@ -1173,7 +1174,7 @@ client.cluster.pendingTasks({ master_timeout: string }) ---- -link:{ref}/cluster-pending.html[Reference] +link:{ref}/cluster-pending.html[Documentation] + [cols=2*] |=== |`local` @@ -1195,7 +1196,7 @@ client.cluster.putSettings({ body: object }) ---- -link:{ref}/cluster-update-settings.html[Reference] +link:{ref}/cluster-update-settings.html[Documentation] + [cols=2*] |=== |`flat_settings` or `flatSettings` @@ -1218,7 +1219,7 @@ link:{ref}/cluster-update-settings.html[Reference] ---- client.cluster.remoteInfo() ---- -link:{ref}/cluster-remote-info.html[Reference] +link:{ref}/cluster-remote-info.html[Documentation] + === cluster.reroute @@ -1235,7 +1236,7 @@ client.cluster.reroute({ body: object }) ---- -link:{ref}/cluster-reroute.html[Reference] +link:{ref}/cluster-reroute.html[Documentation] + [cols=2*] |=== |`dry_run` or `dryRun` @@ -1278,7 +1279,7 @@ client.cluster.state({ expand_wildcards: 'open' | 'closed' | 'none' | 'all' }) ---- -link:{ref}/cluster-state.html[Reference] +link:{ref}/cluster-state.html[Documentation] + [cols=2*] |=== |`index` @@ -1324,7 +1325,7 @@ client.cluster.stats({ timeout: string }) ---- -link:{ref}/cluster-stats.html[Reference] +link:{ref}/cluster-stats.html[Documentation] + [cols=2*] |=== |`node_id` or `nodeId` @@ -1361,7 +1362,7 @@ client.count({ body: object }) ---- -link:{ref}/search-count.html[Reference] +link:{ref}/search-count.html[Documentation] + [cols=2*] |=== |`index` @@ -1434,7 +1435,7 @@ client.create({ body: object }) ---- -link:{ref}/docs-index_.html[Reference] +link:{ref}/docs-index_.html[Documentation] + [cols=2*] |=== |`id` @@ -1492,7 +1493,7 @@ client.delete({ version_type: 'internal' | 'external' | 'external_gte' }) ---- -link:{ref}/docs-delete.html[Reference] +link:{ref}/docs-delete.html[Documentation] + [cols=2*] |=== |`id` @@ -1573,7 +1574,7 @@ client.deleteByQuery({ body: object }) ---- -link:{ref}/docs-delete-by-query.html[Reference] +link:{ref}/docs-delete-by-query.html[Documentation] + [cols=2*] |=== |`index` @@ -1695,7 +1696,7 @@ client.deleteByQueryRethrottle({ requests_per_second: number }) ---- -link:{ref}/docs-delete-by-query.html[Reference] +link:{ref}/docs-delete-by-query.html[Documentation] + [cols=2*] |=== |`task_id` or `taskId` @@ -1716,7 +1717,7 @@ client.deleteScript({ master_timeout: string }) ---- -link:{ref}/modules-scripting.html[Reference] +link:{ref}/modules-scripting.html[Documentation] + [cols=2*] |=== |`id` @@ -1749,7 +1750,8 @@ client.exists({ version_type: 'internal' | 'external' | 'external_gte' }) ---- -link:{ref}/docs-get.html[Reference] +link:{ref}/docs-get.html[Documentation] + +{jsclient}/exists_examples.html[Code Example] + [cols=2*] |=== |`id` @@ -1809,7 +1811,7 @@ client.existsSource({ version_type: 'internal' | 'external' | 'external_gte' }) ---- -link:{ref}/docs-get.html[Reference] +link:{ref}/docs-get.html[Documentation] + [cols=2*] |=== |`id` @@ -1874,7 +1876,7 @@ client.explain({ body: object }) ---- -link:{ref}/search-explain.html[Reference] +link:{ref}/search-explain.html[Documentation] + [cols=2*] |=== |`id` @@ -1938,7 +1940,7 @@ client.fieldCaps({ include_unmapped: boolean }) ---- -link:{ref}/search-field-caps.html[Reference] +link:{ref}/search-field-caps.html[Documentation] + [cols=2*] |=== |`index` @@ -1981,7 +1983,8 @@ client.get({ version_type: 'internal' | 'external' | 'external_gte' }) ---- -link:{ref}/docs-get.html[Reference] +link:{ref}/docs-get.html[Documentation] + +{jsclient}/get_examples.html[Code Example] + [cols=2*] |=== |`id` @@ -2031,7 +2034,7 @@ client.getScript({ master_timeout: string }) ---- -link:{ref}/modules-scripting.html[Reference] +link:{ref}/modules-scripting.html[Documentation] + [cols=2*] |=== |`id` @@ -2076,7 +2079,7 @@ client.getSource({ version_type: 'internal' | 'external' | 'external_gte' }) ---- -link:{ref}/docs-get.html[Reference] +link:{ref}/docs-get.html[Documentation] + [cols=2*] |=== |`id` @@ -2134,7 +2137,7 @@ client.index({ body: object }) ---- -link:{ref}/docs-index_.html[Reference] +link:{ref}/docs-index_.html[Documentation] + [cols=2*] |=== |`id` @@ -2187,7 +2190,7 @@ client.indices.analyze({ body: object }) ---- -link:{ref}/indices-analyze.html[Reference] +link:{ref}/indices-analyze.html[Documentation] + [cols=2*] |=== |`index` @@ -2213,7 +2216,7 @@ client.indices.clearCache({ request: boolean }) ---- -link:{ref}/indices-clearcache.html[Reference] +link:{ref}/indices-clearcache.html[Documentation] + [cols=2*] |=== |`index` @@ -2256,7 +2259,7 @@ client.indices.clone({ body: object }) ---- -link:{ref}/indices-clone-index.html[Reference] +link:{ref}/indices-clone-index.html[Documentation] + [cols=2*] |=== |`index` @@ -2293,7 +2296,7 @@ client.indices.close({ wait_for_active_shards: string }) ---- -link:{ref}/indices-open-close.html[Reference] +link:{ref}/indices-open-close.html[Documentation] + [cols=2*] |=== |`index` @@ -2332,7 +2335,7 @@ client.indices.create({ body: object }) ---- -link:{ref}/indices-create-index.html[Reference] +link:{ref}/indices-create-index.html[Documentation] + [cols=2*] |=== |`index` @@ -2365,7 +2368,7 @@ client.indices.delete({ expand_wildcards: 'open' | 'closed' | 'none' | 'all' }) ---- -link:{ref}/indices-delete-index.html[Reference] +link:{ref}/indices-delete-index.html[Documentation] + [cols=2*] |=== |`index` @@ -2400,7 +2403,7 @@ client.indices.deleteAlias({ master_timeout: string }) ---- -link:{ref}/indices-aliases.html[Reference] +link:{ref}/indices-aliases.html[Documentation] + [cols=2*] |=== |`index` @@ -2427,7 +2430,7 @@ client.indices.deleteTemplate({ master_timeout: string }) ---- -link:{ref}/indices-templates.html[Reference] +link:{ref}/indices-templates.html[Documentation] + [cols=2*] |=== |`name` @@ -2455,7 +2458,7 @@ client.indices.exists({ include_defaults: boolean }) ---- -link:{ref}/indices-exists.html[Reference] +link:{ref}/indices-exists.html[Documentation] + [cols=2*] |=== |`index` @@ -2495,7 +2498,7 @@ client.indices.existsAlias({ local: boolean }) ---- -link:{ref}/indices-aliases.html[Reference] +link:{ref}/indices-aliases.html[Documentation] + [cols=2*] |=== |`name` @@ -2530,7 +2533,7 @@ client.indices.existsTemplate({ local: boolean }) ---- -link:{ref}/indices-templates.html[Reference] +link:{ref}/indices-templates.html[Documentation] + [cols=2*] |=== |`name` @@ -2560,7 +2563,7 @@ client.indices.existsType({ local: boolean }) ---- -link:{ref}/indices-types-exists.html[Reference] +link:{ref}/indices-types-exists.html[Documentation] + [cols=2*] |=== |`index` @@ -2597,7 +2600,7 @@ client.indices.flush({ expand_wildcards: 'open' | 'closed' | 'none' | 'all' }) ---- -link:{ref}/indices-flush.html[Reference] +link:{ref}/indices-flush.html[Documentation] + [cols=2*] |=== |`index` @@ -2635,7 +2638,7 @@ client.indices.forcemerge({ only_expunge_deletes: boolean }) ---- -link:{ref}/indices-forcemerge.html[Reference] +link:{ref}/indices-forcemerge.html[Documentation] + [cols=2*] |=== |`index` @@ -2677,7 +2680,7 @@ client.indices.get({ master_timeout: string }) ---- -link:{ref}/indices-get-index.html[Reference] +link:{ref}/indices-get-index.html[Documentation] + [cols=2*] |=== |`index` @@ -2720,7 +2723,7 @@ client.indices.getAlias({ local: boolean }) ---- -link:{ref}/indices-aliases.html[Reference] +link:{ref}/indices-aliases.html[Documentation] + [cols=2*] |=== |`name` @@ -2758,7 +2761,7 @@ client.indices.getFieldMapping({ local: boolean }) ---- -link:{ref}/indices-get-field-mapping.html[Reference] +link:{ref}/indices-get-field-mapping.html[Documentation] + [cols=2*] |=== |`fields` @@ -2798,7 +2801,7 @@ client.indices.getMapping({ local: boolean }) ---- -link:{ref}/indices-get-mapping.html[Reference] +link:{ref}/indices-get-mapping.html[Documentation] + [cols=2*] |=== |`index` @@ -2838,7 +2841,7 @@ client.indices.getSettings({ include_defaults: boolean }) ---- -link:{ref}/indices-get-settings.html[Reference] +link:{ref}/indices-get-settings.html[Documentation] + [cols=2*] |=== |`index` @@ -2882,7 +2885,7 @@ client.indices.getTemplate({ local: boolean }) ---- -link:{ref}/indices-templates.html[Reference] +link:{ref}/indices-templates.html[Documentation] + [cols=2*] |=== |`name` @@ -2910,7 +2913,7 @@ client.indices.getUpgrade({ expand_wildcards: 'open' | 'closed' | 'none' | 'all' }) ---- -link:{ref}/indices-upgrade.html[Reference] +link:{ref}/indices-upgrade.html[Documentation] + [cols=2*] |=== |`index` @@ -2942,7 +2945,7 @@ client.indices.open({ wait_for_active_shards: string }) ---- -link:{ref}/indices-open-close.html[Reference] +link:{ref}/indices-open-close.html[Documentation] + [cols=2*] |=== |`index` @@ -2981,7 +2984,7 @@ client.indices.putAlias({ body: object }) ---- -link:{ref}/indices-aliases.html[Reference] +link:{ref}/indices-aliases.html[Documentation] + [cols=2*] |=== |`index` @@ -3015,7 +3018,7 @@ client.indices.putMapping({ body: object }) ---- -link:{ref}/indices-put-mapping.html[Reference] +link:{ref}/indices-put-mapping.html[Documentation] + [cols=2*] |=== |`index` @@ -3058,7 +3061,7 @@ client.indices.putSettings({ body: object }) ---- -link:{ref}/indices-update-settings.html[Reference] +link:{ref}/indices-update-settings.html[Documentation] + [cols=2*] |=== |`index` @@ -3105,7 +3108,7 @@ client.indices.putTemplate({ body: object }) ---- -link:{ref}/indices-templates.html[Reference] +link:{ref}/indices-templates.html[Documentation] + [cols=2*] |=== |`name` @@ -3141,7 +3144,7 @@ client.indices.recovery({ active_only: boolean }) ---- -link:{ref}/indices-recovery.html[Reference] +link:{ref}/indices-recovery.html[Documentation] + [cols=2*] |=== |`index` @@ -3166,7 +3169,7 @@ client.indices.refresh({ expand_wildcards: 'open' | 'closed' | 'none' | 'all' }) ---- -link:{ref}/indices-refresh.html[Reference] +link:{ref}/indices-refresh.html[Documentation] + [cols=2*] |=== |`index` @@ -3198,7 +3201,7 @@ client.indices.rollover({ body: object }) ---- -link:{ref}/indices-rollover-index.html[Reference] +link:{ref}/indices-rollover-index.html[Documentation] + [cols=2*] |=== |`alias` @@ -3236,7 +3239,7 @@ client.indices.segments({ verbose: boolean }) ---- -link:{ref}/indices-segments.html[Reference] +link:{ref}/indices-segments.html[Documentation] + [cols=2*] |=== |`index` @@ -3269,7 +3272,7 @@ client.indices.shardStores({ expand_wildcards: 'open' | 'closed' | 'none' | 'all' }) ---- -link:{ref}/indices-shards-stores.html[Reference] +link:{ref}/indices-shards-stores.html[Documentation] + [cols=2*] |=== |`index` @@ -3303,7 +3306,7 @@ client.indices.shrink({ body: object }) ---- -link:{ref}/indices-shrink-index.html[Reference] +link:{ref}/indices-shrink-index.html[Documentation] + [cols=2*] |=== |`index` @@ -3339,7 +3342,7 @@ client.indices.split({ body: object }) ---- -link:{ref}/indices-split-index.html[Reference] +link:{ref}/indices-split-index.html[Documentation] + [cols=2*] |=== |`index` @@ -3381,7 +3384,7 @@ client.indices.stats({ forbid_closed_indices: boolean }) ---- -link:{ref}/indices-stats.html[Reference] +link:{ref}/indices-stats.html[Documentation] + [cols=2*] |=== |`metric` @@ -3435,7 +3438,7 @@ client.indices.updateAliases({ body: object }) ---- -link:{ref}/indices-aliases.html[Reference] +link:{ref}/indices-aliases.html[Documentation] + [cols=2*] |=== |`timeout` @@ -3462,7 +3465,7 @@ client.indices.upgrade({ only_ancient_segments: boolean }) ---- -link:{ref}/indices-upgrade.html[Reference] +link:{ref}/indices-upgrade.html[Documentation] + [cols=2*] |=== |`index` @@ -3508,7 +3511,7 @@ client.indices.validateQuery({ body: object }) ---- -link:{ref}/search-validate.html[Reference] +link:{ref}/search-validate.html[Documentation] + [cols=2*] |=== |`index` @@ -3568,7 +3571,7 @@ _Default:_ `OR` ---- client.info() ---- -link:{ref}/index.html[Reference] +link:{ref}/index.html[Documentation] + === ingest.deletePipeline @@ -3581,7 +3584,7 @@ client.ingest.deletePipeline({ timeout: string }) ---- -link:{ref}/delete-pipeline-api.html[Reference] +link:{ref}/delete-pipeline-api.html[Documentation] + [cols=2*] |=== |`id` @@ -3604,7 +3607,7 @@ client.ingest.getPipeline({ master_timeout: string }) ---- -link:{ref}/get-pipeline-api.html[Reference] +link:{ref}/get-pipeline-api.html[Documentation] + [cols=2*] |=== |`id` @@ -3621,7 +3624,7 @@ link:{ref}/get-pipeline-api.html[Reference] ---- client.ingest.processorGrok() ---- -link:{ref}/grok-processor.html#grok-processor-rest-get[Reference] +link:{ref}/grok-processor.html#grok-processor-rest-get[Documentation] + === ingest.putPipeline @@ -3635,7 +3638,7 @@ client.ingest.putPipeline({ body: object }) ---- -link:{ref}/put-pipeline-api.html[Reference] +link:{ref}/put-pipeline-api.html[Documentation] + [cols=2*] |=== |`id` @@ -3662,7 +3665,7 @@ client.ingest.simulate({ body: object }) ---- -link:{ref}/simulate-pipeline-api.html[Reference] +link:{ref}/simulate-pipeline-api.html[Documentation] + [cols=2*] |=== |`id` @@ -3693,7 +3696,7 @@ client.mget({ body: object }) ---- -link:{ref}/docs-multi-get.html[Reference] +link:{ref}/docs-multi-get.html[Documentation] + [cols=2*] |=== |`index` @@ -3744,7 +3747,8 @@ client.msearch({ body: object }) ---- -link:{ref}/search-multi-search.html[Reference] +link:{ref}/search-multi-search.html[Documentation] + +{jsclient}/msearch_examples.html[Code Example] + [cols=2*] |=== |`index` @@ -3793,7 +3797,7 @@ client.msearchTemplate({ body: object }) ---- -link:{ref}/search-multi-search.html[Reference] +link:{ref}/search-multi-search.html[Documentation] + [cols=2*] |=== |`index` @@ -3841,7 +3845,7 @@ client.mtermvectors({ body: object }) ---- -link:{ref}/docs-multi-termvectors.html[Reference] +link:{ref}/docs-multi-termvectors.html[Documentation] + [cols=2*] |=== |`index` @@ -3906,7 +3910,7 @@ client.nodes.hotThreads({ timeout: string }) ---- -link:{ref}/cluster-nodes-hot-threads.html[Reference] +link:{ref}/cluster-nodes-hot-threads.html[Documentation] + [cols=2*] |=== |`node_id` or `nodeId` @@ -3943,7 +3947,7 @@ client.nodes.info({ timeout: string }) ---- -link:{ref}/cluster-nodes-info.html[Reference] +link:{ref}/cluster-nodes-info.html[Documentation] + [cols=2*] |=== |`node_id` or `nodeId` @@ -3969,7 +3973,7 @@ client.nodes.reloadSecureSettings({ timeout: string }) ---- -link:{ref}/secure-settings.html#reloadable-secure-settings[Reference] +link:{ref}/secure-settings.html#reloadable-secure-settings[Documentation] + [cols=2*] |=== |`node_id` or `nodeId` @@ -3998,7 +4002,7 @@ client.nodes.stats({ include_segment_file_sizes: boolean }) ---- -link:{ref}/cluster-nodes-stats.html[Reference] +link:{ref}/cluster-nodes-stats.html[Documentation] + [cols=2*] |=== |`node_id` or `nodeId` @@ -4047,7 +4051,7 @@ client.nodes.usage({ timeout: string }) ---- -link:{ref}/cluster-nodes-usage.html[Reference] +link:{ref}/cluster-nodes-usage.html[Documentation] + [cols=2*] |=== |`node_id` or `nodeId` @@ -4067,7 +4071,7 @@ link:{ref}/cluster-nodes-usage.html[Reference] ---- client.ping() ---- -link:{ref}/index.html[Reference] +link:{ref}/index.html[Documentation] + === putScript @@ -4082,7 +4086,7 @@ client.putScript({ body: object }) ---- -link:{ref}/modules-scripting.html[Reference] +link:{ref}/modules-scripting.html[Documentation] + [cols=2*] |=== |`id` @@ -4115,7 +4119,7 @@ client.rankEval({ body: object }) ---- -link:{ref}/search-rank-eval.html[Reference] +link:{ref}/search-rank-eval.html[Documentation] + [cols=2*] |=== |`index` @@ -4155,7 +4159,8 @@ client.reindex({ body: object }) ---- -link:{ref}/docs-reindex.html[Reference] +link:{ref}/docs-reindex.html[Documentation] + +{jsclient}/reindex_examples.html[Code Example] + [cols=2*] |=== |`refresh` @@ -4200,7 +4205,7 @@ client.reindexRethrottle({ requests_per_second: number }) ---- -link:{ref}/docs-reindex.html[Reference] +link:{ref}/docs-reindex.html[Documentation] + [cols=2*] |=== |`task_id` or `taskId` @@ -4220,7 +4225,7 @@ client.renderSearchTemplate({ body: object }) ---- -link:{ref}/search-template.html#_validating_templates[Reference] +link:{ref}/search-template.html#_validating_templates[Documentation] + [cols=2*] |=== |`id` @@ -4239,7 +4244,7 @@ client.scriptsPainlessExecute({ body: object }) ---- -link:https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html[Reference] +link:https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html[Documentation] + [cols=2*] |=== |`body` @@ -4258,7 +4263,8 @@ client.scroll({ body: object }) ---- -link:{ref}/search-request-body.html#request-body-search-scroll[Reference] +link:{ref}/search-request-body.html#request-body-search-scroll[Documentation] + +{jsclient}/scroll_examples.html[Code Example] + [cols=2*] |=== |`scroll_id` or `scrollId` @@ -4328,7 +4334,8 @@ client.search({ body: object }) ---- -link:{ref}/search-search.html[Reference] +link:{ref}/search-search.html[Documentation] + +{jsclient}/search_examples.html[Code Example] + [cols=2*] |=== |`index` @@ -4487,7 +4494,7 @@ client.searchShards({ expand_wildcards: 'open' | 'closed' | 'none' | 'all' }) ---- -link:{ref}/search-shards.html[Reference] +link:{ref}/search-shards.html[Documentation] + [cols=2*] |=== |`index` @@ -4536,7 +4543,7 @@ client.searchTemplate({ body: object }) ---- -link:{ref}/search-template.html[Reference] +link:{ref}/search-template.html[Documentation] + [cols=2*] |=== |`index` @@ -4599,7 +4606,7 @@ client.snapshot.cleanupRepository({ body: object }) ---- -link:{ref}/modules-snapshots.html[Reference] +link:{ref}/modules-snapshots.html[Documentation] + [cols=2*] |=== |`repository` @@ -4628,7 +4635,7 @@ client.snapshot.create({ body: object }) ---- -link:{ref}/modules-snapshots.html[Reference] +link:{ref}/modules-snapshots.html[Documentation] + [cols=2*] |=== |`repository` @@ -4660,7 +4667,7 @@ client.snapshot.createRepository({ body: object }) ---- -link:{ref}/modules-snapshots.html[Reference] +link:{ref}/modules-snapshots.html[Documentation] + [cols=2*] |=== |`repository` @@ -4690,7 +4697,7 @@ client.snapshot.delete({ master_timeout: string }) ---- -link:{ref}/modules-snapshots.html[Reference] +link:{ref}/modules-snapshots.html[Documentation] + [cols=2*] |=== |`repository` @@ -4714,7 +4721,7 @@ client.snapshot.deleteRepository({ timeout: string }) ---- -link:{ref}/modules-snapshots.html[Reference] +link:{ref}/modules-snapshots.html[Documentation] + [cols=2*] |=== |`repository` @@ -4740,7 +4747,7 @@ client.snapshot.get({ verbose: boolean }) ---- -link:{ref}/modules-snapshots.html[Reference] +link:{ref}/modules-snapshots.html[Documentation] + [cols=2*] |=== |`repository` @@ -4770,7 +4777,7 @@ client.snapshot.getRepository({ local: boolean }) ---- -link:{ref}/modules-snapshots.html[Reference] +link:{ref}/modules-snapshots.html[Documentation] + [cols=2*] |=== |`repository` @@ -4796,7 +4803,7 @@ client.snapshot.restore({ body: object }) ---- -link:{ref}/modules-snapshots.html[Reference] +link:{ref}/modules-snapshots.html[Documentation] + [cols=2*] |=== |`repository` @@ -4827,7 +4834,7 @@ client.snapshot.status({ ignore_unavailable: boolean }) ---- -link:{ref}/modules-snapshots.html[Reference] +link:{ref}/modules-snapshots.html[Documentation] + [cols=2*] |=== |`repository` @@ -4854,7 +4861,7 @@ client.snapshot.verifyRepository({ timeout: string }) ---- -link:{ref}/modules-snapshots.html[Reference] +link:{ref}/modules-snapshots.html[Documentation] + [cols=2*] |=== |`repository` @@ -4879,7 +4886,7 @@ client.tasks.cancel({ parent_task_id: string }) ---- -link:{ref}/tasks.html[Reference] +link:{ref}/tasks.html[Documentation] + [cols=2*] |=== |`task_id` or `taskId` @@ -4906,7 +4913,7 @@ client.tasks.get({ timeout: string }) ---- -link:{ref}/tasks.html[Reference] +link:{ref}/tasks.html[Documentation] + [cols=2*] |=== |`task_id` or `taskId` @@ -4934,7 +4941,7 @@ client.tasks.list({ timeout: string }) ---- -link:{ref}/tasks.html[Reference] +link:{ref}/tasks.html[Documentation] + [cols=2*] |=== |`nodes` @@ -4982,7 +4989,7 @@ client.termvectors({ body: object }) ---- -link:{ref}/docs-termvectors.html[Reference] +link:{ref}/docs-termvectors.html[Documentation] + [cols=2*] |=== |`index` @@ -5055,7 +5062,8 @@ client.update({ body: object }) ---- -link:{ref}/docs-update.html[Reference] +link:{ref}/docs-update.html[Documentation] + +{jsclient}/update_examples.html[Code Example] + [cols=2*] |=== |`id` @@ -5150,7 +5158,8 @@ client.updateByQuery({ body: object }) ---- -link:{ref}/docs-update-by-query.html[Reference] +link:{ref}/docs-update-by-query.html[Documentation] + +{jsclient}/update_by_query_examples.html[Code Example] + [cols=2*] |=== |`index` @@ -5278,7 +5287,7 @@ client.updateByQueryRethrottle({ requests_per_second: number }) ---- -link:{ref}/docs-update-by-query.html[Reference] +link:{ref}/docs-update-by-query.html[Documentation] + [cols=2*] |=== |`task_id` or `taskId` @@ -5305,7 +5314,7 @@ client.cat.ml.jobs({ v: boolean }) ---- -link:{ref}/ml-get-job-stats.html[Reference] +link:{ref}/ml-get-job-stats.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -5345,7 +5354,7 @@ client.ccr.deleteAutoFollowPattern({ name: string }) ---- -link:{ref}/ccr-delete-auto-follow-pattern.html[Reference] +link:{ref}/ccr-delete-auto-follow-pattern.html[Documentation] + [cols=2*] |=== |`name` @@ -5363,7 +5372,7 @@ client.ccr.follow({ body: object }) ---- -link:{ref}/ccr-put-follow.html[Reference] +link:{ref}/ccr-put-follow.html[Documentation] + [cols=2*] |=== |`index` @@ -5386,7 +5395,7 @@ client.ccr.followInfo({ index: string | string[] }) ---- -link:{ref}/ccr-get-follow-info.html[Reference] +link:{ref}/ccr-get-follow-info.html[Documentation] + [cols=2*] |=== |`index` @@ -5402,7 +5411,7 @@ client.ccr.followStats({ index: string | string[] }) ---- -link:{ref}/ccr-get-follow-stats.html[Reference] +link:{ref}/ccr-get-follow-stats.html[Documentation] + [cols=2*] |=== |`index` @@ -5419,7 +5428,7 @@ client.ccr.forgetFollower({ body: object }) ---- -link:http://www.elastic.co/guide/en/elasticsearch/reference/current[Reference] +link:http://www.elastic.co/guide/en/elasticsearch/reference/current[Documentation] + [cols=2*] |=== |`index` @@ -5438,7 +5447,7 @@ client.ccr.getAutoFollowPattern({ name: string }) ---- -link:{ref}/ccr-get-auto-follow-pattern.html[Reference] +link:{ref}/ccr-get-auto-follow-pattern.html[Documentation] + [cols=2*] |=== |`name` @@ -5454,7 +5463,7 @@ client.ccr.pauseAutoFollowPattern({ name: string }) ---- -link:{ref}/ccr-pause-auto-follow-pattern.html[Reference] +link:{ref}/ccr-pause-auto-follow-pattern.html[Documentation] + [cols=2*] |=== |`name` @@ -5470,7 +5479,7 @@ client.ccr.pauseFollow({ index: string }) ---- -link:{ref}/ccr-post-pause-follow.html[Reference] +link:{ref}/ccr-post-pause-follow.html[Documentation] + [cols=2*] |=== |`index` @@ -5487,7 +5496,7 @@ client.ccr.putAutoFollowPattern({ body: object }) ---- -link:{ref}/ccr-put-auto-follow-pattern.html[Reference] +link:{ref}/ccr-put-auto-follow-pattern.html[Documentation] + [cols=2*] |=== |`name` @@ -5506,7 +5515,7 @@ client.ccr.resumeAutoFollowPattern({ name: string }) ---- -link:{ref}/ccr-resume-auto-follow-pattern.html[Reference] +link:{ref}/ccr-resume-auto-follow-pattern.html[Documentation] + [cols=2*] |=== |`name` @@ -5523,7 +5532,7 @@ client.ccr.resumeFollow({ body: object }) ---- -link:{ref}/ccr-post-resume-follow.html[Reference] +link:{ref}/ccr-post-resume-follow.html[Documentation] + [cols=2*] |=== |`index` @@ -5540,7 +5549,7 @@ link:{ref}/ccr-post-resume-follow.html[Reference] ---- client.ccr.stats() ---- -link:{ref}/ccr-get-stats.html[Reference] +link:{ref}/ccr-get-stats.html[Documentation] + === ccr.unfollow @@ -5551,7 +5560,7 @@ client.ccr.unfollow({ index: string }) ---- -link:http://www.elastic.co/guide/en/elasticsearch/reference/current[Reference] +link:http://www.elastic.co/guide/en/elasticsearch/reference/current[Documentation] + [cols=2*] |=== |`index` @@ -5568,7 +5577,7 @@ client.dataFrameTransformDeprecated.deleteTransform({ force: boolean }) ---- -link:{ref}/delete-transform.html[Reference] +link:{ref}/delete-transform.html[Documentation] + [cols=2*] |=== |`transform_id` or `transformId` @@ -5590,7 +5599,7 @@ client.dataFrameTransformDeprecated.getTransform({ allow_no_match: boolean }) ---- -link:{ref}/get-transform.html[Reference] +link:{ref}/get-transform.html[Documentation] + [cols=2*] |=== |`transform_id` or `transformId` @@ -5618,7 +5627,7 @@ client.dataFrameTransformDeprecated.getTransformStats({ allow_no_match: boolean }) ---- -link:{ref}/get-transform-stats.html[Reference] +link:{ref}/get-transform-stats.html[Documentation] + [cols=2*] |=== |`transform_id` or `transformId` @@ -5643,7 +5652,7 @@ client.dataFrameTransformDeprecated.previewTransform({ body: object }) ---- -link:{ref}/preview-transform.html[Reference] +link:{ref}/preview-transform.html[Documentation] + [cols=2*] |=== |`body` @@ -5661,7 +5670,7 @@ client.dataFrameTransformDeprecated.putTransform({ body: object }) ---- -link:{ref}/put-transform.html[Reference] +link:{ref}/put-transform.html[Documentation] + [cols=2*] |=== |`transform_id` or `transformId` @@ -5684,7 +5693,7 @@ client.dataFrameTransformDeprecated.startTransform({ timeout: string }) ---- -link:{ref}/start-transform.html[Reference] +link:{ref}/start-transform.html[Documentation] + [cols=2*] |=== |`transform_id` or `transformId` @@ -5706,7 +5715,7 @@ client.dataFrameTransformDeprecated.stopTransform({ allow_no_match: boolean }) ---- -link:{ref}/stop-transform.html[Reference] +link:{ref}/stop-transform.html[Documentation] + [cols=2*] |=== |`transform_id` or `transformId` @@ -5733,7 +5742,7 @@ client.dataFrameTransformDeprecated.updateTransform({ body: object }) ---- -link:{ref}/update-transform.html[Reference] +link:{ref}/update-transform.html[Documentation] + [cols=2*] |=== |`transform_id` or `transformId` @@ -5755,7 +5764,7 @@ client.enrich.deletePolicy({ name: string }) ---- -link:{ref}/delete-enrich-policy-api.html[Reference] +link:{ref}/delete-enrich-policy-api.html[Documentation] + [cols=2*] |=== |`name` @@ -5772,7 +5781,7 @@ client.enrich.executePolicy({ wait_for_completion: boolean }) ---- -link:{ref}/execute-enrich-policy-api.html[Reference] +link:{ref}/execute-enrich-policy-api.html[Documentation] + [cols=2*] |=== |`name` @@ -5792,7 +5801,7 @@ client.enrich.getPolicy({ name: string }) ---- -link:{ref}/get-enrich-policy-api.html[Reference] +link:{ref}/get-enrich-policy-api.html[Documentation] + [cols=2*] |=== |`name` @@ -5809,7 +5818,7 @@ client.enrich.putPolicy({ body: object }) ---- -link:{ref}/put-enrich-policy-api.html[Reference] +link:{ref}/put-enrich-policy-api.html[Documentation] + [cols=2*] |=== |`name` @@ -5826,7 +5835,7 @@ link:{ref}/put-enrich-policy-api.html[Reference] ---- client.enrich.stats() ---- -link:{ref}/enrich-stats-api.html[Reference] +link:{ref}/enrich-stats-api.html[Documentation] + === eql.search @@ -5838,7 +5847,7 @@ client.eql.search({ body: object }) ---- -link:{ref}/eql.html[Reference] +link:{ref}/eql.html[Documentation] + [cols=2*] |=== |`index` @@ -5860,7 +5869,7 @@ client.graph.explore({ body: object }) ---- -link:{ref}/graph-explore-api.html[Reference] +link:{ref}/graph-explore-api.html[Documentation] + [cols=2*] |=== |`index` @@ -5885,7 +5894,7 @@ client.ilm.deleteLifecycle({ policy: string }) ---- -link:{ref}/ilm-delete-lifecycle.html[Reference] +link:{ref}/ilm-delete-lifecycle.html[Documentation] + [cols=2*] |=== |`policy` @@ -5903,7 +5912,7 @@ client.ilm.explainLifecycle({ only_errors: boolean }) ---- -link:{ref}/ilm-explain-lifecycle.html[Reference] +link:{ref}/ilm-explain-lifecycle.html[Documentation] + [cols=2*] |=== |`index` @@ -5925,7 +5934,7 @@ client.ilm.getLifecycle({ policy: string }) ---- -link:{ref}/ilm-get-lifecycle.html[Reference] +link:{ref}/ilm-get-lifecycle.html[Documentation] + [cols=2*] |=== |`policy` @@ -5939,7 +5948,7 @@ link:{ref}/ilm-get-lifecycle.html[Reference] ---- client.ilm.getStatus() ---- -link:{ref}/ilm-get-status.html[Reference] +link:{ref}/ilm-get-status.html[Documentation] + === ilm.moveToStep @@ -5951,7 +5960,7 @@ client.ilm.moveToStep({ body: object }) ---- -link:{ref}/ilm-move-to-step.html[Reference] +link:{ref}/ilm-move-to-step.html[Documentation] + [cols=2*] |=== |`index` @@ -5971,7 +5980,7 @@ client.ilm.putLifecycle({ body: object }) ---- -link:{ref}/ilm-put-lifecycle.html[Reference] +link:{ref}/ilm-put-lifecycle.html[Documentation] + [cols=2*] |=== |`policy` @@ -5990,7 +5999,7 @@ client.ilm.removePolicy({ index: string }) ---- -link:{ref}/ilm-remove-policy.html[Reference] +link:{ref}/ilm-remove-policy.html[Documentation] + [cols=2*] |=== |`index` @@ -6006,7 +6015,7 @@ client.ilm.retry({ index: string }) ---- -link:{ref}/ilm-retry-policy.html[Reference] +link:{ref}/ilm-retry-policy.html[Documentation] + [cols=2*] |=== |`index` @@ -6020,7 +6029,7 @@ link:{ref}/ilm-retry-policy.html[Reference] ---- client.ilm.start() ---- -link:{ref}/ilm-start.html[Reference] +link:{ref}/ilm-start.html[Documentation] + === ilm.stop @@ -6029,7 +6038,7 @@ link:{ref}/ilm-start.html[Reference] ---- client.ilm.stop() ---- -link:{ref}/ilm-stop.html[Reference] +link:{ref}/ilm-stop.html[Documentation] + === indices.freeze @@ -6046,7 +6055,7 @@ client.indices.freeze({ wait_for_active_shards: string }) ---- -link:{ref}/freeze-index-api.html[Reference] +link:{ref}/freeze-index-api.html[Documentation] + [cols=2*] |=== |`index` @@ -6084,7 +6093,7 @@ client.indices.reloadSearchAnalyzers({ expand_wildcards: 'open' | 'closed' | 'none' | 'all' }) ---- -link:{ref}/indices-reload-analyzers.html[Reference] +link:{ref}/indices-reload-analyzers.html[Documentation] + [cols=2*] |=== |`index` @@ -6116,7 +6125,7 @@ client.indices.unfreeze({ wait_for_active_shards: string }) ---- -link:{ref}/freeze-index-api.html[Reference] +link:{ref}/freeze-index-api.html[Documentation] + [cols=2*] |=== |`index` @@ -6149,7 +6158,7 @@ _Default:_ `closed` ---- client.license.delete() ---- -link:{ref}/delete-license.html[Reference] +link:{ref}/delete-license.html[Documentation] + === license.get @@ -6161,7 +6170,7 @@ client.license.get({ accept_enterprise: boolean }) ---- -link:{ref}/get-license.html[Reference] +link:{ref}/get-license.html[Documentation] + [cols=2*] |=== |`local` @@ -6180,7 +6189,7 @@ WARNING: This parameter has been deprecated. ---- client.license.getBasicStatus() ---- -link:{ref}/get-basic-status.html[Reference] +link:{ref}/get-basic-status.html[Documentation] + === license.getTrialStatus @@ -6189,7 +6198,7 @@ link:{ref}/get-basic-status.html[Reference] ---- client.license.getTrialStatus() ---- -link:{ref}/get-trial-status.html[Reference] +link:{ref}/get-trial-status.html[Documentation] + === license.post @@ -6201,7 +6210,7 @@ client.license.post({ body: object }) ---- -link:{ref}/update-license.html[Reference] +link:{ref}/update-license.html[Documentation] + [cols=2*] |=== |`acknowledge` @@ -6220,7 +6229,7 @@ client.license.postStartBasic({ acknowledge: boolean }) ---- -link:{ref}/start-basic.html[Reference] +link:{ref}/start-basic.html[Documentation] + [cols=2*] |=== |`acknowledge` @@ -6237,7 +6246,7 @@ client.license.postStartTrial({ acknowledge: boolean }) ---- -link:{ref}/start-trial.html[Reference] +link:{ref}/start-trial.html[Documentation] + [cols=2*] |=== |`type` @@ -6256,7 +6265,7 @@ client.migration.deprecations({ index: string }) ---- -link:{ref}/migration-api-deprecation.html[Reference] +link:{ref}/migration-api-deprecation.html[Documentation] + [cols=2*] |=== |`index` @@ -6276,7 +6285,7 @@ client.ml.closeJob({ body: object }) ---- -link:{ref}/ml-close-job.html[Reference] +link:{ref}/ml-close-job.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -6358,7 +6367,7 @@ client.ml.deleteDataFrameAnalytics({ force: boolean }) ---- -link:{ref}/delete-dfanalytics.html[Reference] +link:{ref}/delete-dfanalytics.html[Documentation] + [cols=2*] |=== |`id` @@ -6378,7 +6387,7 @@ client.ml.deleteDatafeed({ force: boolean }) ---- -link:{ref}/ml-delete-datafeed.html[Reference] +link:{ref}/ml-delete-datafeed.html[Documentation] + [cols=2*] |=== |`datafeed_id` or `datafeedId` @@ -6423,7 +6432,7 @@ client.ml.deleteForecast({ timeout: string }) ---- -link:{ref}/ml-delete-forecast.html[Reference] +link:{ref}/ml-delete-forecast.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -6450,7 +6459,7 @@ client.ml.deleteJob({ wait_for_completion: boolean }) ---- -link:{ref}/ml-delete-job.html[Reference] +link:{ref}/ml-delete-job.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -6474,7 +6483,7 @@ client.ml.deleteModelSnapshot({ snapshot_id: string }) ---- -link:{ref}/ml-delete-snapshot.html[Reference] +link:{ref}/ml-delete-snapshot.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -6493,7 +6502,7 @@ client.ml.deleteTrainedModel({ model_id: string }) ---- -link:{ref}/delete-inference.html[Reference] +link:{ref}/delete-inference.html[Documentation] + [cols=2*] |=== |`model_id` or `modelId` @@ -6509,7 +6518,7 @@ client.ml.evaluateDataFrame({ body: object }) ---- -link:{ref}/evaluate-dfanalytics.html[Reference] +link:{ref}/evaluate-dfanalytics.html[Documentation] + [cols=2*] |=== |`body` @@ -6526,7 +6535,7 @@ client.ml.explainDataFrameAnalytics({ body: object }) ---- -link:{ref}/explain-dfanalytics.html[Reference] +link:{ref}/explain-dfanalytics.html[Documentation] + [cols=2*] |=== |`id` @@ -6559,7 +6568,7 @@ client.ml.findFileStructure({ body: object }) ---- -link:{ref}/ml-find-file-structure.html[Reference] +link:{ref}/ml-find-file-structure.html[Documentation] + [cols=2*] |=== |`lines_to_sample` or `linesToSample` @@ -6626,7 +6635,7 @@ client.ml.flushJob({ body: object }) ---- -link:{ref}/ml-flush-job.html[Reference] +link:{ref}/ml-flush-job.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -6694,7 +6703,7 @@ client.ml.getBuckets({ body: object }) ---- -link:{ref}/ml-get-bucket.html[Reference] +link:{ref}/ml-get-bucket.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -6809,7 +6818,7 @@ client.ml.getCategories({ body: object }) ---- -link:{ref}/ml-get-category.html[Reference] +link:{ref}/ml-get-category.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -6840,7 +6849,7 @@ client.ml.getDataFrameAnalytics({ size: number }) ---- -link:{ref}/get-dfanalytics.html[Reference] +link:{ref}/get-dfanalytics.html[Documentation] + [cols=2*] |=== |`id` @@ -6870,7 +6879,7 @@ client.ml.getDataFrameAnalyticsStats({ size: number }) ---- -link:{ref}/get-dfanalytics-stats.html[Reference] +link:{ref}/get-dfanalytics-stats.html[Documentation] + [cols=2*] |=== |`id` @@ -6898,7 +6907,7 @@ client.ml.getDatafeedStats({ allow_no_datafeeds: boolean }) ---- -link:{ref}/ml-get-datafeed-stats.html[Reference] +link:{ref}/ml-get-datafeed-stats.html[Documentation] + [cols=2*] |=== |`datafeed_id` or `datafeedId` @@ -6918,7 +6927,7 @@ client.ml.getDatafeeds({ allow_no_datafeeds: boolean }) ---- -link:{ref}/ml-get-datafeed.html[Reference] +link:{ref}/ml-get-datafeed.html[Documentation] + [cols=2*] |=== |`datafeed_id` or `datafeedId` @@ -6969,7 +6978,7 @@ client.ml.getInfluencers({ body: object }) ---- -link:{ref}/ml-get-influencer.html[Reference] +link:{ref}/ml-get-influencer.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -7013,7 +7022,7 @@ client.ml.getJobStats({ allow_no_jobs: boolean }) ---- -link:{ref}/ml-get-job-stats.html[Reference] +link:{ref}/ml-get-job-stats.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -7033,7 +7042,7 @@ client.ml.getJobs({ allow_no_jobs: boolean }) ---- -link:{ref}/ml-get-job.html[Reference] +link:{ref}/ml-get-job.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -7060,7 +7069,7 @@ client.ml.getModelSnapshots({ body: object }) ---- -link:{ref}/ml-get-snapshot.html[Reference] +link:{ref}/ml-get-snapshot.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -7108,7 +7117,7 @@ client.ml.getOverallBuckets({ body: object }) ---- -link:{ref}/ml-get-overall-buckets.html[Reference] +link:{ref}/ml-get-overall-buckets.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -7157,7 +7166,7 @@ client.ml.getRecords({ body: object }) ---- -link:{ref}/ml-get-record.html[Reference] +link:{ref}/ml-get-record.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -7206,7 +7215,7 @@ client.ml.getTrainedModels({ tags: string | string[] }) ---- -link:{ref}/get-inference.html[Reference] +link:{ref}/get-inference.html[Documentation] + [cols=2*] |=== |`model_id` or `modelId` @@ -7246,7 +7255,7 @@ client.ml.getTrainedModelsStats({ size: number }) ---- -link:{ref}/get-inference-stats.html[Reference] +link:{ref}/get-inference-stats.html[Documentation] + [cols=2*] |=== |`model_id` or `modelId` @@ -7281,7 +7290,7 @@ client.ml.openJob({ job_id: string }) ---- -link:{ref}/ml-open-job.html[Reference] +link:{ref}/ml-open-job.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -7319,7 +7328,7 @@ client.ml.postData({ body: object }) ---- -link:{ref}/ml-post-data.html[Reference] +link:{ref}/ml-post-data.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -7344,7 +7353,7 @@ client.ml.previewDatafeed({ datafeed_id: string }) ---- -link:{ref}/ml-preview-datafeed.html[Reference] +link:{ref}/ml-preview-datafeed.html[Documentation] + [cols=2*] |=== |`datafeed_id` or `datafeedId` @@ -7399,7 +7408,7 @@ client.ml.putDataFrameAnalytics({ body: object }) ---- -link:{ref}/put-dfanalytics.html[Reference] +link:{ref}/put-dfanalytics.html[Documentation] + [cols=2*] |=== |`id` @@ -7419,7 +7428,7 @@ client.ml.putDatafeed({ body: object }) ---- -link:{ref}/ml-put-datafeed.html[Reference] +link:{ref}/ml-put-datafeed.html[Documentation] + [cols=2*] |=== |`datafeed_id` or `datafeedId` @@ -7458,7 +7467,7 @@ client.ml.putJob({ body: object }) ---- -link:{ref}/ml-put-job.html[Reference] +link:{ref}/ml-put-job.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -7478,7 +7487,7 @@ client.ml.putTrainedModel({ body: object }) ---- -link:TODO[Reference] +link:TODO[Documentation] + [cols=2*] |=== |`model_id` or `modelId` @@ -7500,7 +7509,7 @@ client.ml.revertModelSnapshot({ body: object }) ---- -link:{ref}/ml-revert-snapshot.html[Reference] +link:{ref}/ml-revert-snapshot.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -7526,7 +7535,7 @@ client.ml.setUpgradeMode({ timeout: string }) ---- -link:{ref}/ml-set-upgrade-mode.html[Reference] +link:{ref}/ml-set-upgrade-mode.html[Documentation] + [cols=2*] |=== |`enabled` @@ -7547,7 +7556,7 @@ client.ml.startDataFrameAnalytics({ body: object }) ---- -link:{ref}/start-dfanalytics.html[Reference] +link:{ref}/start-dfanalytics.html[Documentation] + [cols=2*] |=== |`id` @@ -7573,7 +7582,7 @@ client.ml.startDatafeed({ body: object }) ---- -link:{ref}/ml-start-datafeed.html[Reference] +link:{ref}/ml-start-datafeed.html[Documentation] + [cols=2*] |=== |`datafeed_id` or `datafeedId` @@ -7605,7 +7614,7 @@ client.ml.stopDataFrameAnalytics({ body: object }) ---- -link:{ref}/stop-dfanalytics.html[Reference] +link:{ref}/stop-dfanalytics.html[Documentation] + [cols=2*] |=== |`id` @@ -7636,7 +7645,7 @@ client.ml.stopDatafeed({ timeout: string }) ---- -link:{ref}/ml-stop-datafeed.html[Reference] +link:{ref}/ml-stop-datafeed.html[Documentation] + [cols=2*] |=== |`datafeed_id` or `datafeedId` @@ -7662,7 +7671,7 @@ client.ml.updateDatafeed({ body: object }) ---- -link:{ref}/ml-update-datafeed.html[Reference] +link:{ref}/ml-update-datafeed.html[Documentation] + [cols=2*] |=== |`datafeed_id` or `datafeedId` @@ -7701,7 +7710,7 @@ client.ml.updateJob({ body: object }) ---- -link:{ref}/ml-update-job.html[Reference] +link:{ref}/ml-update-job.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -7722,7 +7731,7 @@ client.ml.updateModelSnapshot({ body: object }) ---- -link:{ref}/ml-update-snapshot.html[Reference] +link:{ref}/ml-update-snapshot.html[Documentation] + [cols=2*] |=== |`job_id` or `jobId` @@ -7778,7 +7787,7 @@ client.monitoring.bulk({ body: object }) ---- -link:{ref}/es-monitoring.html[Reference] +link:{ref}/es-monitoring.html[Documentation] + [cols=2*] |=== |`type` @@ -7956,7 +7965,7 @@ client.rollup.stopJob({ ---- client.security.authenticate() ---- -link:{ref}/security-api-authenticate.html[Reference] +link:{ref}/security-api-authenticate.html[Documentation] + === security.changePassword @@ -7969,7 +7978,7 @@ client.security.changePassword({ body: object }) ---- -link:{ref}/security-api-change-password.html[Reference] +link:{ref}/security-api-change-password.html[Documentation] + [cols=2*] |=== |`username` @@ -7992,7 +8001,7 @@ client.security.clearCachedRealms({ usernames: string | string[] }) ---- -link:{ref}/security-api-clear-cache.html[Reference] +link:{ref}/security-api-clear-cache.html[Documentation] + [cols=2*] |=== |`realms` @@ -8011,7 +8020,7 @@ client.security.clearCachedRoles({ name: string | string[] }) ---- -link:{ref}/security-api-clear-role-cache.html[Reference] +link:{ref}/security-api-clear-role-cache.html[Documentation] + [cols=2*] |=== |`name` @@ -8028,7 +8037,7 @@ client.security.createApiKey({ body: object }) ---- -link:{ref}/security-api-create-api-key.html[Reference] +link:{ref}/security-api-create-api-key.html[Documentation] + [cols=2*] |=== |`refresh` @@ -8049,7 +8058,7 @@ client.security.deletePrivileges({ refresh: 'true' | 'false' | 'wait_for' }) ---- -link:TODO[Reference] +link:TODO[Documentation] + [cols=2*] |=== |`application` @@ -8072,7 +8081,7 @@ client.security.deleteRole({ refresh: 'true' | 'false' | 'wait_for' }) ---- -link:{ref}/security-api-delete-role.html[Reference] +link:{ref}/security-api-delete-role.html[Documentation] + [cols=2*] |=== |`name` @@ -8092,7 +8101,7 @@ client.security.deleteRoleMapping({ refresh: 'true' | 'false' | 'wait_for' }) ---- -link:{ref}/security-api-delete-role-mapping.html[Reference] +link:{ref}/security-api-delete-role-mapping.html[Documentation] + [cols=2*] |=== |`name` @@ -8112,7 +8121,7 @@ client.security.deleteUser({ refresh: 'true' | 'false' | 'wait_for' }) ---- -link:{ref}/security-api-delete-user.html[Reference] +link:{ref}/security-api-delete-user.html[Documentation] + [cols=2*] |=== |`username` @@ -8132,7 +8141,7 @@ client.security.disableUser({ refresh: 'true' | 'false' | 'wait_for' }) ---- -link:{ref}/security-api-disable-user.html[Reference] +link:{ref}/security-api-disable-user.html[Documentation] + [cols=2*] |=== |`username` @@ -8152,7 +8161,7 @@ client.security.enableUser({ refresh: 'true' | 'false' | 'wait_for' }) ---- -link:{ref}/security-api-enable-user.html[Reference] +link:{ref}/security-api-enable-user.html[Documentation] + [cols=2*] |=== |`username` @@ -8175,7 +8184,7 @@ client.security.getApiKey({ owner: boolean }) ---- -link:{ref}/security-api-get-api-key.html[Reference] +link:{ref}/security-api-get-api-key.html[Documentation] + [cols=2*] |=== |`id` @@ -8201,7 +8210,7 @@ link:{ref}/security-api-get-api-key.html[Reference] ---- client.security.getBuiltinPrivileges() ---- -link:{ref}/security-api-get-builtin-privileges.html[Reference] +link:{ref}/security-api-get-builtin-privileges.html[Documentation] + === security.getPrivileges @@ -8213,7 +8222,7 @@ client.security.getPrivileges({ name: string }) ---- -link:{ref}/security-api-get-privileges.html[Reference] +link:{ref}/security-api-get-privileges.html[Documentation] + [cols=2*] |=== |`application` @@ -8232,7 +8241,7 @@ client.security.getRole({ name: string }) ---- -link:{ref}/security-api-get-role.html[Reference] +link:{ref}/security-api-get-role.html[Documentation] + [cols=2*] |=== |`name` @@ -8248,7 +8257,7 @@ client.security.getRoleMapping({ name: string }) ---- -link:{ref}/security-api-get-role-mapping.html[Reference] +link:{ref}/security-api-get-role-mapping.html[Documentation] + [cols=2*] |=== |`name` @@ -8264,7 +8273,7 @@ client.security.getToken({ body: object }) ---- -link:{ref}/security-api-get-token.html[Reference] +link:{ref}/security-api-get-token.html[Documentation] + [cols=2*] |=== |`body` @@ -8280,7 +8289,7 @@ client.security.getUser({ username: string | string[] }) ---- -link:{ref}/security-api-get-user.html[Reference] +link:{ref}/security-api-get-user.html[Documentation] + [cols=2*] |=== |`username` @@ -8294,7 +8303,7 @@ link:{ref}/security-api-get-user.html[Reference] ---- client.security.getUserPrivileges() ---- -link:{ref}/security-api-get-privileges.html[Reference] +link:{ref}/security-api-get-privileges.html[Documentation] + === security.hasPrivileges @@ -8306,7 +8315,7 @@ client.security.hasPrivileges({ body: object }) ---- -link:{ref}/security-api-has-privileges.html[Reference] +link:{ref}/security-api-has-privileges.html[Documentation] + [cols=2*] |=== |`user` @@ -8325,7 +8334,7 @@ client.security.invalidateApiKey({ body: object }) ---- -link:{ref}/security-api-invalidate-api-key.html[Reference] +link:{ref}/security-api-invalidate-api-key.html[Documentation] + [cols=2*] |=== |`body` @@ -8341,7 +8350,7 @@ client.security.invalidateToken({ body: object }) ---- -link:{ref}/security-api-invalidate-token.html[Reference] +link:{ref}/security-api-invalidate-token.html[Documentation] + [cols=2*] |=== |`body` @@ -8358,7 +8367,7 @@ client.security.putPrivileges({ body: object }) ---- -link:TODO[Reference] +link:TODO[Documentation] + [cols=2*] |=== |`refresh` @@ -8379,7 +8388,7 @@ client.security.putRole({ body: object }) ---- -link:{ref}/security-api-put-role.html[Reference] +link:{ref}/security-api-put-role.html[Documentation] + [cols=2*] |=== |`name` @@ -8403,7 +8412,7 @@ client.security.putRoleMapping({ body: object }) ---- -link:{ref}/security-api-put-role-mapping.html[Reference] +link:{ref}/security-api-put-role-mapping.html[Documentation] + [cols=2*] |=== |`name` @@ -8427,7 +8436,7 @@ client.security.putUser({ body: object }) ---- -link:{ref}/security-api-put-user.html[Reference] +link:{ref}/security-api-put-user.html[Documentation] + [cols=2*] |=== |`username` @@ -8449,7 +8458,7 @@ client.slm.deleteLifecycle({ policy_id: string }) ---- -link:{ref}/slm-api-delete-policy.html[Reference] +link:{ref}/slm-api-delete-policy.html[Documentation] + [cols=2*] |=== |`policy_id` or `policyId` @@ -8465,7 +8474,7 @@ client.slm.executeLifecycle({ policy_id: string }) ---- -link:{ref}/slm-api-execute-lifecycle.html[Reference] +link:{ref}/slm-api-execute-lifecycle.html[Documentation] + [cols=2*] |=== |`policy_id` or `policyId` @@ -8479,7 +8488,7 @@ link:{ref}/slm-api-execute-lifecycle.html[Reference] ---- client.slm.executeRetention() ---- -link:{ref}/slm-api-execute-retention.html[Reference] +link:{ref}/slm-api-execute-retention.html[Documentation] + === slm.getLifecycle @@ -8490,7 +8499,7 @@ client.slm.getLifecycle({ policy_id: string | string[] }) ---- -link:{ref}/slm-api-get-policy.html[Reference] +link:{ref}/slm-api-get-policy.html[Documentation] + [cols=2*] |=== |`policy_id` or `policyId` @@ -8504,7 +8513,7 @@ link:{ref}/slm-api-get-policy.html[Reference] ---- client.slm.getStats() ---- -link:{ref}/slm-api-get-stats.html[Reference] +link:{ref}/slm-api-get-stats.html[Documentation] + === slm.getStatus @@ -8513,7 +8522,7 @@ link:{ref}/slm-api-get-stats.html[Reference] ---- client.slm.getStatus() ---- -link:{ref}/slm-api-get-status.html[Reference] +link:{ref}/slm-api-get-status.html[Documentation] + === slm.putLifecycle @@ -8525,7 +8534,7 @@ client.slm.putLifecycle({ body: object }) ---- -link:{ref}/slm-api-put-policy.html[Reference] +link:{ref}/slm-api-put-policy.html[Documentation] + [cols=2*] |=== |`policy_id` or `policyId` @@ -8542,7 +8551,7 @@ link:{ref}/slm-api-put-policy.html[Reference] ---- client.slm.start() ---- -link:{ref}/slm-api-start.html[Reference] +link:{ref}/slm-api-start.html[Documentation] + === slm.stop @@ -8551,7 +8560,7 @@ link:{ref}/slm-api-start.html[Reference] ---- client.slm.stop() ---- -link:{ref}/slm-api-stop.html[Reference] +link:{ref}/slm-api-stop.html[Documentation] + === sql.clearCursor @@ -8562,7 +8571,7 @@ client.sql.clearCursor({ body: object }) ---- -link:{ref}/sql-pagination.html[Reference] +link:{ref}/sql-pagination.html[Documentation] + [cols=2*] |=== |`body` @@ -8579,7 +8588,8 @@ client.sql.query({ body: object }) ---- -link:{ref}/sql-rest-overview.html[Reference] +link:{ref}/sql-rest-overview.html[Documentation] + +{jsclient}/sql_query_examples.html[Code Example] + [cols=2*] |=== |`format` @@ -8598,7 +8608,7 @@ client.sql.translate({ body: object }) ---- -link:{ref}/sql-translate.html[Reference] +link:{ref}/sql-translate.html[Documentation] + [cols=2*] |=== |`body` @@ -8612,7 +8622,7 @@ link:{ref}/sql-translate.html[Reference] ---- client.ssl.certificates() ---- -link:{ref}/security-api-ssl.html[Reference] +link:{ref}/security-api-ssl.html[Documentation] + === transform.deleteTransform @@ -8624,7 +8634,7 @@ client.transform.deleteTransform({ force: boolean }) ---- -link:{ref}/delete-transform.html[Reference] +link:{ref}/delete-transform.html[Documentation] + [cols=2*] |=== |`transform_id` or `transformId` @@ -8646,7 +8656,7 @@ client.transform.getTransform({ allow_no_match: boolean }) ---- -link:{ref}/get-transform.html[Reference] +link:{ref}/get-transform.html[Documentation] + [cols=2*] |=== |`transform_id` or `transformId` @@ -8674,7 +8684,7 @@ client.transform.getTransformStats({ allow_no_match: boolean }) ---- -link:{ref}/get-transform-stats.html[Reference] +link:{ref}/get-transform-stats.html[Documentation] + [cols=2*] |=== |`transform_id` or `transformId` @@ -8699,7 +8709,7 @@ client.transform.previewTransform({ body: object }) ---- -link:{ref}/preview-transform.html[Reference] +link:{ref}/preview-transform.html[Documentation] + [cols=2*] |=== |`body` @@ -8717,7 +8727,7 @@ client.transform.putTransform({ body: object }) ---- -link:{ref}/put-transform.html[Reference] +link:{ref}/put-transform.html[Documentation] + [cols=2*] |=== |`transform_id` or `transformId` @@ -8740,7 +8750,7 @@ client.transform.startTransform({ timeout: string }) ---- -link:{ref}/start-transform.html[Reference] +link:{ref}/start-transform.html[Documentation] + [cols=2*] |=== |`transform_id` or `transformId` @@ -8764,7 +8774,7 @@ client.transform.stopTransform({ wait_for_checkpoint: boolean }) ---- -link:{ref}/stop-transform.html[Reference] +link:{ref}/stop-transform.html[Documentation] + [cols=2*] |=== |`transform_id` or `transformId` @@ -8797,7 +8807,7 @@ client.transform.updateTransform({ body: object }) ---- -link:{ref}/update-transform.html[Reference] +link:{ref}/update-transform.html[Documentation] + [cols=2*] |=== |`transform_id` or `transformId` @@ -8820,7 +8830,7 @@ client.watcher.ackWatch({ action_id: string | string[] }) ---- -link:{ref}/watcher-api-ack-watch.html[Reference] +link:{ref}/watcher-api-ack-watch.html[Documentation] + [cols=2*] |=== |`watch_id` or `watchId` @@ -8839,7 +8849,7 @@ client.watcher.activateWatch({ watch_id: string }) ---- -link:{ref}/watcher-api-activate-watch.html[Reference] +link:{ref}/watcher-api-activate-watch.html[Documentation] + [cols=2*] |=== |`watch_id` or `watchId` @@ -8855,7 +8865,7 @@ client.watcher.deactivateWatch({ watch_id: string }) ---- -link:{ref}/watcher-api-deactivate-watch.html[Reference] +link:{ref}/watcher-api-deactivate-watch.html[Documentation] + [cols=2*] |=== |`watch_id` or `watchId` @@ -8871,7 +8881,7 @@ client.watcher.deleteWatch({ id: string }) ---- -link:{ref}/watcher-api-delete-watch.html[Reference] +link:{ref}/watcher-api-delete-watch.html[Documentation] + [cols=2*] |=== |`id` @@ -8889,7 +8899,7 @@ client.watcher.executeWatch({ body: object }) ---- -link:{ref}/watcher-api-execute-watch.html[Reference] +link:{ref}/watcher-api-execute-watch.html[Documentation] + [cols=2*] |=== |`id` @@ -8911,7 +8921,7 @@ client.watcher.getWatch({ id: string }) ---- -link:{ref}/watcher-api-get-watch.html[Reference] +link:{ref}/watcher-api-get-watch.html[Documentation] + [cols=2*] |=== |`id` @@ -8932,7 +8942,7 @@ client.watcher.putWatch({ body: object }) ---- -link:{ref}/watcher-api-put-watch.html[Reference] +link:{ref}/watcher-api-put-watch.html[Documentation] + [cols=2*] |=== |`id` @@ -8961,7 +8971,7 @@ link:{ref}/watcher-api-put-watch.html[Reference] ---- client.watcher.start() ---- -link:{ref}/watcher-api-start.html[Reference] +link:{ref}/watcher-api-start.html[Documentation] + === watcher.stats @@ -8973,7 +8983,7 @@ client.watcher.stats({ emit_stacktraces: boolean }) ---- -link:{ref}/watcher-api-stats.html[Reference] +link:{ref}/watcher-api-stats.html[Documentation] + [cols=2*] |=== |`metric` @@ -8990,7 +9000,7 @@ link:{ref}/watcher-api-stats.html[Reference] ---- client.watcher.stop() ---- -link:{ref}/watcher-api-stop.html[Reference] +link:{ref}/watcher-api-stop.html[Documentation] + === xpack.info @@ -9001,7 +9011,7 @@ client.xpack.info({ categories: string | string[] }) ---- -link:{ref}/info-api.html[Reference] +link:{ref}/info-api.html[Documentation] + [cols=2*] |=== |`categories` @@ -9017,7 +9027,7 @@ client.xpack.usage({ master_timeout: string }) ---- -link:Retrieve information about xpack features usage[Reference] +link:Retrieve information about xpack features usage[Documentation] + [cols=2*] |=== |`master_timeout` or `masterTimeout` diff --git a/scripts/utils/generateDocs.js b/scripts/utils/generateDocs.js index 6457d2933..4261520d2 100644 --- a/scripts/utils/generateDocs.js +++ b/scripts/utils/generateDocs.js @@ -4,8 +4,14 @@ 'use strict' +const { readdirSync } = require('fs') +const { join } = require('path') const dedent = require('dedent') +const codeExamples = readdirSync(join(__dirname, '..', '..', 'docs', 'examples')) + .map(file => file.slice(0, -9)) + .filter(api => api !== 'index') + function generateDocs (common, spec) { var doc = dedent` [[api-reference]] @@ -93,7 +99,7 @@ function commonParameters (spec) { === Common parameters Parameters that are accepted by all API endpoints. - link:{ref}/common-options.html[Reference] + link:{ref}/common-options.html[Documentation] [cols=2*] |===\n` Object.keys(spec.params).forEach(key => { @@ -196,7 +202,10 @@ function generateApiDoc (spec) { client.${camelify(name)}(${codeParameters.length > 0 ? `{\n ${codeParameters}\n}` : ''}) ----\n` if (documentationUrl) { - doc += `link:${documentationUrl}[Reference]\n` + doc += `link:${documentationUrl}[Documentation] +\n` + } + if (codeExamples.includes(name)) { + doc += `{jsclient}/${name.replace(/\./g, '_')}_examples.html[Code Example] +\n` } if (params.length !== 0) {