API generation

This commit is contained in:
delvedor
2020-10-21 11:07:32 +02:00
parent c901c7816b
commit c1dfb013ef
8 changed files with 194 additions and 17 deletions

View File

@ -6609,7 +6609,8 @@ client.ml.getDataFrameAnalytics({
id: string,
allow_no_match: boolean,
from: number,
size: number
size: number,
exclude_generated: boolean
})
----
link:{ref}/get-dfanalytics.html[Documentation] +
@ -6629,6 +6630,9 @@ _Default:_ `true`
|`number` - specifies a max number of analytics to get +
_Default:_ `100`
|`exclude_generated` or `excludeGenerated`
|`boolean` - Omits fields that are illegal to set on data frame analytics PUT
|===
[discrete]
@ -6701,7 +6705,8 @@ WARNING: This parameter has been deprecated.
client.ml.getDatafeeds({
datafeed_id: string,
allow_no_match: boolean,
allow_no_datafeeds: boolean
allow_no_datafeeds: boolean,
exclude_generated: boolean
})
----
link:{ref}/ml-get-datafeed.html[Documentation] +
@ -6718,6 +6723,9 @@ link:{ref}/ml-get-datafeed.html[Documentation] +
WARNING: This parameter has been deprecated.
|`exclude_generated` or `excludeGenerated`
|`boolean` - Omits fields that are illegal to set on datafeed PUT
|===
[discrete]
@ -6833,7 +6841,8 @@ WARNING: This parameter has been deprecated.
client.ml.getJobs({
job_id: string,
allow_no_match: boolean,
allow_no_jobs: boolean
allow_no_jobs: boolean,
exclude_generated: boolean
})
----
link:{ref}/ml-get-job.html[Documentation] +
@ -6850,6 +6859,9 @@ link:{ref}/ml-get-job.html[Documentation] +
WARNING: This parameter has been deprecated.
|`exclude_generated` or `excludeGenerated`
|`boolean` - Omits fields that are illegal to set on job PUT
|===
[discrete]
@ -7023,7 +7035,7 @@ client.ml.getTrainedModels({
from: number,
size: number,
tags: string | string[],
for_export: boolean
exclude_generated: boolean
})
----
link:{ref}/get-trained-models.html[Documentation] +
@ -7058,7 +7070,7 @@ _Default:_ `100`
|`tags`
|`string \| string[]` - A comma-separated list of tags that the model must have.
|`for_export` or `forExport`
|`exclude_generated` or `excludeGenerated`
|`boolean` - Omits fields that are illegal to set on model PUT
|===
@ -9259,14 +9271,14 @@ link:{ref}/security-api-get-privileges.html[Documentation] +
[source,ts]
----
client.security.getRole({
name: string
name: string | string[]
})
----
link:{ref}/security-api-get-role.html[Documentation] +
[cols=2*]
|===
|`name`
|`string` - Role name
|`string \| string[]` - A comma-separated list of role names
|===
@ -9276,14 +9288,14 @@ link:{ref}/security-api-get-role.html[Documentation] +
[source,ts]
----
client.security.getRoleMapping({
name: string
name: string | string[]
})
----
link:{ref}/security-api-get-role-mapping.html[Documentation] +
[cols=2*]
|===
|`name`
|`string` - Role-Mapping name
|`string \| string[]` - A comma-separated list of role-mapping names
|===
@ -9331,6 +9343,27 @@ client.security.getUserPrivileges()
link:{ref}/security-api-get-privileges.html[Documentation] +
[discrete]
=== security.grantApiKey
[source,ts]
----
client.security.grantApiKey({
refresh: 'true' | 'false' | 'wait_for',
body: object
})
----
link:{ref}/security-api-grant-api-key.html[Documentation] +
[cols=2*]
|===
|`refresh`
|`'true' \| 'false' \| 'wait_for'` - If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
|`body`
|`object` - The api key request to create an API key
|===
[discrete]
=== security.hasPrivileges
@ -9629,6 +9662,39 @@ link:{ref}/clean-up-snapshot-repo-api.html[Documentation] +
|===
[discrete]
=== snapshot.clone
[source,ts]
----
client.snapshot.clone({
repository: string,
snapshot: string,
target_snapshot: string,
master_timeout: string,
body: object
})
----
link:{ref}/modules-snapshots.html[Documentation] +
[cols=2*]
|===
|`repository`
|`string` - A repository name
|`snapshot`
|`string` - The name of the snapshot to clone from
|`target_snapshot` or `targetSnapshot`
|`string` - The name of the cloned snapshot to create
|`master_timeout` or `masterTimeout`
|`string` - Explicit operation timeout for connection to master node
|`body`
|`object` - The snapshot clone definition
|===
[discrete]
=== snapshot.create
@ -10163,7 +10229,8 @@ client.transform.getTransform({
transform_id: string,
from: number,
size: number,
allow_no_match: boolean
allow_no_match: boolean,
exclude_generated: boolean
})
----
link:{ref}/get-transform.html[Documentation] +
@ -10181,6 +10248,9 @@ link:{ref}/get-transform.html[Documentation] +
|`allow_no_match` or `allowNoMatch`
|`boolean` - Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
|`exclude_generated` or `excludeGenerated`
|`boolean` - Omits fields that are illegal to set on transform PUT
|===
[discrete]