Source: api/api/delete_script.js

  1. /*
  2.  * Copyright OpenSearch Contributors
  3.  * SPDX-License-Identifier: Apache-2.0
  4.  *
  5.  * The OpenSearch Contributors require contributions made to
  6.  * this file be licensed under the Apache-2.0 license or a
  7.  * compatible open source license.
  8.  *
  9.  */
  11. /*
  12.  * Licensed to Elasticsearch B.V. under one or more contributor
  13.  * license agreements. See the NOTICE file distributed with
  14.  * this work for additional information regarding copyright
  15.  * ownership. Elasticsearch B.V. licenses this file to you under
  16.  * the Apache License, Version 2.0 (the "License"); you may
  17.  * not use this file except in compliance with the License.
  18.  * You may obtain a copy of the License at
  19.  *
  20.  *    http://www.apache.org/licenses/LICENSE-2.0
  21.  *
  22.  * Unless required by applicable law or agreed to in writing,
  23.  * software distributed under the License is distributed on an
  24.  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  25.  * KIND, either express or implied.  See the License for the
  26.  * specific language governing permissions and limitations
  27.  * under the License.
  28.  */
  30. 'use strict';
  32. /* eslint camelcase: 0 */
  33. /* eslint no-unused-vars: 0 */
  35. const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils');
  36. const acceptedQuerystring = [
  37.   'timeout',
  38.   'cluster_manager_timeout',
  39.   'master_timeout',
  40.   'pretty',
  41.   'human',
  42.   'error_trace',
  43.   'source',
  44.   'filter_path',
  45. ];
  46. const snakeCase = {
  47.   clusterManagerTimeout: 'cluster_manager_timeout',
  48.   masterTimeout: 'master_timeout',
  49.   errorTrace: 'error_trace',
  50.   filterPath: 'filter_path',
  51. };
  53. /**
  54.  * Delete a stored script.
  55.  * @memberOf API-Script
  56.  *
  57.  * @param {Object} params
  58.  * @param {string} params.id - Stored script or search template name
  59.  * @param {string} [params.timeout=30s] - Explicit operation timeout
  60.  * @param {string} [params.cluster_manager_timeout] - Specify timeout for connection to cluster_manager
  61.  *
  62.  * @param {Object} [options] - Options for {@link Transport#request}
  63.  * @param {function} [callback] - Callback that handles errors and response
  64.  *
  65.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  66.  */
  67. function deleteScriptApi(params, options, callback) {
  68.   [params, options, callback] = normalizeArguments(params, options, callback);
  70.   // check required parameters
  71.   if (params.id == null) {
  72.     const err = new this[kConfigurationError]('Missing required parameter: id');
  73.     return handleError(err, callback);
  74.   }
  76.   let { method, body, id, ...querystring } = params;
  77.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  79.   let path = '';
  80.   if (method == null) method = 'DELETE';
  81.   path = '/' + '_scripts' + '/' + encodeURIComponent(id);
  83.   // build request object
  84.   const request = {
  85.     method,
  86.     path,
  87.     body: body || '',
  88.     querystring,
  89.   };
  91.   return this.transport.request(request, options, callback);
  92. }
  94. module.exports = deleteScriptApi;