API generation

This commit is contained in:
delvedor
2020-11-18 18:06:04 +01:00
parent 66a4739018
commit 90f6003dd7
6 changed files with 95 additions and 167 deletions

View File

@ -724,7 +724,6 @@ client.cat.indices({
index: string | string[],
format: string,
bytes: 'b' | 'k' | 'kb' | 'm' | 'mb' | 'g' | 'gb' | 't' | 'tb' | 'p' | 'pb',
local: boolean,
master_timeout: string,
h: string | string[],
health: 'green' | 'yellow' | 'red',
@ -749,11 +748,6 @@ link:{ref}/cat-indices.html[Documentation] +
|`bytes`
|`'b' \| 'k' \| 'kb' \| 'm' \| 'mb' \| 'g' \| 'gb' \| 't' \| 'tb' \| 'p' \| 'pb'` - The unit in which to display byte values
|`local`
|`boolean` - Return local information, do not retrieve the state from master node (default: false) +
WARNING: This parameter has been deprecated.
|`master_timeout` or `masterTimeout`
|`string` - Explicit operation timeout for connection to master node
@ -1362,7 +1356,6 @@ client.cat.shards({
index: string | string[],
format: string,
bytes: 'b' | 'k' | 'kb' | 'm' | 'mb' | 'g' | 'gb' | 't' | 'tb' | 'p' | 'pb',
local: boolean,
master_timeout: string,
h: string | string[],
help: boolean,
@ -1383,11 +1376,6 @@ link:{ref}/cat-shards.html[Documentation] +
|`bytes`
|`'b' \| 'k' \| 'kb' \| 'm' \| 'mb' \| 'g' \| 'gb' \| 't' \| 'tb' \| 'p' \| 'pb'` - The unit in which to display byte values
|`local`
|`boolean` - Return local information, do not retrieve the state from master node (default: false) +
WARNING: This parameter has been deprecated.
|`master_timeout` or `masterTimeout`
|`string` - Explicit operation timeout for connection to master node
@ -1959,7 +1947,7 @@ link:{ref}/cluster-allocation-explain.html[Documentation] +
[discrete]
=== cluster.deleteComponentTemplate
*Stability:* experimental
[source,ts]
----
client.cluster.deleteComponentTemplate({
@ -2002,7 +1990,7 @@ _Default:_ `true`
[discrete]
=== cluster.existsComponentTemplate
*Stability:* experimental
[source,ts]
----
client.cluster.existsComponentTemplate({
@ -2027,7 +2015,7 @@ link:{ref}/indices-component-template.html[Documentation] +
[discrete]
=== cluster.getComponentTemplate
*Stability:* experimental
[source,ts]
----
client.cluster.getComponentTemplate({
@ -2191,7 +2179,7 @@ _Default:_ `30s`
[discrete]
=== cluster.putComponentTemplate
*Stability:* experimental
[source,ts]
----
client.cluster.putComponentTemplate({
@ -4022,7 +4010,7 @@ _Default:_ `open`
[discrete]
=== indices.deleteIndexTemplate
*Stability:* experimental
[source,ts]
----
client.indices.deleteIndexTemplate({
@ -4152,7 +4140,7 @@ _Default:_ `all`
[discrete]
=== indices.existsIndexTemplate
*Stability:* experimental
[source,ts]
----
client.indices.existsIndexTemplate({
@ -4518,7 +4506,7 @@ _Default:_ `open`
[discrete]
=== indices.getIndexTemplate
*Stability:* experimental
[source,ts]
----
client.indices.getIndexTemplate({
@ -4664,36 +4652,6 @@ link:{ref}/indices-templates.html[Documentation] +
|===
[discrete]
=== indices.getUpgrade
[source,ts]
----
client.indices.getUpgrade({
index: string | string[],
ignore_unavailable: boolean,
allow_no_indices: boolean,
expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all'
})
----
link:{ref}/indices-upgrade.html[Documentation] +
[cols=2*]
|===
|`index`
|`string \| string[]` - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|`ignore_unavailable` or `ignoreUnavailable`
|`boolean` - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|`allow_no_indices` or `allowNoIndices`
|`boolean` - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|`expand_wildcards` or `expandWildcards`
|`'open' \| 'closed' \| 'hidden' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. +
_Default:_ `open`
|===
[discrete]
=== indices.migrateToDataStream
@ -4788,7 +4746,7 @@ link:{ref}/indices-aliases.html[Documentation] +
[discrete]
=== indices.putIndexTemplate
*Stability:* experimental
[source,ts]
----
client.indices.putIndexTemplate({
@ -5203,7 +5161,7 @@ link:{ref}/indices-shrink-index.html[Documentation] +
[discrete]
=== indices.simulateIndexTemplate
*Stability:* experimental
[source,ts]
----
client.indices.simulateIndexTemplate({
@ -5236,7 +5194,7 @@ link:{ref}/indices-templates.html[Documentation] +
[discrete]
=== indices.simulateTemplate
*Stability:* experimental
[source,ts]
----
client.indices.simulateTemplate({
@ -5435,44 +5393,6 @@ link:{ref}/indices-aliases.html[Documentation] +
|===
[discrete]
=== indices.upgrade
[source,ts]
----
client.indices.upgrade({
index: string | string[],
allow_no_indices: boolean,
expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all',
ignore_unavailable: boolean,
wait_for_completion: boolean,
only_ancient_segments: boolean
})
----
link:{ref}/indices-upgrade.html[Documentation] +
[cols=2*]
|===
|`index`
|`string \| string[]` - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|`allow_no_indices` or `allowNoIndices`
|`boolean` - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|`expand_wildcards` or `expandWildcards`
|`'open' \| 'closed' \| 'hidden' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. +
_Default:_ `open`
|`ignore_unavailable` or `ignoreUnavailable`
|`boolean` - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|`wait_for_completion` or `waitForCompletion`
|`boolean` - Specify whether the request should block until the all segments are upgraded (default: false)
|`only_ancient_segments` or `onlyAncientSegments`
|`boolean` - If true, only ancient (an older Lucene major release) segments will be upgraded
|===
[discrete]
=== indices.validateQuery
@ -7568,6 +7488,35 @@ link:{ref}/ml-update-snapshot.html[Documentation] +
|===
[discrete]
=== ml.upgradeJobSnapshot
[source,ts]
----
client.ml.upgradeJobSnapshot({
job_id: string,
snapshot_id: string,
timeout: timevalue,
wait_for_completion: boolean
})
----
link:{ref}/ml-upgrade-job-model-snapshot.html[Documentation] +
[cols=2*]
|===
|`job_id` or `jobId`
|`string` - The ID of the job
|`snapshot_id` or `snapshotId`
|`string` - The ID of the snapshot
|`timeout`
|`timevalue` - How long should the API wait for the job to be opened and the old snapshot to be loaded.
|`wait_for_completion` or `waitForCompletion`
|`boolean` - Should the request wait until the task is complete before responding to the caller. Default is false.
|===
[discrete]
=== ml.validate