habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

API generation

Browse Source
This commit is contained in:
delvedor
2020-02-03 11:00:17 +01:00
parent ebb96e95bf
commit 93d24dcc5b
15 changed files with 32 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
api/api/enrich.delete_policy.js
View File

@ -21,6 +21,7 @@ function buildEnrichDeletePolicy (opts) {
/**
* Perform a enrich.delete_policy request
* https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html
*/
return function enrichDeletePolicy (params, options, callback) {
options = options || {}

1
api/api/enrich.execute_policy.js
View File

@ -21,6 +21,7 @@ function buildEnrichExecutePolicy (opts) {
/**
* Perform a enrich.execute_policy request
* https://www.elastic.co/guide/en/elasticsearch/reference/current/execute-enrich-policy-api.html
*/
return function enrichExecutePolicy (params, options, callback) {
options = options || {}

1
api/api/enrich.get_policy.js
View File

@ -21,6 +21,7 @@ function buildEnrichGetPolicy (opts) {
/**
* Perform a enrich.get_policy request
* https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html
*/
return function enrichGetPolicy (params, options, callback) {
options = options || {}

1
api/api/enrich.put_policy.js
View File

@ -21,6 +21,7 @@ function buildEnrichPutPolicy (opts) {
/**
* Perform a enrich.put_policy request
* https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html
*/
return function enrichPutPolicy (params, options, callback) {
options = options || {}

1
api/api/enrich.stats.js
View File

@ -21,6 +21,7 @@ function buildEnrichStats (opts) {
/**
* Perform a enrich.stats request
* https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html
*/
return function enrichStats (params, options, callback) {
options = options || {}

2
api/api/eql.search.js
View File

@ -21,7 +21,7 @@ function buildEqlSearch (opts) {
/**
* Perform a eql.search request
* https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search.html
* https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html
*/
return function eqlSearch (params, options, callback) {
options = options || {}

2
api/api/slm.execute_lifecycle.js
View File

@ -21,7 +21,7 @@ function buildSlmExecuteLifecycle (opts) {
/**
* Perform a slm.execute_lifecycle request
* https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-policy.html
* https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-lifecycle.html
*/
return function slmExecuteLifecycle (params, options, callback) {
options = options || {}

2
api/api/slm.get_status.js
View File

@ -21,7 +21,7 @@ function buildSlmGetStatus (opts) {
/**
* Perform a slm.get_status request
* https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-get-status.html
* https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-status.html
*/
return function slmGetStatus (params, options, callback) {
options = options || {}

2
api/api/slm.start.js
View File

@ -21,7 +21,7 @@ function buildSlmStart (opts) {
/**
* Perform a slm.start request
* https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-start.html
* https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-start.html
*/
return function slmStart (params, options, callback) {
options = options || {}

2
api/api/slm.stop.js
View File

@ -21,7 +21,7 @@ function buildSlmStop (opts) {
/**
* Perform a slm.stop request
* https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-stop.html
* https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-stop.html
*/
return function slmStop (params, options, callback) {
options = options || {}

3
api/api/sql.clear_cursor.js
View File

@ -21,7 +21,8 @@ function buildSqlClearCursor (opts) {
/**
* Perform a sql.clear_cursor request
* Clear SQL cursor
* Clears the SQL cursor
* https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-pagination.html
*/
return function sqlClearCursor (params, options, callback) {
options = options || {}

3
api/api/sql.query.js
View File

@ -21,7 +21,8 @@ function buildSqlQuery (opts) {
/**
* Perform a sql.query request
* Execute SQL
* Executes an SQL request
* https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-overview.html
*/
return function sqlQuery (params, options, callback) {
options = options || {}

3
api/api/sql.translate.js
View File

@ -21,7 +21,8 @@ function buildSqlTranslate (opts) {
/**
* Perform a sql.translate request
* Translate SQL into Elasticsearch queries
* Translates SQL into Elasticsearch queries
* https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate.html
*/
return function sqlTranslate (params, options, callback) {
options = options || {}

2
api/requestParams.d.ts vendored
View File

@ -406,7 +406,7 @@ export interface DeleteByQuery<T = any> extends Generic {
scroll_size?: number;
wait_for_completion?: boolean;
requests_per_second?: number;
slices?: number;
slices?: number|string;
body: T;
}

25
docs/reference.asciidoc
View File

@ -1569,7 +1569,7 @@ client.deleteByQuery({
scroll_size: number,
wait_for_completion: boolean,
requests_per_second: number,
slices: number,
slices: number|string,
body: object
})
----
@ -1678,7 +1678,7 @@ _Default:_ `true`
|`number` - The throttle for this request in sub-requests per second. -1 means no throttle.
|`slices`
|`number` - The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks. +
|`number\|string` - The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`. +
_Default:_ `1`
|`body`
@ -5755,6 +5755,7 @@ client.enrich.deletePolicy({
name: string
})
----
link:{ref}/delete-enrich-policy-api.html[Reference]
[cols=2*]
|===
|`name`
@ -5771,6 +5772,7 @@ client.enrich.executePolicy({
wait_for_completion: boolean
})
----
link:{ref}/execute-enrich-policy-api.html[Reference]
[cols=2*]
|===
|`name`
@ -5790,6 +5792,7 @@ client.enrich.getPolicy({
name: string
})
----
link:{ref}/get-enrich-policy-api.html[Reference]
[cols=2*]
|===
|`name`
@ -5806,6 +5809,7 @@ client.enrich.putPolicy({
body: object
})
----
link:{ref}/put-enrich-policy-api.html[Reference]
[cols=2*]
|===
|`name`
@ -5822,6 +5826,7 @@ client.enrich.putPolicy({
----
client.enrich.stats()
----
link:{ref}/enrich-stats-api.html[Reference]
=== eql.search
@ -5833,7 +5838,7 @@ client.eql.search({
body: object
})
----
link:{ref}/eql-search.html[Reference]
link:{ref}/eql.html[Reference]
[cols=2*]
|===
|`index`
@ -8460,7 +8465,7 @@ client.slm.executeLifecycle({
policy_id: string
})
----
link:{ref}/slm-api-execute-policy.html[Reference]
link:{ref}/slm-api-execute-lifecycle.html[Reference]
[cols=2*]
|===
|`policy_id` or `policyId`
@ -8508,7 +8513,7 @@ link:{ref}/slm-api-get-stats.html[Reference]
----
client.slm.getStatus()
----
link:{ref}/slm-get-status.html[Reference]
link:{ref}/slm-api-get-status.html[Reference]
=== slm.putLifecycle
@ -8537,7 +8542,7 @@ link:{ref}/slm-api-put-policy.html[Reference]
----
client.slm.start()
----
link:{ref}/slm-start.html[Reference]
link:{ref}/slm-api-start.html[Reference]
=== slm.stop
@ -8546,7 +8551,7 @@ link:{ref}/slm-start.html[Reference]
----
client.slm.stop()
----
link:{ref}/slm-stop.html[Reference]
link:{ref}/slm-api-stop.html[Reference]
=== sql.clearCursor
@ -8557,7 +8562,7 @@ client.sql.clearCursor({
body: object
})
----
link:Clear SQL cursor[Reference]
link:{ref}/sql-pagination.html[Reference]
[cols=2*]
|===
|`body`
@ -8574,7 +8579,7 @@ client.sql.query({
body: object
})
----
link:Execute SQL[Reference]
link:{ref}/sql-rest-overview.html[Reference]
[cols=2*]
|===
|`format`
@ -8593,7 +8598,7 @@ client.sql.translate({
body: object
})
----
link:Translate SQL into Elasticsearch queries[Reference]
link:{ref}/sql-translate.html[Reference]
[cols=2*]
|===
|`body`