API generation

This commit is contained in:
delvedor
2020-07-20 12:17:14 +02:00
parent 1e8bcbebfe
commit e6a4050b0b
14 changed files with 215 additions and 88 deletions

View File

@ -110,6 +110,7 @@ client.bulk({
_source_excludes: string | string[],
_source_includes: string | string[],
pipeline: string,
require_alias: boolean,
body: object
})
----
@ -147,6 +148,9 @@ link:{ref}/docs-bulk.html[Documentation] +
|`pipeline`
|`string` - The pipeline id to preprocess incoming documents with
|`require_alias` or `requireAlias`
|`boolean` - Sets require_alias for all incoming documents. Defaults to unset (false)
|`body`
|`object` - The operation definition and data (action-data pairs), separated by newlines
@ -2362,6 +2366,7 @@ client.index({
if_seq_no: number,
if_primary_term: number,
pipeline: string,
require_alias: boolean,
body: object
})
----
@ -2404,6 +2409,9 @@ link:{ref}/docs-index_.html[Documentation] +
|`pipeline`
|`string` - The pipeline id to preprocess incoming documents with
|`require_alias` or `requireAlias`
|`boolean` - When true, requires destination to be an alias. Default is false
|`body`
|`object` - The document
@ -2624,26 +2632,6 @@ link:{ref}/indices-create-index.html[Documentation] +
|===
=== indices.createDataStream
*Stability:* experimental
[source,ts]
----
client.indices.createDataStream({
name: string,
body: object
})
----
link:{ref}/data-streams.html[Documentation] +
[cols=2*]
|===
|`name`
|`string` - The name of the data stream
|`body`
|`object` - The data stream definition
|===
=== indices.delete
[source,ts]
@ -2709,22 +2697,6 @@ link:{ref}/indices-aliases.html[Documentation] +
|===
=== indices.deleteDataStream
*Stability:* experimental
[source,ts]
----
client.indices.deleteDataStream({
name: string | string[]
})
----
link:{ref}/data-streams.html[Documentation] +
[cols=2*]
|===
|`name`
|`string \| string[]` - A comma-separated list of data streams to delete; use `*` to delete all data streams
|===
=== indices.deleteIndexTemplate
*Stability:* experimental
[source,ts]
@ -3104,22 +3076,6 @@ _Default:_ `all`
|===
=== indices.getDataStream
*Stability:* experimental
[source,ts]
----
client.indices.getDataStream({
name: string | string[]
})
----
link:{ref}/data-streams.html[Documentation] +
[cols=2*]
|===
|`name`
|`string \| string[]` - A comma-separated list of data streams to get; use `*` to get all data streams
|===
=== indices.getFieldMapping
[source,ts]
@ -3450,6 +3406,7 @@ client.indices.putMapping({
ignore_unavailable: boolean,
allow_no_indices: boolean,
expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all',
write_index_only: boolean,
body: object
})
----
@ -3475,6 +3432,9 @@ link:{ref}/indices-put-mapping.html[Documentation] +
|`'open' \| 'closed' \| 'hidden' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. +
_Default:_ `open`
|`write_index_only` or `writeIndexOnly`
|`boolean` - When true, applies mappings only to the write index of an alias or data stream
|`body`
|`object` - The mapping definition
@ -5573,6 +5533,7 @@ client.update({
timeout: string,
if_seq_no: number,
if_primary_term: number,
require_alias: boolean,
body: object
})
----
@ -5624,6 +5585,9 @@ WARNING: This parameter has been deprecated.
|`if_primary_term` or `ifPrimaryTerm`
|`number` - only perform the update operation if the last operation that has changed the document has the specified primary term
|`require_alias` or `requireAlias`
|`boolean` - When true, requires destination is an alias. Default is false
|`body`
|`object` - The request definition requires either `script` or partial `doc`
@ -7109,6 +7073,58 @@ client.ilm.stop()
link:{ref}/ilm-stop.html[Documentation] +
=== indices.createDataStream
*Stability:* experimental
[source,ts]
----
client.indices.createDataStream({
name: string,
body: object
})
----
link:{ref}/data-streams.html[Documentation] +
[cols=2*]
|===
|`name`
|`string` - The name of the data stream
|`body`
|`object` - The data stream definition
|===
=== indices.dataStreamsStats
*Stability:* experimental
[source,ts]
----
client.indices.dataStreamsStats({
name: string | string[]
})
----
link:{ref}/data-streams.html[Documentation] +
[cols=2*]
|===
|`name`
|`string \| string[]` - A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams
|===
=== indices.deleteDataStream
*Stability:* experimental
[source,ts]
----
client.indices.deleteDataStream({
name: string | string[]
})
----
link:{ref}/data-streams.html[Documentation] +
[cols=2*]
|===
|`name`
|`string \| string[]` - A comma-separated list of data streams to delete; use `*` to delete all data streams
|===
=== indices.freeze
[source,ts]
@ -7150,6 +7166,22 @@ _Default:_ `closed`
|===
=== indices.getDataStream
*Stability:* experimental
[source,ts]
----
client.indices.getDataStream({
name: string | string[]
})
----
link:{ref}/data-streams.html[Documentation] +
[cols=2*]
|===
|`name`
|`string \| string[]` - A comma-separated list of data streams to get; use `*` to get all data streams
|===
=== indices.reloadSearchAnalyzers
[source,ts]
@ -7999,7 +8031,8 @@ client.ml.getDataFrameAnalyticsStats({
id: string,
allow_no_match: boolean,
from: number,
size: number
size: number,
verbose: boolean
})
----
link:{ref}/get-dfanalytics-stats.html[Documentation] +
@ -8019,6 +8052,9 @@ _Default:_ `true`
|`number` - specifies a max number of analytics to get +
_Default:_ `100`
|`verbose`
|`boolean` - whether the stats response should be verbose
|===
=== ml.getDatafeedStats