Source: api/api/put_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.   'cluster_manager_timeout',
  38.   'timeout',
  39.   'master_timeout',
  40.   'context',
  41.   'pretty',
  42.   'human',
  43.   'error_trace',
  44.   'source',
  45.   'filter_path',
  46. ];
  47. const snakeCase = {
  48.   clusterManagerTimeout: 'cluster_manager_timeout',
  49.   masterTimeout: 'master_timeout',
  50.   errorTrace: 'error_trace',
  51.   filterPath: 'filter_path',
  52. };
  54. /**
  55.  * Creates or updates a script.
  56.  * <br/> See also: {@link https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/ OpenSearch - Create or update stored script}
  57.  * @memberOf API-Script
  58.  *
  59.  * @param {Object} params
  60.  * @param {string} params.id - Stored script or search template name
  61.  * @param {string} params.body - The script
  62.  * @param {string} [params.context] - Context in which the script or search template is to run. To prevent errors, the API immediately compiles the script or template in this context.
  63.  * @param {string} [params.timeout=30s] - Explicit operation timeout
  64.  * @param {string} [params.cluster_manager_timeout] - Specify timeout for connection to cluster_manager
  65.  *
  66.  * @param {Object} [options] - Options for {@link Transport#request}
  67.  * @param {function} [callback] - Callback that handles errors and response
  68.  *
  69.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  70.  */
  71. function putScriptApi(params, options, callback) {
  72.   [params, options, callback] = normalizeArguments(params, options, callback);
  74.   // check required parameters
  75.   if (params.id == null) {
  76.     const err = new this[kConfigurationError]('Missing required parameter: id');
  77.     return handleError(err, callback);
  78.   }
  79.   if (params.body == null) {
  80.     const err = new this[kConfigurationError]('Missing required parameter: body');
  81.     return handleError(err, callback);
  82.   }
  84.   // check required url components
  85.   if (params.context != null && params.id == null) {
  86.     const err = new this[kConfigurationError]('Missing required parameter of the url: id');
  87.     return handleError(err, callback);
  88.   }
  90.   let { method, body, id, context, ...querystring } = params;
  91.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  93.   let path = '';
  94.   if (id != null && context != null) {
  95.     if (method == null) method = 'PUT';
  96.     path = '/' + '_scripts' + '/' + encodeURIComponent(id) + '/' + encodeURIComponent(context);
  97.   } else {
  98.     if (method == null) method = 'PUT';
  99.     path = '/' + '_scripts' + '/' + encodeURIComponent(id);
  100.   }
  102.   // build request object
  103.   const request = {
  104.     method,
  105.     path,
  106.     body: body || '',
  107.     querystring,
  108.   };
  110.   return this.transport.request(request, options, callback);
  111. }
  113. module.exports = putScriptApi;