Patch deprecated parameters (#851)

* Updated code generation

* API generation

* API generation

* Updated code generation

scripts/generate.js

@@ -69,7 +69,7 @@ function start (opts) {
 
     writeFileSync(
       requestParamsOutputFile,
-      generateRequestTypes(allSpec),
+      generateRequestTypes(opts.branch || opts.tag, allSpec),
       { encoding: 'utf8' }
     )
 
@@ -113,7 +113,7 @@ function start (opts) {
 
       const spec = require(join(apiFolder, file))
       allSpec.push(spec)
-      const code = generate(spec, common)
+      const code = generate(opts.branch || opts.tag, spec, common)
       const filePath = join(apiOutputFolder, `${file.slice(0, file.lastIndexOf('.'))}.js`)
 
       writeFileSync(filePath, code, { encoding: 'utf8' })

scripts/utils/generateApis.js

@@ -22,11 +22,16 @@
 'use strict'
 
 const dedent = require('dedent')
+const semver = require('semver')
 const allowedMethods = {
   noBody: ['GET', 'HEAD', 'DELETE'],
   body: ['POST', 'PUT', 'DELETE']
 }
 
+// if a parameter is depracted in a minor release
+// we should be able to support it until the next major
+const deprecatedParameters = require('./patch.json')
+
 // list of apis that does not need any kind of validation
 // because of how the url is built or the `type` handling in ES7
 const noPathValidation = [
@@ -63,7 +68,8 @@ const ndjsonApi = [
   'xpack.monitoring.bulk'
 ]
 
-function generate (spec, common) {
+function generate (version, spec, common) {
+  const release = semver.valid(version) ? semver.major(version) : version
   const api = Object.keys(spec)[0]
   const name = api
     .replace(/\.([a-z])/g, k => k[1].toUpperCase())
@@ -90,7 +96,11 @@ function generate (spec, common) {
     if (params[key].required) {
       required.push(key)
     }
+
     acceptedQuerystring.push(key)
+    if (deprecatedParameters[release] && deprecatedParameters[release][key]) {
+      acceptedQuerystring.push(deprecatedParameters[release][key])
+    }
   }
 
   for (const key in spec[api]) {

scripts/utils/generateRequestTypes.js

@@ -19,7 +19,11 @@
 
 'use strict'
 
-function generate (api) {
+const semver = require('semver')
+const deprecatedParameters = require('./patch.json')
+
+function generate (version, api) {
+  const release = semver.valid(version) ? semver.major(version) : version
   var types = `/*
  * Licensed to Elasticsearch B.V. under one or more contributor
  * license agreements. See the NOTICE file distributed with
@@ -64,9 +68,20 @@ export interface Generic {
 
     const partsArr = Object.keys(parts)
       .map(k => ({ key: k, value: parts[k] }))
+    const deprecatedParametersToAdd = []
     const paramsArr = Object.keys(params)
       .filter(k => !Object.keys(parts).includes(k))
-      .map(k => ({ key: k, value: params[k] }))
+      .map(k => {
+        if (deprecatedParameters[release] && deprecatedParameters[release][k]) {
+          deprecatedParametersToAdd.push({
+            key: deprecatedParameters[release][k],
+            value: params[k]
+          })
+        }
+        return { key: k, value: params[k] }
+      })
+
+    deprecatedParametersToAdd.forEach(k => partsArr.push(k))
 
     const genLine = e => {
       const optional = e.value.required ? '' : '?'

scripts/utils/patch.json

@@ -0,0 +1,14 @@
+{
+  "6": {
+    "_source_includes": "_source_include",
+    "_source_excludes": "_source_exclude"
+  },
+  "7": {
+    "_source_includes": "_source_include",
+    "_source_excludes": "_source_exclude"
+  },
+  "master": {
+    "_source_includes": "_source_include",
+    "_source_excludes": "_source_exclude"
+  }
+}