Updated opensearch-js to reflect the latest OpenSearch API spec (2025…

…-01-12)

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

api/_core/createPit.d.ts

@@ -16,7 +16,6 @@
 
 import { ApiResponse } from '../../lib/Transport'
 import * as Common from '../_types/_common'
-import * as Core_Common from '../_types/_core._common'
 import * as Global from '../_types/_global'
 
 export interface CreatePit_Request extends Global.Params {
@@ -33,7 +32,7 @@ export interface CreatePit_Response extends ApiResponse {
 }
 
 export type CreatePit_ResponseBody = {
-  _shards?: Core_Common.ShardStatistics;
+  _shards?: Common.ShardStatistics;
   creation_time?: number;
   pit_id?: string;
 }

api/_core/deleteAllPits.d.ts

@@ -15,7 +15,7 @@
  */
 
 import { ApiResponse } from '../../lib/Transport'
-import * as Core_Common from '../_types/_core._common'
+import * as Core_Pit from '../_types/_core.pit'
 import * as Global from '../_types/_global'
 
 export type DeleteAllPits_Request = Global.Params & Record<string, any>
@@ -25,6 +25,6 @@ export interface DeleteAllPits_Response extends ApiResponse {
 }
 
 export type DeleteAllPits_ResponseBody = {
-  pits?: Core_Common.PitsDetailsDeleteAll[];
+  pits?: Core_Pit.DeletedPit[];
 }
 

api/_core/deleteByQuery.d.ts

@@ -17,10 +17,11 @@
 import { ApiResponse } from '../../lib/Transport'
 import * as Common from '../_types/_common'
 import * as Common_QueryDsl from '../_types/_common.query_dsl'
+import * as Core_Search from '../_types/_core.search'
 import * as Global from '../_types/_global'
 
 export interface DeleteByQuery_Request extends Global.Params {
-  _source?: string[];
+  _source?: Core_Search.SourceConfigParam;
   _source_excludes?: string[];
   _source_includes?: string[];
   allow_no_indices?: boolean;

api/_core/deleteByQuery.js

@@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u
  * @memberOf API-Core
  *
  * @param {object} params
- * @param {array} [params._source] - Set to `true` or `false` to return the `_source` field or not, or a list of fields to return.
+ * @param {string} [params._source] - Set to `true` or `false` to return the `_source` field or not, or a list of fields to return.
  * @param {array} [params._source_excludes] - List of fields to exclude from the returned `_source` field.
  * @param {array} [params._source_includes] - List of fields to extract and return from the `_source` field.
  * @param {boolean} [params.allow_no_indices] - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.

api/_core/deletePit.d.ts

@@ -15,7 +15,7 @@
  */
 
 import { ApiResponse } from '../../lib/Transport'
-import * as Core_Common from '../_types/_core._common'
+import * as Core_Pit from '../_types/_core.pit'
 import * as Global from '../_types/_global'
 
 export interface DeletePit_Request extends Global.Params {
@@ -31,6 +31,6 @@ export interface DeletePit_Response extends ApiResponse {
 }
 
 export type DeletePit_ResponseBody = {
-  pits?: Core_Common.DeletedPit[];
+  pits?: Core_Pit.DeletedPit[];
 }
 

api/_core/getAllPits.d.ts

@@ -15,7 +15,7 @@
  */
 
 import { ApiResponse } from '../../lib/Transport'
-import * as Core_Common from '../_types/_core._common'
+import * as Core_Pit from '../_types/_core.pit'
 import * as Global from '../_types/_global'
 
 export type GetAllPits_Request = Global.Params & Record<string, any>
@@ -25,6 +25,6 @@ export interface GetAllPits_Response extends ApiResponse {
 }
 
 export type GetAllPits_ResponseBody = {
-  pits?: Core_Common.PitDetail[];
+  pits?: Core_Pit.PitDetail[];
 }
 

api/_core/rankEval.d.ts

@@ -39,7 +39,7 @@ export interface RankEval_Response extends ApiResponse {
 
 export type RankEval_ResponseBody = {
   details: Record<string, Core_RankEval.RankEvalMetricDetail>;
-  failures: Record<string, Record<string, any>>;
+  failures: Record<string, any>;
   metric_score: number;
 }
 

api/_core/reindex.d.ts

@@ -24,6 +24,7 @@ export interface Reindex_Request extends Global.Params {
   max_docs?: number;
   refresh?: Common.Refresh;
   requests_per_second?: number;
+  require_alias?: boolean;
   scroll?: Common.Duration;
   slices?: Common.Slices;
   timeout?: Common.Duration;

api/_core/reindex.js

@@ -30,6 +30,7 @@ documents from a remote cluster.
  * @param {number} [params.max_docs] - Maximum number of documents to process. By default, all documents.
  * @param {string} [params.refresh] - If `true`, the request refreshes affected shards to make this operation visible to search.
  * @param {number} [params.requests_per_second=0] - The throttle for this request in sub-requests per second. Defaults to no throttle.
+ * @param {boolean} [params.require_alias] 
  * @param {string} [params.scroll] - Specifies how long a consistent view of the index should be maintained for scrolled search.
  * @param {string} [params.slices] - The number of slices this task should be divided into. Defaults to 1 slice, meaning the task isn't sliced into subtasks.
  * @param {string} [params.timeout] - Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.

api/_core/renderSearchTemplate.d.ts

@@ -34,6 +34,6 @@ export interface RenderSearchTemplate_Response extends ApiResponse {
 }
 
 export type RenderSearchTemplate_ResponseBody = {
-  template_output: Record<string, Record<string, any>>;
+  template_output: Record<string, any>;
 }
 

api/_core/searchShards.d.ts

@@ -21,7 +21,6 @@ import * as Global from '../_types/_global'
 
 export interface SearchShards_Request extends Global.Params {
   allow_no_indices?: boolean;
-  body?: SearchShards_RequestBody;
   expand_wildcards?: Common.ExpandWildcards;
   ignore_unavailable?: boolean;
   index?: Common.Indices;
@@ -30,16 +29,6 @@ export interface SearchShards_Request extends Global.Params {
   routing?: Common.RoutingInQueryString;
 }
 
-export type SearchShards_RequestBody = {
-  _source?: boolean | string[];
-  allow_partial_search_results?: boolean;
-  from?: number;
-  indices_boost?: Record<string, number>;
-  query?: Record<string, Record<string, any>>;
-  size?: number;
-  sort?: Record<string, string>[];
-}
-
 export interface SearchShards_Response extends ApiResponse {
   body: SearchShards_ResponseBody;
 }

api/_core/searchShards.js

@@ -32,7 +32,6 @@ const { normalizeArguments, parsePathParam } = require('../utils');
  * @param {string} [params.preference=random] - Specifies the node or shard the operation should be performed on. Random by default.
  * @param {string} [params.routing] - Custom value used to route operations to a specific shard.
  * @param {string} [params.index] - Returns the indexes and shards that a search request would be executed against.
- * @param {object} [params.body] - Defines the parameters that can be used in the `search_shards` endpoint request. See documentation for supported query syntax.
  *
  * @param {TransportRequestOptions} [options] - Options for {@link Transport#request}
  * @param {function} [callback] - Callback that handles errors and response

api/_core/updateByQuery.d.ts

@@ -17,10 +17,11 @@
 import { ApiResponse } from '../../lib/Transport'
 import * as Common from '../_types/_common'
 import * as Common_QueryDsl from '../_types/_common.query_dsl'
+import * as Core_Search from '../_types/_core.search'
 import * as Global from '../_types/_global'
 
 export interface UpdateByQuery_Request extends Global.Params {
-  _source?: string[];
+  _source?: Core_Search.SourceConfigParam;
   _source_excludes?: string[];
   _source_includes?: string[];
   allow_no_indices?: boolean;

api/_core/updateByQuery.js

@@ -26,7 +26,7 @@ for example to pick up a mapping change.
  * @memberOf API-Core
  *
  * @param {object} params
- * @param {array} [params._source] - Set to `true` or `false` to return the `_source` field or not, or a list of fields to return.
+ * @param {string} [params._source] - Set to `true` or `false` to return the `_source` field or not, or a list of fields to return.
  * @param {array} [params._source_excludes] - List of fields to exclude from the returned `_source` field.
  * @param {array} [params._source_includes] - List of fields to extract and return from the `_source` field.
  * @param {boolean} [params.allow_no_indices] - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.

api/_types/_common.d.ts

@@ -419,7 +419,6 @@ export type NodeShard = {
   primary: boolean;
   recovery_source?: Record<string, Id>;
   relocating_node?: NodeId | undefined;
-  relocation_failure_info?: RelocationFailureInfo;
   shard: number;
   state: Indices_Stats.ShardRoutingState;
   unassigned_info?: Cluster_AllocationExplain.UnassignedInformation;
@@ -515,10 +514,6 @@ export type RefreshStats = {
 
 export type RelationName = string
 
-export type RelocationFailureInfo = {
-  failed_attempts: number;
-}
-
 export type RemoteStoreDownloadStats = {
   total_download_size: RemoteStoreUploadDownloadStats;
   total_time_spent?: Duration;
@@ -768,7 +763,7 @@ export type short = number
 
 export type SlicedScroll = {
   field?: Field;
-  id: Id;
+  id: number;
   max: number;
 }
 

api/_types/_core.field_caps.d.ts

@@ -19,7 +19,7 @@ import * as Common from './_common'
 export type FieldCapability = {
   aggregatable: boolean;
   indices?: Common.Indices;
-  meta?: Common.Metadata;
+  meta?: Record<string, string[]>;
   metadata_field?: boolean;
   non_aggregatable_indices?: Common.Indices;
   non_searchable_indices?: Common.Indices;

api/_types/_core._common.d.ts → api/_types/_core.pit.d.ts

@@ -26,15 +26,3 @@ export type PitDetail = {
   pit_id?: string;
 }
 
-export type PitsDetailsDeleteAll = {
-  pit_id?: string;
-  successful?: boolean;
-}
-
-export type ShardStatistics = {
-  failed?: number;
-  skipped?: number;
-  successful?: number;
-  total?: number;
-}
-

api/_types/_core.rank_eval.d.ts

@@ -32,7 +32,7 @@ export type RankEvalHit = {
 
 export type RankEvalHitItem = {
   hit: RankEvalHit;
-  rating?: undefined | number | string;
+  rating?: number;
 }
 
 export type RankEvalMetric = {
@@ -49,7 +49,7 @@ export type RankEvalMetricBase = {
 
 export type RankEvalMetricDetail = {
   hits: RankEvalHitItem[];
-  metric_details: Record<string, Record<string, number>>;
+  metric_details: Record<string, Record<string, any>>;
   metric_score: number;
   unrated_docs: UnratedDocument[];
 }
@@ -81,7 +81,7 @@ export type RankEvalQuery = {
 
 export type RankEvalRequestItem = {
   id: Common.Id;
-  params?: Record<string, Record<string, any>>;
+  params?: Record<string, any>;
   ratings: DocumentRating[];
   request?: RankEvalQuery;
   template_id?: Common.Id;

api/_types/_core.termvectors.d.ts

@@ -40,7 +40,7 @@ export type Term = {
 }
 
 export type TermVector = {
-  field_statistics: FieldStatistics;
+  field_statistics?: FieldStatistics;
   terms: Record<string, Term>;
 }
 

api/_types/index.d.ts

@@ -19,7 +19,6 @@ import * as Common_Aggregations from './_common.aggregations'
 import * as Common_Analysis from './_common.analysis'
 import * as Common_Mapping from './_common.mapping'
 import * as Common_QueryDsl from './_common.query_dsl'
-import * as Core_Common from './_core._common'
 import * as Core_Bulk from './_core.bulk'
 import * as Core_Explain from './_core.explain'
 import * as Core_FieldCaps from './_core.field_caps'
@@ -30,6 +29,7 @@ import * as Core_Mget from './_core.mget'
 import * as Core_MsearchTemplate from './_core.msearch_template'
 import * as Core_Msearch from './_core.msearch'
 import * as Core_Mtermvectors from './_core.mtermvectors'
+import * as Core_Pit from './_core.pit'
 import * as Core_RankEval from './_core.rank_eval'
 import * as Core_ReindexRethrottle from './_core.reindex_rethrottle'
 import * as Core_Reindex from './_core.reindex'
@@ -128,7 +128,6 @@ export {
   Common_Analysis,
   Common_Mapping,
   Common_QueryDsl,
-  Core_Common,
   Core_Bulk,
   Core_Explain,
   Core_FieldCaps,
@@ -139,6 +138,7 @@ export {
   Core_MsearchTemplate,
   Core_Msearch,
   Core_Mtermvectors,
+  Core_Pit,
   Core_RankEval,
   Core_ReindexRethrottle,
   Core_Reindex,

api/cat/allPitSegments.js

@@ -28,7 +28,7 @@ const { normalizeArguments } = require('../utils');
  * @param {string} [params.bytes] - The units used to display byte values.
  * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`.
  * @param {array} [params.h] - A comma-separated list of column names to display.
- * @param {boolean} [params.help=false] - Return help information.
+ * @param {boolean} [params.help=false] - Returns help information.
  * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by.
  * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers.
  *

api/cat/clusterManager.js

@@ -28,7 +28,7 @@ const { normalizeArguments } = require('../utils');
  * @param {string} [params.cluster_manager_timeout] - A timeout for connection to the cluster manager node.
  * @param {string} [params.format] - A short version of the HTTP `Accept` header, such as `json` or `yaml`.
  * @param {array} [params.h] - A comma-separated list of column names to display.
- * @param {boolean} [params.help=false] - Return help information.
+ * @param {boolean} [params.help=false] - Returns help information.
  * @param {boolean} [params.local=false] - Returns local information but does not retrieve the state from the cluster manager node.
  * @param {string} [params.master_timeout] DEPRECATED - A timeout for connection to the cluster manager node.
  * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by.

api/cat/count.js

@@ -27,7 +27,7 @@ const { normalizeArguments, parsePathParam } = require('../utils');
  * @param {object} [params]
  * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`.
  * @param {array} [params.h] - A comma-separated list of column names to display.
- * @param {boolean} [params.help=false] - Return help information.
+ * @param {boolean} [params.help=false] - Returns help information.
  * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by.
  * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers.
  * @param {string} [params.index] - Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`.

api/cat/fielddata.js

@@ -29,7 +29,7 @@ const { normalizeArguments, parsePathParam } = require('../utils');
  * @param {string} [params.fields] - A comma-separated list of fields used to limit the amount of returned information. To retrieve all fields, omit this parameter.
  * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`.
  * @param {array} [params.h] - A comma-separated list of column names to display.
- * @param {boolean} [params.help=false] - Return help information.
+ * @param {boolean} [params.help=false] - Returns help information.
  * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by.
  * @param {boolean} [params.v=false] - Enables verbose mode, which displays column headers.
  *

api/cat/health.js

@@ -27,7 +27,7 @@ const { normalizeArguments } = require('../utils');
  * @param {object} [params]
  * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`.
  * @param {array} [params.h] - A comma-separated list of column names to display.
- * @param {boolean} [params.help=false] - Return help information.
+ * @param {boolean} [params.help=false] - Returns help information.
  * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by.
  * @param {string} [params.time] - The unit used to display time values.
  * @param {boolean} [params.ts=true] - When `true`, returns `HH:MM:SS` and Unix epoch timestamps.

api/cat/indices.js

@@ -27,11 +27,11 @@ const { normalizeArguments, parsePathParam } = require('../utils');
  * @param {object} [params]
  * @param {string} [params.bytes] - The units used to display byte values.
  * @param {string} [params.cluster_manager_timeout] - The amount of time allowed to establish a connection to the cluster manager node.
- * @param {string} [params.expand_wildcards] - The type of index that wildcard patterns can match.
+ * @param {string} [params.expand_wildcards] - The type of index that wildcard patterns can match.  Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
  * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`.
  * @param {array} [params.h] - A comma-separated list of column names to display.
  * @param {string} [params.health] - Limits indexes based on their health status. Supported values are `green`, `yellow`, and `red`.
- * @param {boolean} [params.help=false] - Return help information.
+ * @param {boolean} [params.help=false] - Returns help information.
  * @param {boolean} [params.include_unloaded_segments=false] - Whether to include information from segments not loaded into memory.
  * @param {boolean} [params.local=false] - Returns local information but does not retrieve the state from the cluster manager node.
  * @param {string} [params.master_timeout] DEPRECATED - The amount of time allowed to establish a connection to the cluster manager node.

api/cat/master.js

@@ -28,7 +28,7 @@ const { normalizeArguments } = require('../utils');
  * @param {string} [params.cluster_manager_timeout] - The amount of time allowed to establish a connection to the cluster manager node.
  * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`.
  * @param {array} [params.h] - A comma-separated list of column names to display.
- * @param {boolean} [params.help=false] - Return help information.
+ * @param {boolean} [params.help=false] - Returns help information.
  * @param {boolean} [params.local=false] - Returns local information but does not retrieve the state from the cluster manager node.
  * @param {string} [params.master_timeout] DEPRECATED - The amount of time allowed to establish a connection to the cluster manager node.
  * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by.

api/cat/nodeattrs.js

@@ -28,7 +28,7 @@ const { normalizeArguments } = require('../utils');
  * @param {string} [params.cluster_manager_timeout] - The amount of time allowed to establish a connection to the cluster manager node.
  * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`.
  * @param {array} [params.h] - A comma-separated list of column names to display.
- * @param {boolean} [params.help=false] - Return help information.
+ * @param {boolean} [params.help=false] - Returns help information.
  * @param {boolean} [params.local=false] - Returns local information but does not retrieve the state from the cluster manager node.
  * @param {string} [params.master_timeout] DEPRECATED - The amount of time allowed to establish a connection to the cluster manager node.
  * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by.

api/cat/nodes.js

@@ -30,7 +30,7 @@ const { normalizeArguments } = require('../utils');
  * @param {string} [params.format] - A short version of the `Accept` header, such as `json` or `yaml`.
  * @param {string} [params.full_id] - When `true`, returns the full node ID. When `false`, returns the shortened node ID.
  * @param {array} [params.h] - A comma-separated list of column names to display.
- * @param {boolean} [params.help=false] - Return help information.
+ * @param {boolean} [params.help=false] - Returns help information.
  * @param {boolean} [params.local=false] DEPRECATED - Returns local information but does not retrieve the state from the cluster manager node.
  * @param {string} [params.master_timeout] DEPRECATED - The amount of time allowed to establish a connection to the cluster manager node.
  * @param {array} [params.s] - A comma-separated list of column names or column aliases to sort by.