Source: api/api/info.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 = ['pretty', 'human', 'error_trace', 'source', 'filter_path'];
  37. const snakeCase = { errorTrace: 'error_trace', filterPath: 'filter_path' };
  39. /**
  40.  * Returns basic information about the cluster.
  41.  *
  42.  * @memberOf API-Cluster
  43.  *
  44.  * @param {Object} params - (Unused)
  45.  * @param {Object} options - Options for {@link Transport#request}
  46.  * @param {function} callback - Callback that handles errors and response
  47.  *
  48.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  49.  */
  50. function infoApi(params, options, callback) {
  51.   [params, options, callback] = normalizeArguments(params, options, callback);
  53.   let { method, body, ...querystring } = params;
  54.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  56.   let path = '';
  57.   if (method == null) method = 'GET';
  58.   path = '/';
  60.   // build request object
  61.   const request = {
  62.     method,
  63.     path,
  64.     body: null,
  65.     querystring,
  66.   };
  68.   return this.transport.request(request, options, callback);
  69. }
  71. module.exports = infoApi;