API generation

api/api/close_point_in_time.js

@@ -0,0 +1,87 @@
+/*
+ * 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 buildClosePointInTime (opts) {
+  // eslint-disable-next-line no-unused-vars
+  const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
+
+  const acceptedQuerystring = [
+
+  ]
+
+  const snakeCase = {
+
+  }
+
+  /**
+   * Perform a close_point_in_time request
+   * Close a point in time
+   * https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time.html
+   */
+  return function closePointInTime (params, options, callback) {
+    options = options || {}
+    if (typeof options === 'function') {
+      callback = options
+      options = {}
+    }
+    if (typeof params === 'function' || params == null) {
+      callback = params
+      params = {}
+      options = {}
+    }
+
+    // validate headers object
+    if (options.headers != null && typeof options.headers !== 'object') {
+      const err = new ConfigurationError(`Headers should be an object, instead got: ${typeof options.headers}`)
+      return handleError(err, callback)
+    }
+
+    var warnings = []
+    var { method, body, ...querystring } = params
+    querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring, warnings)
+
+    var ignore = options.ignore
+    if (typeof ignore === 'number') {
+      options.ignore = [ignore]
+    }
+
+    var path = ''
+
+    if (method == null) method = 'DELETE'
+    path = '/' + '_pit'
+
+    // build request object
+    const request = {
+      method,
+      path,
+      body: body || '',
+      querystring
+    }
+
+    options.warnings = warnings.length === 0 ? null : warnings
+    return makeRequest(request, options, callback)
+  }
+}
+
+module.exports = buildClosePointInTime

api/api/open_point_in_time.js

@@ -0,0 +1,98 @@
+/*
+ * 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 buildOpenPointInTime (opts) {
+  // eslint-disable-next-line no-unused-vars
+  const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
+
+  const acceptedQuerystring = [
+    'preference',
+    'routing',
+    'ignore_unavailable',
+    'expand_wildcards',
+    'keep_alive'
+  ]
+
+  const snakeCase = {
+    ignoreUnavailable: 'ignore_unavailable',
+    expandWildcards: 'expand_wildcards',
+    keepAlive: 'keep_alive'
+  }
+
+  /**
+   * Perform a open_point_in_time request
+   * Open a point in time that can be used in subsequent searches
+   * https://www.elastic.co/guide/en/elasticsearch/reference/master/point-in-time.html
+   */
+  return function openPointInTime (params, options, callback) {
+    options = options || {}
+    if (typeof options === 'function') {
+      callback = options
+      options = {}
+    }
+    if (typeof params === 'function' || params == null) {
+      callback = params
+      params = {}
+      options = {}
+    }
+
+    // validate headers object
+    if (options.headers != null && typeof options.headers !== 'object') {
+      const err = new ConfigurationError(`Headers should be an object, instead got: ${typeof options.headers}`)
+      return handleError(err, callback)
+    }
+
+    var warnings = []
+    var { method, body, index, ...querystring } = params
+    querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring, warnings)
+
+    var ignore = options.ignore
+    if (typeof ignore === 'number') {
+      options.ignore = [ignore]
+    }
+
+    var path = ''
+
+    if ((index) != null) {
+      if (method == null) method = 'POST'
+      path = '/' + encodeURIComponent(index) + '/' + '_pit'
+    } else {
+      if (method == null) method = 'POST'
+      path = '/' + '_pit'
+    }
+
+    // build request object
+    const request = {
+      method,
+      path,
+      body: body || '',
+      querystring
+    }
+
+    options.warnings = warnings.length === 0 ? null : warnings
+    return makeRequest(request, options, callback)
+  }
+}
+
+module.exports = buildOpenPointInTime

api/api/searchable_snapshots.clear_cache.js

@@ -43,7 +43,7 @@ function buildSearchableSnapshotsClearCache (opts) {
   /**
    * Perform a searchable_snapshots.clear_cache request
    * Clear the cache of searchable snapshots.
-   * https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-api-clear-cache.html
+   * https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html
    */
   return function searchableSnapshotsClearCache (params, options, callback) {
     options = options || {}

api/api/searchable_snapshots.repository_stats.js

@@ -36,8 +36,8 @@ function buildSearchableSnapshotsRepositoryStats (opts) {
 
   /**
    * Perform a searchable_snapshots.repository_stats request
-   * Retrieve usage statistics about a snapshot repository.
+   * DEPRECATED: This API is replaced by the Repositories Metering API.
-   * https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-repository-stats.html
+   * https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html
    */
   return function searchableSnapshotsRepositoryStats (params, options, callback) {
     options = options || {}

api/api/searchable_snapshots.stats.js

@@ -37,7 +37,7 @@ function buildSearchableSnapshotsStats (opts) {
   /**
    * Perform a searchable_snapshots.stats request
    * Retrieve various statistics about searchable snapshots.
-   * https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-api-stats.html
+   * https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html
    */
   return function searchableSnapshotsStats (params, options, callback) {
     options = options || {}

api/index.js

@@ -112,6 +112,8 @@ function ESAPI (opts) {
     },
     clear_scroll: lazyLoad('clear_scroll', opts),
     clearScroll: lazyLoad('clear_scroll', opts),
+    close_point_in_time: lazyLoad('close_point_in_time', opts),
+    closePointInTime: lazyLoad('close_point_in_time', opts),
     cluster: {
       allocation_explain: lazyLoad('cluster.allocation_explain', opts),
       allocationExplain: lazyLoad('cluster.allocation_explain', opts),
@@ -471,6 +473,8 @@ function ESAPI (opts) {
       stats: lazyLoad('nodes.stats', opts),
       usage: lazyLoad('nodes.usage', opts)
     },
+    open_point_in_time: lazyLoad('open_point_in_time', opts),
+    openPointInTime: lazyLoad('open_point_in_time', opts),
     ping: lazyLoad('ping', opts),
     put_script: lazyLoad('put_script', opts),
     putScript: lazyLoad('put_script', opts),

api/kibana.d.ts

@@ -130,6 +130,7 @@ interface KibanaClient {
     unfollow<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.CcrUnfollow, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
   }
   clearScroll<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.ClearScroll<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
+  closePointInTime<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.ClosePointInTime<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
   cluster: {
     allocationExplain<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.ClusterAllocationExplain<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
     deleteComponentTemplate<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.ClusterDeleteComponentTemplate, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
@@ -346,6 +347,7 @@ interface KibanaClient {
     stats<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.NodesStats, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
     usage<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.NodesUsage, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
   }
+  openPointInTime<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.OpenPointInTime, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
   ping<TResponse = boolean, TContext = Context>(params?: RequestParams.Ping, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
   putScript<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.PutScript<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
   rankEval<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.RankEval<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>

api/requestParams.d.ts

@@ -1658,6 +1658,10 @@ export interface CcrUnfollow extends Generic {
   index: string;
 }
 
+export interface ClosePointInTime<T = RequestBody> extends Generic {
+  body?: T;
+}
+
 export interface EnrichDeletePolicy extends Generic {
   name: string;
 }
@@ -2241,6 +2245,15 @@ export interface MonitoringBulk<T = RequestNDBody> extends Generic {
   body: T;
 }
 
+export interface OpenPointInTime extends Generic {
+  index?: string | string[];
+  preference?: string;
+  routing?: string;
+  ignore_unavailable?: boolean;
+  expand_wildcards?: 'open' | 'closed' | 'hidden' | 'none' | 'all';
+  keep_alive?: string;
+}
+
 export interface RollupDeleteJob extends Generic {
   id: string;
 }

docs/reference.asciidoc

@@ -6733,6 +6733,22 @@ link:{ref}/ccr-post-unfollow.html[Documentation] +
 
 |===
 
+=== closePointInTime
+
+[source,ts]
+----
+client.closePointInTime({
+  body: object
+})
+----
+link:{ref}/point-in-time.html[Documentation] +
+[cols=2*]
+|===
+|`body`
+|`object` - a point-in-time id to close
+
+|===
+
 === enrich.deletePolicy
 
 [source,ts]
@@ -9078,6 +9094,43 @@ WARNING: This parameter has been deprecated.
 
 |===
 
+=== openPointInTime
+
+[source,ts]
+----
+client.openPointInTime({
+  index: string | string[],
+  preference: string,
+  routing: string,
+  ignore_unavailable: boolean,
+  expand_wildcards: 'open' | 'closed' | 'hidden' | 'none' | 'all',
+  keep_alive: string
+})
+----
+link:{ref}/point-in-time.html[Documentation] +
+[cols=2*]
+|===
+|`index`
+|`string \| string[]` - A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices
+
+|`preference`
+|`string` - Specify the node or shard the operation should be performed on (default: random)
+
+|`routing`
+|`string` - Specific routing value
+
+|`ignore_unavailable` or `ignoreUnavailable`
+|`boolean` - Whether specified concrete indices should be ignored when unavailable (missing or closed)
+
+|`expand_wildcards` or `expandWildcards`
+|`'open' \| 'closed' \| 'hidden' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. +
+_Default:_ `open`
+
+|`keep_alive` or `keepAlive`
+|`string` - Specific the time to live for the point in time
+
+|===
+
 === rollup.deleteJob
 *Stability:* experimental
 [source,ts]
@@ -9247,7 +9300,7 @@ client.searchableSnapshots.clearCache({
   expand_wildcards: 'open' | 'closed' | 'none' | 'all'
 })
 ----
-link:{ref}/searchable-snapshots-api-clear-cache.html[Documentation] +
+link:{ref}/searchable-snapshots-apis.html[Documentation] +
 [cols=2*]
 |===
 |`index`
@@ -9305,7 +9358,7 @@ client.searchableSnapshots.repositoryStats({
   repository: string
 })
 ----
-link:{ref}/searchable-snapshots-repository-stats.html[Documentation] +
+link:{ref}/searchable-snapshots-apis.html[Documentation] +
 [cols=2*]
 |===
 |`repository`
@@ -9321,7 +9374,7 @@ client.searchableSnapshots.stats({
   index: string | string[]
 })
 ----
-link:{ref}/searchable-snapshots-api-stats.html[Documentation] +
+link:{ref}/searchable-snapshots-apis.html[Documentation] +
 [cols=2*]
 |===
 |`index`

index.d.ts

@@ -433,6 +433,14 @@ declare class Client {
   clearScroll<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
   clearScroll<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.ClearScroll<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
   clearScroll<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.ClearScroll<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
+  close_point_in_time<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.ClosePointInTime<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
+  close_point_in_time<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
+  close_point_in_time<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.ClosePointInTime<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
+  close_point_in_time<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.ClosePointInTime<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
+  closePointInTime<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.ClosePointInTime<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
+  closePointInTime<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
+  closePointInTime<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.ClosePointInTime<TRequestBody>, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
+  closePointInTime<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params: RequestParams.ClosePointInTime<TRequestBody>, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
   cluster: {
     allocation_explain<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(params?: RequestParams.ClusterAllocationExplain<TRequestBody>, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
     allocation_explain<TResponse = Record<string, any>, TRequestBody extends RequestBody = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
@@ -1785,6 +1793,14 @@ declare class Client {
     usage<TResponse = Record<string, any>, TContext = Context>(params: RequestParams.NodesUsage, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
     usage<TResponse = Record<string, any>, TContext = Context>(params: RequestParams.NodesUsage, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
   }
+  open_point_in_time<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.OpenPointInTime, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
+  open_point_in_time<TResponse = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
+  open_point_in_time<TResponse = Record<string, any>, TContext = Context>(params: RequestParams.OpenPointInTime, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
+  open_point_in_time<TResponse = Record<string, any>, TContext = Context>(params: RequestParams.OpenPointInTime, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
+  openPointInTime<TResponse = Record<string, any>, TContext = Context>(params?: RequestParams.OpenPointInTime, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
+  openPointInTime<TResponse = Record<string, any>, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
+  openPointInTime<TResponse = Record<string, any>, TContext = Context>(params: RequestParams.OpenPointInTime, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
+  openPointInTime<TResponse = Record<string, any>, TContext = Context>(params: RequestParams.OpenPointInTime, options: TransportRequestOptions, callback: callbackFn<TResponse, TContext>): TransportRequestCallback
   ping<TResponse = boolean, TContext = Context>(params?: RequestParams.Ping, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse<TResponse, TContext>>
   ping<TResponse = boolean, TContext = Context>(callback: callbackFn<TResponse, TContext>): TransportRequestCallback
   ping<TResponse = boolean, TContext = Context>(params: RequestParams.Ping, callback: callbackFn<TResponse, TContext>): TransportRequestCallback