From c40eaab03837ae09be6c8fcf70c0cf891712bffa Mon Sep 17 00:00:00 2001 From: delvedor Date: Mon, 25 Nov 2019 17:04:37 +0100 Subject: [PATCH] API generation --- ....js => ml.explain_data_frame_analytics.js} | 27 +++++++++---------- api/index.js | 4 +-- api/requestParams.d.ts | 7 ++--- docs/reference.asciidoc | 20 ++++++++++++++ index.d.ts | 4 +-- 5 files changed, 41 insertions(+), 21 deletions(-) rename api/api/{ml.estimate_memory_usage.js => ml.explain_data_frame_analytics.js} (69%) diff --git a/api/api/ml.estimate_memory_usage.js b/api/api/ml.explain_data_frame_analytics.js similarity index 69% rename from api/api/ml.estimate_memory_usage.js rename to api/api/ml.explain_data_frame_analytics.js index 5959ae4d2..b443fba6c 100644 --- a/api/api/ml.estimate_memory_usage.js +++ b/api/api/ml.explain_data_frame_analytics.js @@ -7,7 +7,7 @@ /* eslint camelcase: 0 */ /* eslint no-unused-vars: 0 */ -function buildMlEstimateMemoryUsage (opts) { +function buildMlExplainDataFrameAnalytics (opts) { // eslint-disable-next-line no-unused-vars const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts @@ -20,10 +20,10 @@ function buildMlEstimateMemoryUsage (opts) { } /** - * Perform a ml.estimate_memory_usage request - * http://www.elastic.co/guide/en/elasticsearch/reference/current/estimate-memory-usage-dfanalytics.html + * Perform a ml.explain_data_frame_analytics request + * http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html */ - return function mlEstimateMemoryUsage (params, options, callback) { + return function mlExplainDataFrameAnalytics (params, options, callback) { options = options || {} if (typeof options === 'function') { callback = options @@ -35,12 +35,6 @@ function buildMlEstimateMemoryUsage (opts) { options = {} } - // check required parameters - if (params['body'] == null) { - const err = new ConfigurationError('Missing required parameter: body') - return handleError(err, callback) - } - // validate headers object if (options.headers != null && typeof options.headers !== 'object') { const err = new ConfigurationError(`Headers should be an object, instead got: ${typeof options.headers}`) @@ -48,7 +42,7 @@ function buildMlEstimateMemoryUsage (opts) { } var warnings = [] - var { method, body, ...querystring } = params + var { method, body, id, ...querystring } = params querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring, warnings) var ignore = options.ignore @@ -58,8 +52,13 @@ function buildMlEstimateMemoryUsage (opts) { var path = '' - if (method == null) method = 'POST' - path = '/' + '_ml' + '/' + 'data_frame' + '/' + 'analytics' + '/' + '_estimate_memory_usage' + if ((id) != null) { + if (method == null) method = body == null ? 'GET' : 'POST' + path = '/' + '_ml' + '/' + 'data_frame' + '/' + 'analytics' + '/' + encodeURIComponent(id) + '/' + '_explain' + } else { + if (method == null) method = body == null ? 'GET' : 'POST' + path = '/' + '_ml' + '/' + 'data_frame' + '/' + 'analytics' + '/' + '_explain' + } // build request object const request = { @@ -74,4 +73,4 @@ function buildMlEstimateMemoryUsage (opts) { } } -module.exports = buildMlEstimateMemoryUsage +module.exports = buildMlExplainDataFrameAnalytics diff --git a/api/index.js b/api/index.js index db137069b..cf0e34ce9 100644 --- a/api/index.js +++ b/api/index.js @@ -294,10 +294,10 @@ function ESAPI (opts) { deleteModelSnapshot: lazyLoad('ml.delete_model_snapshot', opts), delete_trained_model: lazyLoad('ml.delete_trained_model', opts), deleteTrainedModel: lazyLoad('ml.delete_trained_model', opts), - estimate_memory_usage: lazyLoad('ml.estimate_memory_usage', opts), - estimateMemoryUsage: lazyLoad('ml.estimate_memory_usage', opts), evaluate_data_frame: lazyLoad('ml.evaluate_data_frame', opts), evaluateDataFrame: lazyLoad('ml.evaluate_data_frame', opts), + explain_data_frame_analytics: lazyLoad('ml.explain_data_frame_analytics', opts), + explainDataFrameAnalytics: lazyLoad('ml.explain_data_frame_analytics', opts), find_file_structure: lazyLoad('ml.find_file_structure', opts), findFileStructure: lazyLoad('ml.find_file_structure', opts), flush_job: lazyLoad('ml.flush_job', opts), diff --git a/api/requestParams.d.ts b/api/requestParams.d.ts index 396015778..f4c9f8071 100644 --- a/api/requestParams.d.ts +++ b/api/requestParams.d.ts @@ -1610,12 +1610,13 @@ export interface MlDeleteTrainedModel extends Generic { model_id: string; } -export interface MlEstimateMemoryUsage extends Generic { +export interface MlEvaluateDataFrame extends Generic { body: T; } -export interface MlEvaluateDataFrame extends Generic { - body: T; +export interface MlExplainDataFrameAnalytics extends Generic { + id?: string; + body?: T; } export interface MlFindFileStructure extends Generic { diff --git a/docs/reference.asciidoc b/docs/reference.asciidoc index 3621bd41c..c1fc1ffba 100644 --- a/docs/reference.asciidoc +++ b/docs/reference.asciidoc @@ -6433,6 +6433,26 @@ link:{ref}/evaluate-dfanalytics.html[Reference] |=== +=== ml.explainDataFrameAnalytics +*Stability:* experimental +[source,ts] +---- +client.ml.explainDataFrameAnalytics({ + id: string, + body: object +}) +---- +link:{ref}/explain-dfanalytics.html[Reference] +[cols=2*] +|=== +|`id` +|`string` - The ID of the data frame analytics to explain + +|`body` +|`object` - The data frame analytics config to explain + +|=== + === ml.findFileStructure *Stability:* experimental [source,ts] diff --git a/index.d.ts b/index.d.ts index 1665cecc2..165c666cc 100644 --- a/index.d.ts +++ b/index.d.ts @@ -392,10 +392,10 @@ declare class Client extends EventEmitter { deleteModelSnapshot: ApiMethod delete_trained_model: ApiMethod deleteTrainedModel: ApiMethod - estimate_memory_usage: ApiMethod - estimateMemoryUsage: ApiMethod evaluate_data_frame: ApiMethod evaluateDataFrame: ApiMethod + explain_data_frame_analytics: ApiMethod + explainDataFrameAnalytics: ApiMethod find_file_structure: ApiMethod findFileStructure: ApiMethod flush_job: ApiMethod