From d00564722e8547544e4957aa9de42afe6be3b595 Mon Sep 17 00:00:00 2001 From: delvedor Date: Thu, 4 Jul 2019 12:11:34 +0200 Subject: [PATCH] API generation --- api/api/ml.stop_data_frame_analytics.js | 2 + api/api/security.get_builtin_privileges.js | 95 ++++++++++++++++++++++ api/api/security.get_privileges.js | 2 +- api/index.js | 2 + api/requestParams.d.ts | 4 + docs/reference.asciidoc | 13 ++- index.d.ts | 2 + 7 files changed, 118 insertions(+), 2 deletions(-) create mode 100644 api/api/security.get_builtin_privileges.js diff --git a/api/api/ml.stop_data_frame_analytics.js b/api/api/ml.stop_data_frame_analytics.js index 0a8e933e5..6cb7823f2 100644 --- a/api/api/ml.stop_data_frame_analytics.js +++ b/api/api/ml.stop_data_frame_analytics.js @@ -30,12 +30,14 @@ function buildMlStopDataFrameAnalytics (opts) { * * @param {string} id - The ID of the data frame analytics to stop * @param {boolean} allow_no_match - Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) + * @param {boolean} force - True if the data frame analytics should be forcefully stopped * @param {time} timeout - Controls the time to wait until the task has stopped. Defaults to 20 seconds * @param {object} body - The stop data frame analytics parameters */ const acceptedQuerystring = [ 'allow_no_match', + 'force', 'timeout' ] diff --git a/api/api/security.get_builtin_privileges.js b/api/api/security.get_builtin_privileges.js new file mode 100644 index 000000000..3a9bbf4d7 --- /dev/null +++ b/api/api/security.get_builtin_privileges.js @@ -0,0 +1,95 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +'use strict' + +/* eslint camelcase: 0 */ +/* eslint no-unused-vars: 0 */ + +function buildSecurityGetBuiltinPrivileges (opts) { + // eslint-disable-next-line no-unused-vars + const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts + /** + * Perform a [security.get_builtin_privileges](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html) request + * + */ + + const acceptedQuerystring = [ + + ] + + const snakeCase = { + + } + + return function securityGetBuiltinPrivileges (params, options, callback) { + options = options || {} + if (typeof options === 'function') { + callback = options + options = {} + } + if (typeof params === 'function' || params == null) { + callback = params + params = {} + options = {} + } + + // check required parameters + if (params.body != null) { + const err = new ConfigurationError('This API does not require a 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}`) + return handleError(err, callback) + } + + var warnings = [] + var { method, body, ...querystring } = params + querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring, warnings) + + if (method == null) { + method = 'GET' + } + + var ignore = options.ignore + if (typeof ignore === 'number') { + options.ignore = [ignore] + } + + var path = '' + + path = '/' + '_security' + '/' + 'privilege' + '/' + '_builtin' + + // build request object + const request = { + method, + path, + body: null, + querystring + } + + options.warnings = warnings.length === 0 ? null : warnings + return makeRequest(request, options, callback) + } +} + +module.exports = buildSecurityGetBuiltinPrivileges diff --git a/api/api/security.get_privileges.js b/api/api/security.get_privileges.js index 5bea2a86c..ca19de5cb 100644 --- a/api/api/security.get_privileges.js +++ b/api/api/security.get_privileges.js @@ -26,7 +26,7 @@ function buildSecurityGetPrivileges (opts) { // eslint-disable-next-line no-unused-vars const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts /** - * Perform a [security.get_privileges](TODO) request + * Perform a [security.get_privileges](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html) request * * @param {string} application - Application name * @param {string} name - Privilege name diff --git a/api/index.js b/api/index.js index 230500784..9ad5a45c8 100644 --- a/api/index.js +++ b/api/index.js @@ -443,6 +443,8 @@ function ESAPI (opts) { enableUser: lazyLoad('security.enable_user', opts), get_api_key: lazyLoad('security.get_api_key', opts), getApiKey: lazyLoad('security.get_api_key', opts), + get_builtin_privileges: lazyLoad('security.get_builtin_privileges', opts), + getBuiltinPrivileges: lazyLoad('security.get_builtin_privileges', opts), get_privileges: lazyLoad('security.get_privileges', opts), getPrivileges: lazyLoad('security.get_privileges', opts), get_role: lazyLoad('security.get_role', opts), diff --git a/api/requestParams.d.ts b/api/requestParams.d.ts index 4d340a6b2..e92877535 100644 --- a/api/requestParams.d.ts +++ b/api/requestParams.d.ts @@ -1829,6 +1829,7 @@ export interface MlStartDatafeed extends Generic { export interface MlStopDataFrameAnalytics extends Generic { id: string; allow_no_match?: boolean; + force?: boolean; timeout?: string; body?: T; } @@ -1977,6 +1978,9 @@ export interface SecurityGetApiKey extends Generic { realm_name?: string; } +export interface SecurityGetBuiltinPrivileges extends Generic { +} + export interface SecurityGetPrivileges extends Generic { application?: string; name?: string; diff --git a/docs/reference.asciidoc b/docs/reference.asciidoc index 348b796a8..1e82a6458 100644 --- a/docs/reference.asciidoc +++ b/docs/reference.asciidoc @@ -5646,6 +5646,9 @@ client.ml.stopDataFrameAnalytics([params] [, options] [, callback]) |`allow_no_match` or `allowNoMatch` |`boolean` - Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) +|`force` +|`boolean` - True if the data frame analytics should be forcefully stopped + |`timeout` |`string` - Controls the time to wait until the task has stopped. Defaults to 20 seconds @@ -6101,12 +6104,20 @@ link:{ref}/security-api-get-api-key.html[Reference] |=== +=== security.getBuiltinPrivileges +[source,js] +---- +client.security.getBuiltinPrivileges([params] [, options] [, callback]) +---- +link:{ref}/security-api-get-builtin-privileges.html[Reference] + + === security.getPrivileges [source,js] ---- client.security.getPrivileges([params] [, options] [, callback]) ---- -link:TODO[Reference] +link:{ref}/security-api-get-privileges.html[Reference] [cols=2*] |=== |`application` diff --git a/index.d.ts b/index.d.ts index a2ac04692..84acfeaf8 100644 --- a/index.d.ts +++ b/index.d.ts @@ -538,6 +538,8 @@ declare class Client extends EventEmitter { enableUser: ApiMethod get_api_key: ApiMethod getApiKey: ApiMethod + get_builtin_privileges: ApiMethod + getBuiltinPrivileges: ApiMethod get_privileges: ApiMethod getPrivileges: ApiMethod get_role: ApiMethod