feat: add support for querystring in options object (#779)

In very few cases, some API uses the same key for both url and query params, such as the bulk method.
The client is not designed to handle such cases since accepts both url and query keys in the same object, and the url parameter will always take precedence.
This pr fixes this edge case by adding a `querystring` key in the options object.

Fixes: #778

```js
client.bulk({
  index: 'index',
  type: '_doc',
  body: [...]
}, {
  querystring: {
    type: '_doc'
  }
}, console.log)
```

Author: delvedor

README.md

@@ -128,7 +128,9 @@ The supported *request specific options* are:
   requestTimeout: number, // client default
   maxRetries: number, // default `5`
   asStream: boolean, // default `false`
-  headers: object // default `null`
+  compression: string, // default `false`
+  headers: object, // default `null`
+  querystring: object // default `null`
 }
 ```
 

api/api/bulk.js

@@ -151,6 +151,7 @@ function buildBulk (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cat.aliases.js

@@ -131,6 +131,7 @@ function buildCatAliases (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cat.allocation.js

@@ -133,6 +133,7 @@ function buildCatAllocation (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cat.count.js

@@ -131,6 +131,7 @@ function buildCatCount (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cat.fielddata.js

@@ -135,6 +135,7 @@ function buildCatFielddata (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cat.health.js

@@ -128,6 +128,7 @@ function buildCatHealth (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cat.help.js

@@ -115,6 +115,7 @@ function buildCatHelp (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cat.indices.js

@@ -137,6 +137,7 @@ function buildCatIndices (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cat.master.js

@@ -126,6 +126,7 @@ function buildCatMaster (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cat.nodeattrs.js

@@ -126,6 +126,7 @@ function buildCatNodeattrs (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cat.nodes.js

@@ -129,6 +129,7 @@ function buildCatNodes (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cat.pending_tasks.js

@@ -126,6 +126,7 @@ function buildCatPendingTasks (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cat.plugins.js

@@ -126,6 +126,7 @@ function buildCatPlugins (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cat.recovery.js

@@ -131,6 +131,7 @@ function buildCatRecovery (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cat.repositories.js

@@ -126,6 +126,7 @@ function buildCatRepositories (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cat.segments.js

@@ -128,6 +128,7 @@ function buildCatSegments (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cat.shards.js

@@ -133,6 +133,7 @@ function buildCatShards (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cat.snapshots.js

@@ -132,6 +132,7 @@ function buildCatSnapshots (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cat.tasks.js

@@ -131,6 +131,7 @@ function buildCatTasks (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cat.templates.js

@@ -131,6 +131,7 @@ function buildCatTemplates (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cat.thread_pool.js

@@ -133,6 +133,7 @@ function buildCatThreadPool (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/ccr.delete_auto_follow_pattern.js

@@ -107,6 +107,7 @@ function buildCcrDeleteAutoFollowPattern (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/ccr.follow.js

@@ -114,6 +114,7 @@ function buildCcrFollow (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/ccr.follow_info.js

@@ -0,0 +1,127 @@
+/*
+ * 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 buildCcrFollowInfo (opts) {
+  // eslint-disable-next-line no-unused-vars
+  const { makeRequest, ConfigurationError, result } = opts
+  /**
+   * Perform a [ccr.follow_info](https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html) request
+   *
+   * @param {list} index - A comma-separated list of index patterns; use `_all` to perform the operation on all indices
+   */
+
+  const acceptedQuerystring = [
+
+  ]
+
+  const snakeCase = {
+
+  }
+
+  return function ccrFollowInfo (params, options, callback) {
+    options = options || {}
+    if (typeof options === 'function') {
+      callback = options
+      options = {}
+    }
+    if (typeof params === 'function' || params == null) {
+      callback = params
+      params = {}
+      options = {}
+    }
+
+    // promises support
+    if (callback == null) {
+      return new Promise((resolve, reject) => {
+        ccrFollowInfo(params, options, (err, body) => {
+          err ? reject(err) : resolve(body)
+        })
+      })
+    }
+
+    // validate headers object
+    if (options.headers != null && typeof options.headers !== 'object') {
+      return callback(
+        new ConfigurationError(`Headers should be an object, instead got: ${typeof options.headers}`),
+        result
+      )
+    }
+
+    var warnings = null
+    var { method, body, index } = params
+    var querystring = semicopy(params, ['method', 'body', 'index'])
+
+    if (method == null) {
+      method = 'GET'
+    }
+
+    var ignore = options.ignore || null
+    if (typeof ignore === 'number') {
+      ignore = [ignore]
+    }
+
+    var path = ''
+
+    path = '/' + encodeURIComponent(index) + '/' + '_ccr' + '/' + 'info'
+
+    // build request object
+    const request = {
+      method,
+      path,
+      body: null,
+      querystring
+    }
+
+    const requestOptions = {
+      ignore,
+      requestTimeout: options.requestTimeout || null,
+      maxRetries: options.maxRetries || null,
+      asStream: options.asStream || false,
+      headers: options.headers || null,
+      querystring: options.querystring || null,
+      compression: options.compression || false,
+      warnings
+    }
+
+    return makeRequest(request, requestOptions, callback)
+
+    function semicopy (obj, exclude) {
+      var target = {}
+      var keys = Object.keys(obj)
+      for (var i = 0, len = keys.length; i < len; i++) {
+        var key = keys[i]
+        if (exclude.indexOf(key) === -1) {
+          target[snakeCase[key] || key] = obj[key]
+          if (acceptedQuerystring.indexOf(snakeCase[key] || key) === -1) {
+            warnings = warnings || []
+            warnings.push('Client - Unknown parameter: "' + key + '", sending it as query parameter')
+          }
+        }
+      }
+      return target
+    }
+  }
+}
+
+module.exports = buildCcrFollowInfo

api/api/ccr.follow_stats.js

@@ -99,6 +99,7 @@ function buildCcrFollowStats (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/ccr.get_auto_follow_pattern.js

@@ -103,6 +103,7 @@ function buildCcrGetAutoFollowPattern (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/ccr.pause_follow.js

@@ -107,6 +107,7 @@ function buildCcrPauseFollow (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/ccr.put_auto_follow_pattern.js

@@ -114,6 +114,7 @@ function buildCcrPutAutoFollowPattern (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/ccr.resume_follow.js

@@ -108,6 +108,7 @@ function buildCcrResumeFollow (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/ccr.stats.js

@@ -98,6 +98,7 @@ function buildCcrStats (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/ccr.unfollow.js

@@ -107,6 +107,7 @@ function buildCcrUnfollow (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/clear_scroll.js

@@ -109,6 +109,7 @@ function buildClearScroll (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }

api/api/cluster.allocation_explain.js

@@ -110,6 +110,7 @@ function buildClusterAllocationExplain (opts) {
       maxRetries: options.maxRetries || null,
       asStream: options.asStream || false,
       headers: options.headers || null,
+      querystring: options.querystring || null,
       compression: options.compression || false,
       warnings
     }