From 93d24dcc5b5a52273cfa5116bef8242dc98e5c07 Mon Sep 17 00:00:00 2001 From: delvedor Date: Mon, 3 Feb 2020 11:00:17 +0100 Subject: [PATCH] API generation --- api/api/enrich.delete_policy.js | 1 + api/api/enrich.execute_policy.js | 1 + api/api/enrich.get_policy.js | 1 + api/api/enrich.put_policy.js | 1 + api/api/enrich.stats.js | 1 + api/api/eql.search.js | 2 +- api/api/slm.execute_lifecycle.js | 2 +- api/api/slm.get_status.js | 2 +- api/api/slm.start.js | 2 +- api/api/slm.stop.js | 2 +- api/api/sql.clear_cursor.js | 3 ++- api/api/sql.query.js | 3 ++- api/api/sql.translate.js | 3 ++- api/requestParams.d.ts | 2 +- docs/reference.asciidoc | 25 +++++++++++++++---------- 15 files changed, 32 insertions(+), 19 deletions(-) diff --git a/api/api/enrich.delete_policy.js b/api/api/enrich.delete_policy.js index c2658df0a..461275a87 100644 --- a/api/api/enrich.delete_policy.js +++ b/api/api/enrich.delete_policy.js @@ -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 || {} diff --git a/api/api/enrich.execute_policy.js b/api/api/enrich.execute_policy.js index 61f09e411..ebc46b7b7 100644 --- a/api/api/enrich.execute_policy.js +++ b/api/api/enrich.execute_policy.js @@ -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 || {} diff --git a/api/api/enrich.get_policy.js b/api/api/enrich.get_policy.js index 4225e808b..23a0fca29 100644 --- a/api/api/enrich.get_policy.js +++ b/api/api/enrich.get_policy.js @@ -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 || {} diff --git a/api/api/enrich.put_policy.js b/api/api/enrich.put_policy.js index 53830f100..9b6e2c039 100644 --- a/api/api/enrich.put_policy.js +++ b/api/api/enrich.put_policy.js @@ -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 || {} diff --git a/api/api/enrich.stats.js b/api/api/enrich.stats.js index 98d7cd7cf..cc3da67b1 100644 --- a/api/api/enrich.stats.js +++ b/api/api/enrich.stats.js @@ -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 || {} diff --git a/api/api/eql.search.js b/api/api/eql.search.js index e6ae5fe29..d2194f436 100644 --- a/api/api/eql.search.js +++ b/api/api/eql.search.js @@ -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 || {} diff --git a/api/api/slm.execute_lifecycle.js b/api/api/slm.execute_lifecycle.js index b693e53c6..a3431feb7 100644 --- a/api/api/slm.execute_lifecycle.js +++ b/api/api/slm.execute_lifecycle.js @@ -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 || {} diff --git a/api/api/slm.get_status.js b/api/api/slm.get_status.js index 67509a985..c9eb621e2 100644 --- a/api/api/slm.get_status.js +++ b/api/api/slm.get_status.js @@ -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 || {} diff --git a/api/api/slm.start.js b/api/api/slm.start.js index 56562f97c..649165320 100644 --- a/api/api/slm.start.js +++ b/api/api/slm.start.js @@ -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 || {} diff --git a/api/api/slm.stop.js b/api/api/slm.stop.js index a1c416b36..8e150400f 100644 --- a/api/api/slm.stop.js +++ b/api/api/slm.stop.js @@ -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 || {} diff --git a/api/api/sql.clear_cursor.js b/api/api/sql.clear_cursor.js index 3eee442ce..bfa3ce6b8 100644 --- a/api/api/sql.clear_cursor.js +++ b/api/api/sql.clear_cursor.js @@ -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 || {} diff --git a/api/api/sql.query.js b/api/api/sql.query.js index 4f59263ba..b37ef6b27 100644 --- a/api/api/sql.query.js +++ b/api/api/sql.query.js @@ -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 || {} diff --git a/api/api/sql.translate.js b/api/api/sql.translate.js index f5d6f0f89..652570095 100644 --- a/api/api/sql.translate.js +++ b/api/api/sql.translate.js @@ -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 || {} diff --git a/api/requestParams.d.ts b/api/requestParams.d.ts index 23f73cb2f..e32381a35 100644 --- a/api/requestParams.d.ts +++ b/api/requestParams.d.ts @@ -406,7 +406,7 @@ export interface DeleteByQuery extends Generic { scroll_size?: number; wait_for_completion?: boolean; requests_per_second?: number; - slices?: number; + slices?: number|string; body: T; } diff --git a/docs/reference.asciidoc b/docs/reference.asciidoc index 0c5ca4d69..23f4df9c0 100644 --- a/docs/reference.asciidoc +++ b/docs/reference.asciidoc @@ -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`