From a1bae0bd2afdfb380cad0a9798ba933675dd6622 Mon Sep 17 00:00:00 2001 From: nhtruong <644650+nhtruong@users.noreply.github.com> Date: Sun, 17 Nov 2024 00:10:31 +0000 Subject: [PATCH] Updated opensearch-js to reflect the latest OpenSearch API spec (2024-11-17) Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- api/_core/clearScroll.js | 2 +- api/_core/count.js | 6 +- api/_core/createPit.js | 4 +- api/_core/deleteByQuery.js | 6 +- api/_core/exists.js | 2 +- api/_core/existsSource.js | 2 +- api/_core/fieldCaps.js | 8 +-- api/_core/msearch.js | 2 +- api/_core/msearchTemplate.js | 2 +- api/_core/rankEval.js | 8 +-- api/_core/search.js | 8 +-- api/_core/searchShards.js | 6 +- api/_core/searchTemplate.js | 6 +- api/_core/updateByQuery.js | 6 +- api/_types/_common.analysis.d.ts | 7 ++- api/_types/_common.mapping.d.ts | 66 +++++++--------------- api/_types/_core.field_caps.d.ts | 5 -- api/_types/cluster.stats.d.ts | 50 ++++++++-------- api/_types/indices._common.d.ts | 6 -- api/_types/ml._common.d.ts | 52 ++++++++++++++++- api/cat/aliases.js | 4 +- api/cat/count.js | 4 +- api/cat/indices.js | 6 +- api/cat/recovery.js | 2 +- api/cat/segmentReplication.js | 8 +-- api/cat/segments.js | 2 +- api/cat/shards.js | 2 +- api/cluster/health.js | 6 +- api/cluster/putComponentTemplate.js | 2 +- api/cluster/state.js | 8 +-- api/cluster/stats.d.ts | 2 + api/cluster/stats.js | 8 ++- api/danglingIndices/listDanglingIndices.js | 2 +- api/indices/addBlock.js | 8 +-- api/indices/clearCache.js | 6 +- api/indices/close.js | 2 +- api/indices/delete.js | 4 +- api/indices/deleteAlias.js | 2 +- api/indices/exists.js | 4 +- api/indices/existsAlias.js | 6 +- api/indices/flush.js | 6 +- api/indices/forcemerge.js | 10 ++-- api/indices/get.js | 6 +- api/indices/getAlias.js | 4 +- api/indices/getFieldMapping.js | 4 +- api/indices/getMapping.js | 6 +- api/indices/getSettings.js | 6 +- api/indices/getUpgrade.js | 8 +-- api/indices/open.js | 4 +- api/indices/putAlias.js | 2 +- api/indices/putMapping.js | 4 +- api/indices/putSettings.js | 6 +- api/indices/recovery.js | 2 +- api/indices/refresh.js | 6 +- api/indices/resolveIndex.js | 4 +- api/indices/segments.js | 4 +- api/indices/shardStores.js | 8 +-- api/indices/stats.js | 4 +- api/indices/upgrade.js | 8 +-- api/indices/validateQuery.js | 4 +- api/ism/addPolicy.js | 2 +- api/ism/changePolicy.js | 2 +- api/ism/explainPolicy.js | 2 +- api/ism/refreshSearchAnalyzers.js | 2 +- api/ism/removePolicy.js | 2 +- api/ism/retryIndex.js | 2 +- api/knn/searchModels.js | 8 +-- api/knn/warmup.js | 2 +- api/nodes/stats.js | 2 +- api/security/createAllowlist.js | 2 +- api/snapshot/clone.js | 2 +- api/wlm/createQueryGroup.js | 2 +- api/wlm/deleteQueryGroup.js | 4 +- api/wlm/getQueryGroup.js | 4 +- api/wlm/updateQueryGroup.js | 2 +- 75 files changed, 256 insertions(+), 232 deletions(-) diff --git a/api/_core/clearScroll.js b/api/_core/clearScroll.js index d61b930b4..03eccc93f 100644 --- a/api/_core/clearScroll.js +++ b/api/_core/clearScroll.js @@ -26,7 +26,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * * @param {object} [params] * @param {string} [params.scroll_id] DEPRECATED - Comma-separated list of scroll IDs to clear. To clear all scroll IDs, use `_all`. - * @param {object} [params.body] - Comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter + * @param {object} [params.body] - Comma-separated list of scroll IDs to clear if none was specified using the `scroll_id` parameter * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/_core/count.js b/api/_core/count.js index 1f3f3dea6..35e93ec29 100644 --- a/api/_core/count.js +++ b/api/_core/count.js @@ -25,13 +25,13 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @memberOf API-Core * * @param {object} [params] - * @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 indices. This behavior applies even if the request targets other open indices. + * @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. * @param {boolean} [params.analyze_wildcard=false] - If `true`, wildcard and prefix queries are analyzed. This parameter can only be used when the `q` query string parameter is specified. * @param {string} [params.analyzer] - Analyzer to use for the query string. This parameter can only be used when the `q` query string parameter is specified. * @param {string} [params.default_operator] - The default operator for query string query: `AND` or `OR`. This parameter can only be used when the `q` query string parameter is specified. * @param {string} [params.df] - Field to use as default where no field prefix is given in the query string. This parameter can only be used when the `q` query string parameter is specified. * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. - * @param {boolean} [params.ignore_throttled] - If `true`, concrete, expanded or aliased indices are ignored when frozen. + * @param {boolean} [params.ignore_throttled] - If `true`, concrete, expanded or aliased indexes are ignored when frozen. * @param {boolean} [params.ignore_unavailable] - If `false`, the request returns an error if it targets a missing or closed index. * @param {boolean} [params.lenient] - If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. * @param {number} [params.min_score] - Sets the minimum `_score` value that documents must have to be included in the result. @@ -39,7 +39,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @param {string} [params.q] - Query in the Lucene query string syntax. * @param {string} [params.routing] - Custom value used to route operations to a specific shard. * @param {number} [params.terminate_after] - Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`. + * @param {string} [params.index] - Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams and indexes, omit this parameter or use `*` or `_all`. * @param {object} [params.body] - Query to restrict the results specified with the Query DSL (optional) * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/_core/createPit.js b/api/_core/createPit.js index 9a827f3a1..391c8fde0 100644 --- a/api/_core/createPit.js +++ b/api/_core/createPit.js @@ -26,11 +26,11 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * * @param {object} params * @param {boolean} [params.allow_partial_pit_creation] - Allow if point in time can be created with partial failures. - * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indices that are open, closed or both. + * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indexes that are open, closed or both. * @param {string} [params.keep_alive] - Specify the keep alive for point in time. * @param {string} [params.preference=random] - Specify the node or shard the operation should be performed on. * @param {string} [params.routing] - Comma-separated list of specific routing values. - * @param {array} params.index - Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + * @param {array} params.index - Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/_core/deleteByQuery.js b/api/_core/deleteByQuery.js index 0498eb58a..f7a37654b 100644 --- a/api/_core/deleteByQuery.js +++ b/api/_core/deleteByQuery.js @@ -28,7 +28,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @param {array} [params._source] - 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 indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + * @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`. * @param {boolean} [params.analyze_wildcard=false] - If `true`, wildcard and prefix queries are analyzed. * @param {string} [params.analyzer] - Analyzer to use for the query string. * @param {string} [params.conflicts] - What to do if delete by query hits version conflicts: `abort` or `proceed`. @@ -53,12 +53,12 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @param {string} [params.slices] - The number of slices this task should be divided into. * @param {array} [params.sort] - A comma-separated list of : pairs. * @param {array} [params.stats] - Specific `tag` of the request for logging and statistical purposes. - * @param {number} [params.terminate_after] - Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. Use with caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + * @param {number} [params.terminate_after] - Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. Use with caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers. * @param {string} [params.timeout] - Period each deletion request waits for active shards. * @param {boolean} [params.version] - If `true`, returns the document version as part of a hit. * @param {string} [params.wait_for_active_shards] - The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). * @param {boolean} [params.wait_for_completion=true] - If `true`, the request blocks until the operation is complete. - * @param {string} params.index - Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`. + * @param {string} params.index - Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams or indexes, omit this parameter or use `*` or `_all`. * @param {object} params.body - The search definition using the Query DSL * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/_core/exists.js b/api/_core/exists.js index 50ade1aca..fd2f5e0b9 100644 --- a/api/_core/exists.js +++ b/api/_core/exists.js @@ -36,7 +36,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @param {number} [params.version] - Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. * @param {string} [params.version_type] - Specific version type: `external`, `external_gte`. * @param {string} params.id - Identifier of the document. - * @param {string} params.index - Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + * @param {string} params.index - Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/_core/existsSource.js b/api/_core/existsSource.js index 307f1d22d..7d96295c2 100644 --- a/api/_core/existsSource.js +++ b/api/_core/existsSource.js @@ -35,7 +35,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @param {number} [params.version] - Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. * @param {string} [params.version_type] - Specific version type: `external`, `external_gte`. * @param {string} params.id - Identifier of the document. - * @param {string} params.index - Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + * @param {string} params.index - Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/_core/fieldCaps.js b/api/_core/fieldCaps.js index b297617de..67aca4141 100644 --- a/api/_core/fieldCaps.js +++ b/api/_core/fieldCaps.js @@ -19,18 +19,18 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Returns the information about the capabilities of fields among multiple indices. + * Returns the information about the capabilities of fields among multiple indexes. *
See Also: {@link https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations - field_caps} * * @memberOf API-Core * * @param {object} [params] - * @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 indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar. + * @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. * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. * @param {string} [params.fields] - Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. - * @param {boolean} [params.ignore_unavailable] - If `true`, missing or closed indices are not included in the response. + * @param {boolean} [params.ignore_unavailable] - If `true`, missing or closed indexes are not included in the response. * @param {boolean} [params.include_unmapped=false] - If true, unmapped fields are included in the response. - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all. + * @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. * @param {object} [params.body] - An index filter specified with the Query DSL * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/_core/msearch.js b/api/_core/msearch.js index 28283b223..316e93b87 100644 --- a/api/_core/msearch.js +++ b/api/_core/msearch.js @@ -32,7 +32,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @param {boolean} [params.rest_total_hits_as_int=false] - If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. * @param {string} [params.search_type] - Indicates whether global term and document frequencies should be used when scoring returned documents. * @param {boolean} [params.typed_keys] - Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. - * @param {string} [params.index] - Comma-separated list of data streams, indices, and index aliases to search. + * @param {string} [params.index] - Comma-separated list of data streams, indexes, and index aliases to search. * @param {array} params.body - The request definitions (metadata-search request definition pairs), separated by newlines * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/_core/msearchTemplate.js b/api/_core/msearchTemplate.js index ea0596db0..766801217 100644 --- a/api/_core/msearchTemplate.js +++ b/api/_core/msearchTemplate.js @@ -30,7 +30,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @param {boolean} [params.rest_total_hits_as_int=false] - If `true`, the response returns `hits.total` as an integer. If `false`, it returns `hits.total` as an object. * @param {string} [params.search_type] - The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`. * @param {boolean} [params.typed_keys] - If `true`, the response prefixes aggregation and suggester names with their respective types. - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*`. + * @param {string} [params.index] - Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams and indexes, omit this parameter or use `*`. * @param {array} params.body - The request definitions (metadata-search request definition pairs), separated by newlines * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/_core/rankEval.js b/api/_core/rankEval.js index 6dc692503..c4e6b2567 100644 --- a/api/_core/rankEval.js +++ b/api/_core/rankEval.js @@ -25,11 +25,11 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Core * * @param {object} params - * @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 indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. - * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indices that are open, closed or both. - * @param {boolean} [params.ignore_unavailable] - If `true`, missing or closed indices are not included in the response. + * @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`. + * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indexes that are open, closed or both. + * @param {boolean} [params.ignore_unavailable] - If `true`, missing or closed indexes are not included in the response. * @param {string} [params.search_type] - Search operation type - * @param {string} [params.index] - Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard (`*`) expressions are supported. To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`. + * @param {string} [params.index] - Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard (`*`) expressions are supported. To target all data streams and indexes in a cluster, omit this parameter or use `_all` or `*`. * @param {object} params.body - The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/_core/search.js b/api/_core/search.js index 8d59c9165..5deb13f6f 100644 --- a/api/_core/search.js +++ b/api/_core/search.js @@ -28,7 +28,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @param {string} [params._source] - Indicates which source fields are returned for matching documents. These fields are returned in the `hits._source` property of the search response. Valid values are: `true` to return the entire document source; `false` to not return the document source; `` to return the source fields that are specified as a comma-separated list (supports wildcard (`*`) patterns). * @param {string} [params._source_excludes] - A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. * @param {string} [params._source_includes] - A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. - * @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 indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + * @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`. * @param {boolean} [params.allow_partial_search_results=true] - If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. * @param {boolean} [params.analyze_wildcard=false] - If true, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. * @param {string} [params.analyzer] - Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified. @@ -41,7 +41,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. * @param {boolean} [params.explain] - If `true`, returns detailed information about score computation as part of a hit. * @param {number} [params.from=0] - Starting document offset. Needs to be non-negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter. - * @param {boolean} [params.ignore_throttled] - If `true`, concrete, expanded or aliased indices will be ignored when frozen. + * @param {boolean} [params.ignore_throttled] - If `true`, concrete, expanded or aliased indexes will be ignored when frozen. * @param {boolean} [params.ignore_unavailable] - If `false`, the request returns an error if it targets a missing or closed index. * @param {boolean} [params.include_named_queries_score=false] - Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) * @param {boolean} [params.lenient] - If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can only be used when the `q` query string parameter is specified. @@ -65,13 +65,13 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @param {string} [params.suggest_mode] - Specifies the suggest mode. This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. * @param {number} [params.suggest_size] - Number of suggestions to return. This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. * @param {string} [params.suggest_text] - The source text for which the suggestions should be returned. This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. - * @param {number} [params.terminate_after] - Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. Use with caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. If set to `0` (default), the query does not terminate early. + * @param {number} [params.terminate_after] - Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. Use with caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers. If set to `0` (default), the query does not terminate early. * @param {string} [params.timeout] - Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. * @param {boolean} [params.track_scores] - If `true`, calculate and return document scores, even if the scores are not used for sorting. * @param {string} [params.track_total_hits] - Number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query. * @param {boolean} [params.typed_keys] - If `true`, aggregation and suggester names are be prefixed by their respective types in the response. * @param {boolean} [params.version] - If `true`, returns document version as part of a hit. - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`. + * @param {string} [params.index] - Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams and indexes, omit this parameter or use `*` or `_all`. * @param {object} [params.body] - The search definition using the Query DSL * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/_core/searchShards.js b/api/_core/searchShards.js index 542da6e53..991bc8a6b 100644 --- a/api/_core/searchShards.js +++ b/api/_core/searchShards.js @@ -19,19 +19,19 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Returns information about the indices and shards that a search request would be executed against. + * Returns information about the indexes and shards that a search request would be executed against. *
See Also: {@link https://opensearch.org/docs/latest - search_shards} * * @memberOf API-Core * * @param {object} [params] - * @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 indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + * @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`. * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * @param {boolean} [params.ignore_unavailable] - If `false`, the request returns an error if it targets a missing or closed index. * @param {boolean} [params.local=false] - If `true`, the request retrieves information from the local node only. * @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 indices and shards that a search request would be executed against. + * @param {string} [params.index] - Returns the indexes and shards that a search request would be executed against. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/_core/searchTemplate.js b/api/_core/searchTemplate.js index 13f8bbae3..34c7bad4b 100644 --- a/api/_core/searchTemplate.js +++ b/api/_core/searchTemplate.js @@ -25,11 +25,11 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Core * * @param {object} params - * @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 indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + * @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`. * @param {boolean} [params.ccs_minimize_roundtrips=true] - If `true`, network round-trips are minimized for cross-cluster search requests. * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * @param {boolean} [params.explain] - If `true`, the response includes additional details about score computation as part of a hit. - * @param {boolean} [params.ignore_throttled] - If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. + * @param {boolean} [params.ignore_throttled] - If `true`, specified concrete, expanded, or aliased indexes are not included in the response when throttled. * @param {boolean} [params.ignore_unavailable] - If `false`, the request returns an error if it targets a missing or closed index. * @param {string} [params.preference=random] - Specifies the node or shard the operation should be performed on. Random by default. * @param {boolean} [params.profile] - If `true`, the query execution is profiled. @@ -38,7 +38,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @param {string} [params.scroll] - Specifies how long a consistent view of the index should be maintained for scrolled search. * @param {string} [params.search_type] - The type of the search operation. * @param {boolean} [params.typed_keys] - If `true`, the response prefixes aggregation and suggester names with their respective types. - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*). + * @param {string} [params.index] - Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (*). * @param {object} params.body - The search definition template and its params * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/_core/updateByQuery.js b/api/_core/updateByQuery.js index 3b5d80480..8320ab945 100644 --- a/api/_core/updateByQuery.js +++ b/api/_core/updateByQuery.js @@ -29,7 +29,7 @@ for example to pick up a mapping change. * @param {array} [params._source] - 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 indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + * @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`. * @param {boolean} [params.analyze_wildcard=false] - If `true`, wildcard and prefix queries are analyzed. * @param {string} [params.analyzer] - Analyzer to use for the query string. * @param {string} [params.conflicts] - What to do if update by query hits version conflicts: `abort` or `proceed`. @@ -55,12 +55,12 @@ for example to pick up a mapping change. * @param {string} [params.slices] - The number of slices this task should be divided into. * @param {array} [params.sort] - A comma-separated list of : pairs. * @param {array} [params.stats] - Specific `tag` of the request for logging and statistical purposes. - * @param {number} [params.terminate_after] - Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. Use with caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + * @param {number} [params.terminate_after] - Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. Use with caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers. * @param {string} [params.timeout] - Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. * @param {boolean} [params.version] - If `true`, returns the document version as part of a hit. * @param {string} [params.wait_for_active_shards] - The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). * @param {boolean} [params.wait_for_completion=true] - If `true`, the request blocks until the operation is complete. - * @param {string} params.index - Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`. + * @param {string} params.index - Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams or indexes, omit this parameter or use `*` or `_all`. * @param {object} [params.body] - The search definition using the Query DSL * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/_types/_common.analysis.d.ts b/api/_types/_common.analysis.d.ts index 83f74f701..4774968ec 100644 --- a/api/_types/_common.analysis.d.ts +++ b/api/_types/_common.analysis.d.ts @@ -16,7 +16,7 @@ import * as Common from './_common' -export type Analyzer = CustomAnalyzer | FingerprintAnalyzer | KeywordAnalyzer | LanguageAnalyzer | NoriAnalyzer | PatternAnalyzer | SimpleAnalyzer | StandardAnalyzer | StopAnalyzer | WhitespaceAnalyzer | IcuAnalyzer | KuromojiAnalyzer | SnowballAnalyzer | DutchAnalyzer | SmartcnAnalyzer | CjkAnalyzer +export type Analyzer = CustomAnalyzer | FingerprintAnalyzer | KeywordAnalyzer | LanguageAnalyzer | NoriAnalyzer | PatternAnalyzer | SimpleAnalyzer | StandardAnalyzer | StopAnalyzer | WhitespaceAnalyzer | IcuAnalyzer | KuromojiAnalyzer | SnowballAnalyzer | DutchAnalyzer | SmartcnAnalyzer | CjkAnalyzer | PhoneAnalyzer export type AsciiFoldingTokenFilter = TokenFilterBase & { preserve_original?: Common.Stringifiedboolean; @@ -438,6 +438,11 @@ export type PersianStemTokenFilter = TokenFilterBase & { type: 'persian_stem'; } +export type PhoneAnalyzer = { + 'phone-region'?: string; + type?: 'phone' | 'phone-search'; +} + export type PhoneticEncoder = 'beider_morse' | 'caverphone1' | 'caverphone2' | 'cologne' | 'daitch_mokotoff' | 'double_metaphone' | 'haasephonetik' | 'koelnerphonetik' | 'metaphone' | 'nysiis' | 'refined_soundex' | 'soundex' export type PhoneticLanguage = 'any' | 'common' | 'cyrillic' | 'english' | 'french' | 'german' | 'hebrew' | 'hungarian' | 'polish' | 'romanian' | 'russian' | 'spanish' diff --git a/api/_types/_common.mapping.d.ts b/api/_types/_common.mapping.d.ts index 3a32ec4c1..7b327c418 100644 --- a/api/_types/_common.mapping.d.ts +++ b/api/_types/_common.mapping.d.ts @@ -15,12 +15,12 @@ */ import * as Common from './_common' +import * as Common_Analysis from './_common.analysis' import * as Indices_Common from './indices._common' export type AggregateMetricDoubleProperty = PropertyBase & { default_metric: string; metrics: string[]; - time_series_metric?: TimeSeriesMetricType; type: 'aggregate_metric_double'; } @@ -106,20 +106,6 @@ export type DateRangeProperty = RangePropertyBase & { type: 'date_range'; } -export type DenseVectorIndexOptions = { - ef_construction: number; - m: number; - type: string; -} - -export type DenseVectorProperty = PropertyBase & { - dims: number; - index?: boolean; - index_options?: DenseVectorIndexOptions; - similarity?: string; - type: 'dense_vector'; -} - export type DocValuesPropertyBase = CorePropertyBase & { doc_values?: boolean; } @@ -165,19 +151,6 @@ export type FlatObjectProperty = PropertyBase & { type: 'flat_object'; } -export type FlattenedProperty = PropertyBase & { - boost?: number; - depth_limit?: number; - doc_values?: boolean; - eager_global_ordinals?: boolean; - index?: boolean; - index_options?: IndexOptions; - null_value?: string; - similarity?: string; - split_queries_on_whitespace?: boolean; - type: 'flattened'; -} - export type FloatNumberProperty = NumberPropertyBase & { null_value?: number; type: 'float'; @@ -187,7 +160,7 @@ export type FloatRangeProperty = RangePropertyBase & { type: 'float_range'; } -export type GeoOrientation = 'LEFT' | 'clockwise' | 'cw' | 'left' | 'RIGHT' | 'ccw' | 'counterclockwise' | 'right' +export type GeoOrientation = 'left' | 'LEFT' | 'clockwise' | 'cw' | 'right' | 'RIGHT' | 'counterclockwise' | 'ccw' export type GeoPointProperty = DocValuesPropertyBase & { ignore_malformed?: boolean; @@ -218,6 +191,23 @@ export type HistogramProperty = PropertyBase & { type: 'histogram'; } +export type IcuCollationKeywordProperty = DocValuesPropertyBase & { + alternate?: Common_Analysis.IcuCollationAlternate; + case_first?: Common_Analysis.IcuCollationCaseFirst; + case_level?: boolean; + country?: string; + decomposition?: Common_Analysis.IcuCollationDecomposition; + hiragana_quaternary_mode?: boolean; + index?: boolean; + language?: string; + null_value?: string; + numeric?: boolean; + strength?: Common_Analysis.IcuCollationStrength; + type: 'icu_collation_keyword'; + variable_top?: string; + variant?: string; +} + export type IndexField = { enabled: boolean; } @@ -238,9 +228,6 @@ export type IpProperty = DocValuesPropertyBase & { ignore_malformed?: boolean; index?: boolean; null_value?: string; - on_script_error?: OnScriptError; - script?: Common.Script; - time_series_dimension?: boolean; type: 'ip'; } @@ -263,7 +250,6 @@ export type KeywordProperty = DocValuesPropertyBase & { norms?: boolean; null_value?: string; split_queries_on_whitespace?: boolean; - time_series_dimension?: boolean; type: 'keyword'; } @@ -320,10 +306,6 @@ export type NumberPropertyBase = DocValuesPropertyBase & { coerce?: boolean; ignore_malformed?: boolean; index?: boolean; - on_script_error?: OnScriptError; - script?: Common.Script; - time_series_dimension?: boolean; - time_series_metric?: TimeSeriesMetricType; } export type ObjectProperty = CorePropertyBase & { @@ -331,13 +313,11 @@ export type ObjectProperty = CorePropertyBase & { type?: 'object'; } -export type OnScriptError = 'continue' | 'fail' - export type PercolatorProperty = PropertyBase & { type: 'percolator'; } -export type Property = BinaryProperty | BooleanProperty | JoinProperty | KeywordProperty | MatchOnlyTextProperty | PercolatorProperty | RankFeatureProperty | RankFeaturesProperty | SearchAsYouTypeProperty | TextProperty | VersionProperty | WildcardProperty | DateNanosProperty | DateProperty | AggregateMetricDoubleProperty | DenseVectorProperty | SparseVectorProperty | FlattenedProperty | FlatObjectProperty | NestedProperty | ObjectProperty | CompletionProperty | ConstantKeywordProperty | FieldAliasProperty | HistogramProperty | IpProperty | Murmur3HashProperty | TokenCountProperty | GeoPointProperty | GeoShapeProperty | XyPointProperty | XyShapeProperty | ByteNumberProperty | DoubleNumberProperty | FloatNumberProperty | HalfFloatNumberProperty | IntegerNumberProperty | LongNumberProperty | ScaledFloatNumberProperty | ShortNumberProperty | UnsignedLongNumberProperty | DateRangeProperty | DoubleRangeProperty | FloatRangeProperty | IntegerRangeProperty | IpRangeProperty | LongRangeProperty | KnnVectorProperty +export type Property = BinaryProperty | BooleanProperty | JoinProperty | KeywordProperty | MatchOnlyTextProperty | PercolatorProperty | RankFeatureProperty | RankFeaturesProperty | SearchAsYouTypeProperty | TextProperty | VersionProperty | WildcardProperty | DateNanosProperty | DateProperty | AggregateMetricDoubleProperty | FlatObjectProperty | NestedProperty | ObjectProperty | CompletionProperty | ConstantKeywordProperty | FieldAliasProperty | HistogramProperty | IpProperty | Murmur3HashProperty | TokenCountProperty | GeoPointProperty | GeoShapeProperty | XyPointProperty | XyShapeProperty | ByteNumberProperty | DoubleNumberProperty | FloatNumberProperty | HalfFloatNumberProperty | IntegerNumberProperty | LongNumberProperty | ScaledFloatNumberProperty | ShortNumberProperty | UnsignedLongNumberProperty | DateRangeProperty | DoubleRangeProperty | FloatRangeProperty | IntegerRangeProperty | IpRangeProperty | LongRangeProperty | KnnVectorProperty | IcuCollationKeywordProperty export type PropertyBase = { dynamic?: DynamicMapping; @@ -401,10 +381,6 @@ export type SourceField = { includes?: string[]; } -export type SparseVectorProperty = PropertyBase & { - type: 'sparse_vector'; -} - export type SuggestContext = { name: Common.Name; path?: Common.Field; @@ -437,8 +413,6 @@ export type TextProperty = CorePropertyBase & { type: 'text'; } -export type TimeSeriesMetricType = 'counter' | 'gauge' | 'histogram' | 'position' | 'summary' - export type TokenCountProperty = DocValuesPropertyBase & { analyzer?: string; boost?: number; diff --git a/api/_types/_core.field_caps.d.ts b/api/_types/_core.field_caps.d.ts index 1257b762a..cfc9a71a0 100644 --- a/api/_types/_core.field_caps.d.ts +++ b/api/_types/_core.field_caps.d.ts @@ -15,20 +15,15 @@ */ import * as Common from './_common' -import * as Common_Mapping from './_common.mapping' export type FieldCapability = { aggregatable: boolean; indices?: Common.Indices; meta?: Common.Metadata; metadata_field?: boolean; - metric_conflicts_indices?: Common.IndexName[]; non_aggregatable_indices?: Common.Indices; - non_dimension_indices?: Common.IndexName[]; non_searchable_indices?: Common.Indices; searchable: boolean; - time_series_dimension?: boolean; - time_series_metric?: Common_Mapping.TimeSeriesMetricType; type: string; } diff --git a/api/_types/cluster.stats.d.ts b/api/_types/cluster.stats.d.ts index 34596e3f6..8f695161f 100644 --- a/api/_types/cluster.stats.d.ts +++ b/api/_types/cluster.stats.d.ts @@ -40,16 +40,16 @@ export type ClusterFileSystem = { } export type ClusterIndices = { - analysis: CharFilterTypes; - completion: Common.CompletionStats; - count: number; - docs: Common.DocStats; - fielddata: Common.FielddataStats; - mappings: FieldTypesMappings; - query_cache: Common.QueryCacheStats; - segments: Common.SegmentsStats; - shards: ClusterIndicesShards; - store: Common.StoreStats; + analysis?: CharFilterTypes; + completion?: Common.CompletionStats; + count?: number; + docs?: Common.DocStats; + fielddata?: Common.FielddataStats; + mappings?: FieldTypesMappings; + query_cache?: Common.QueryCacheStats; + segments?: Common.SegmentsStats; + shards?: ClusterIndicesShards; + store?: Common.StoreStats; versions?: IndicesVersions[]; } @@ -121,18 +121,18 @@ export type ClusterNodeCount = { } export type ClusterNodes = { - count: ClusterNodeCount; - discovery_types: Record; - fs: ClusterFileSystem; + count?: ClusterNodeCount; + discovery_types?: Record; + fs?: ClusterFileSystem; indexing_pressure?: IndexingPressure; - ingest: ClusterIngest; - jvm: ClusterJvm; - network_types: ClusterNetworkTypes; - os: ClusterOperatingSystem; - packaging_types: NodePackagingType[]; - plugins: Common.PluginStats[]; - process: ClusterProcess; - versions: Common.VersionString[]; + ingest?: ClusterIngest; + jvm?: ClusterJvm; + network_types?: ClusterNetworkTypes; + os?: ClusterOperatingSystem; + packaging_types?: NodePackagingType[]; + plugins?: Common.PluginStats[]; + process?: ClusterProcess; + versions?: Common.VersionString[]; } export type ClusterOperatingSystem = { @@ -227,6 +227,8 @@ export type IndexingPressureMemorySummary = { replica_rejections?: number; } +export type IndexMetric = '_all' | 'analysis' | 'completion' | 'docs' | 'fielddata' | 'mappings' | 'query_cache' | 'segments' | 'shards' | 'store' + export type IndicesVersions = { index_count: number; primary_shard_count: number; @@ -234,6 +236,8 @@ export type IndicesVersions = { version: Common.VersionString; } +export type Metric = '_all' | 'discovery_type' | 'fs' | 'indices' | 'ingest' | 'jvm' | 'network_types' | 'os' | 'packaging_types' | 'plugins' | 'process' + export type NodePackagingType = { count: number; flavor?: string; @@ -255,8 +259,8 @@ export type OperatingSystemMemoryInfo = { export type StatsResponseBase = Nodes_Common.NodesResponseBase & { cluster_name: Common.Name; cluster_uuid: Common.Uuid; - indices: ClusterIndices; - nodes: ClusterNodes; + indices?: ClusterIndices; + nodes?: ClusterNodes; status: Common.HealthStatus; timestamp: number; } diff --git a/api/_types/indices._common.d.ts b/api/_types/indices._common.d.ts index c70a0323d..8774c8010 100644 --- a/api/_types/indices._common.d.ts +++ b/api/_types/indices._common.d.ts @@ -222,7 +222,6 @@ export type IndexSettings = { 'soft_deletes.retention_lease.period'?: Common.Duration; sort?: IndexSegmentSort; store?: IndexSettingsStore; - time_series?: IndexSettingsTimeSeries; top_metrics_max_size?: number; translog?: Translog; 'translog.durability'?: TranslogDurability; @@ -383,11 +382,6 @@ export type IndexSettingsStore = { type: StorageType; } -export type IndexSettingsTimeSeries = { - end_time?: Common.DateTime; - start_time?: Common.DateTime; -} - export type IndexState = { aliases?: Record; data_stream?: Common.DataStreamName; diff --git a/api/_types/ml._common.d.ts b/api/_types/ml._common.d.ts index 27277342f..ce15892ce 100644 --- a/api/_types/ml._common.d.ts +++ b/api/_types/ml._common.d.ts @@ -73,6 +73,13 @@ export type Memory = { type?: string; } +export type ModelConfig = { + all_config?: string; + embedding_dimension?: number; + framework_type?: string; + model_type?: string; +} + export type ModelGroup = { access: string; created_time?: number; @@ -102,13 +109,19 @@ export type RegisterAgentsRequest = { export type SearchModelsHits = { hits: SearchModelsHitsHit[]; + max_score?: number; total: HitsTotal; } export type SearchModelsHitsHit = { - _id: string; - _index?: string; - model_id: string; + _id?: Common.Id; + _index?: Common.IndexName; + _primary_term?: number; + _score: number; + _seq_no?: Common.SequenceNumber; + _source?: Source; + _version?: Common.VersionNumber; + model_id?: Common.Name; } export type SearchModelsQuery = { @@ -117,7 +130,40 @@ export type SearchModelsQuery = { } export type SearchModelsResponse = { + _shards?: Common.ShardStatistics; hits: SearchModelsHits; + timed_out?: boolean; + took?: number; +} + +export type Source = { + algorithm?: string; + auto_redeploy_retry_times?: number; + chunk_number?: number; + connector_id?: string; + created_time?: number; + current_worker_node_count?: number; + deploy_to_all_nodes?: boolean; + description?: string; + is_hidden?: boolean; + last_deployed_time?: number; + last_registered_time?: number; + last_updated_time?: number; + model_config?: ModelConfig; + model_content_hash_value?: string; + model_content_size_in_bytes?: number; + model_format?: string; + model_group_id?: string; + model_id?: Common.Name; + model_state?: 'DEPLOYED' | 'DEPLOYING' | 'DEPLOY_FAILED' | 'PARTIALLY_DEPLOYED' | 'REGISTERED' | 'REGISTERING'; + model_task_type?: string; + model_version?: string; + name?: string; + planning_worker_node_count?: number; + planning_worker_nodes?: Common.NodeIds[]; + total_chunks?: number; + url?: string; + version?: Common.VersionString; } export type Task = { diff --git a/api/cat/aliases.js b/api/cat/aliases.js index 48bb5a178..3c3a2c98a 100644 --- a/api/cat/aliases.js +++ b/api/cat/aliases.js @@ -19,13 +19,13 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Shows information about currently configured aliases to indices including filter and routing infos. + * Shows information about currently configured aliases to indexes including filter and routing info. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/ - cat.aliases} * * @memberOf API-Cat * * @param {object} [params] - * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indices that are open, closed or both. + * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indexes that are open, closed or both. * @param {string} [params.format] - A short version of the Accept header, e.g. json, yaml. * @param {array} [params.h] - Comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. diff --git a/api/cat/count.js b/api/cat/count.js index f68c0fc47..375b67335 100644 --- a/api/cat/count.js +++ b/api/cat/count.js @@ -19,7 +19,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Provides quick access to the document count of the entire cluster, or individual indices. + * Provides quick access to the document count of the entire cluster, or individual indexes. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-count/ - cat.count} * * @memberOf API-Cat @@ -30,7 +30,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @param {boolean} [params.help=false] - Return help information. * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. * @param {boolean} [params.v=false] - Verbose mode. Display column headers. - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * @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`. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cat/indices.js b/api/cat/indices.js index eb82db649..582696846 100644 --- a/api/cat/indices.js +++ b/api/cat/indices.js @@ -19,7 +19,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Returns information about indices: number of primaries and replicas, document counts, disk size, ... + * Returns information about indexes: number of primaries and replicas, document counts, disk size, ... *
See Also: {@link https://opensearch.org/docs/latest/api-reference/cat/cat-indices/ - cat.indices} * * @memberOf API-Cat @@ -30,7 +30,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @param {string} [params.expand_wildcards] - The type of index that wildcard patterns can match. * @param {string} [params.format] - A short version of the Accept header, e.g. json, yaml. * @param {array} [params.h] - Comma-separated list of column names to display. - * @param {string} [params.health] - The health status used to limit returned indices. By default, the response includes indices of any health status. + * @param {string} [params.health] - The health status used to limit returned indexes. By default, the response includes indexes of any health status. * @param {boolean} [params.help=false] - Return help information. * @param {boolean} [params.include_unloaded_segments=false] - If true, the response includes information from segments that are not loaded into memory. * @param {boolean} [params.local=false] - Return local information, do not retrieve the state from cluster-manager node. @@ -39,7 +39,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @param {array} [params.s] - 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.v=false] - Verbose mode. Display column headers. - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * @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`. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cat/recovery.js b/api/cat/recovery.js index 743335f6b..9e1a95e4b 100644 --- a/api/cat/recovery.js +++ b/api/cat/recovery.js @@ -31,7 +31,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @param {string} [params.format] - A short version of the Accept header, e.g. json, yaml. * @param {array} [params.h] - Comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. - * @param {string} [params.index] - A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * @param {string} [params.index] - A 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`. * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. * @param {string} [params.time] - The unit in which to display time values. * @param {boolean} [params.v=false] - Verbose mode. Display column headers. diff --git a/api/cat/segmentReplication.js b/api/cat/segmentReplication.js index d3322d6d1..f79b403bf 100644 --- a/api/cat/segmentReplication.js +++ b/api/cat/segmentReplication.js @@ -26,16 +26,16 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * * @param {object} [params] * @param {boolean} [params.active_only=false] - If `true`, the response only includes ongoing segment replication events. - * @param {boolean} [params.allow_no_indices] - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + * @param {boolean} [params.allow_no_indices] - Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). * @param {string} [params.bytes] - The unit in which to display byte values. * @param {boolean} [params.completed_only=false] - If `true`, the response only includes latest completed segment replication events. * @param {boolean} [params.detailed=false] - If `true`, the response includes detailed information about segment replications. - * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indices that are open, closed or both. + * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indexes that are open, closed or both. * @param {string} [params.format] - A short version of the Accept header, e.g. json, yaml. * @param {array} [params.h] - Comma-separated list of column names to display. * @param {boolean} [params.help=false] - Return help information. - * @param {boolean} [params.ignore_throttled] - Whether specified concrete, expanded or aliased indices should be ignored when throttled. - * @param {boolean} [params.ignore_unavailable] - Whether specified concrete indices should be ignored when unavailable (missing or closed). + * @param {boolean} [params.ignore_throttled] - Whether specified concrete, expanded or aliased indexes should be ignored when throttled. + * @param {boolean} [params.ignore_unavailable] - Whether specified concrete indexes should be ignored when unavailable (missing or closed). * @param {array} [params.index] - Comma-separated list or wildcard expression of index names to limit the returned information. * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. * @param {array} [params.shards] - Comma-separated list of shards to display. diff --git a/api/cat/segments.js b/api/cat/segments.js index 7f16229f7..7f29e1b90 100644 --- a/api/cat/segments.js +++ b/api/cat/segments.js @@ -33,7 +33,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @param {string} [params.master_timeout] DEPRECATED - Operation timeout for connection to master node. * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. * @param {boolean} [params.v=false] - Verbose mode. Display column headers. - * @param {string} [params.index] - A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * @param {string} [params.index] - A 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`. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cat/shards.js b/api/cat/shards.js index 0c086d2a7..8bf64fd49 100644 --- a/api/cat/shards.js +++ b/api/cat/shards.js @@ -35,7 +35,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @param {array} [params.s] - Comma-separated list of column names or column aliases to sort by. * @param {string} [params.time] - The unit in which to display time values. * @param {boolean} [params.v=false] - Verbose mode. Display column headers. - * @param {string} [params.index] - A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * @param {string} [params.index] - A 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`. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cluster/health.js b/api/cluster/health.js index fecdcb75d..9924767e5 100644 --- a/api/cluster/health.js +++ b/api/cluster/health.js @@ -27,8 +27,8 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @param {object} [params] * @param {string} [params.awareness_attribute] - The awareness attribute for which the health is required. * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indices that are open, closed or both. - * @param {string} [params.level] - Can be one of cluster, indices or shards. Controls the details level of the health information returned. + * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indexes that are open, closed or both. + * @param {string} [params.level] - Can be one of cluster, indexes or shards. Controls the details level of the health information returned. * @param {boolean} [params.local=false] - If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. * @param {string} [params.master_timeout] DEPRECATED - Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. * @param {string} [params.timeout] - Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. @@ -38,7 +38,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @param {boolean} [params.wait_for_no_relocating_shards] - A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. * @param {string} [params.wait_for_nodes] - The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and yellow > red. By default, will not wait for any status. - * @param {string} [params.index] - Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`. + * @param {string} [params.index] - Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indexes in a cluster, omit this parameter or use `_all` or `*`. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cluster/putComponentTemplate.js b/api/cluster/putComponentTemplate.js index 9a9b0d0ef..9dff9362d 100644 --- a/api/cluster/putComponentTemplate.js +++ b/api/cluster/putComponentTemplate.js @@ -29,7 +29,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @param {boolean} [params.create=false] - If `true`, this request cannot replace or update existing component templates. * @param {string} [params.master_timeout] DEPRECATED - Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. * @param {string} [params.timeout] - Operation timeout. - * @param {string} params.name - Name of the component template to create. OpenSearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`. OpenSearch Agent uses these templates to configure backing indices for its data streams. If you use OpenSearch Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. If you don't use OpenSearch Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API. + * @param {string} params.name - Name of the component template to create. OpenSearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`. OpenSearch Agent uses these templates to configure backing indexes for its data streams. If you use OpenSearch Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. If you don't use OpenSearch Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API. * @param {object} params.body - The template definition * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/cluster/state.js b/api/cluster/state.js index 9d2ad67eb..db1da87cd 100644 --- a/api/cluster/state.js +++ b/api/cluster/state.js @@ -25,17 +25,17 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @memberOf API-Cluster * * @param {object} [params] - * @param {boolean} [params.allow_no_indices] - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + * @param {boolean} [params.allow_no_indices] - Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified) * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indices that are open, closed or both. + * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indexes that are open, closed or both. * @param {boolean} [params.flat_settings=false] - Return settings in flat format. - * @param {boolean} [params.ignore_unavailable] - Whether specified concrete indices should be ignored when unavailable (missing or closed) + * @param {boolean} [params.ignore_unavailable] - Whether specified concrete indexes should be ignored when unavailable (missing or closed) * @param {boolean} [params.local=false] - Return local information, do not retrieve the state from cluster-manager node. * @param {string} [params.master_timeout] DEPRECATED - Specify timeout for connection to master * @param {number} [params.wait_for_metadata_version] - Wait for the metadata version to be equal or greater than the specified metadata version * @param {string} [params.wait_for_timeout] - The maximum time to wait for wait_for_metadata_version before timing out * @param {array} [params.metric] - Limit the information returned to the specified metrics - * @param {string} [params.index] - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + * @param {string} [params.index] - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indexes * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/cluster/stats.d.ts b/api/cluster/stats.d.ts index 87587a10d..edef3b682 100644 --- a/api/cluster/stats.d.ts +++ b/api/cluster/stats.d.ts @@ -21,6 +21,8 @@ import * as Global from '../_types/_global' export type Cluster_Stats_Request = Global.Params & { flat_settings?: boolean; + index_metric?: Cluster_Stats.IndexMetric[]; + metric?: Cluster_Stats.Metric[]; node_id?: Common.NodeIds; timeout?: Common.Duration; } diff --git a/api/cluster/stats.js b/api/cluster/stats.js index b2af4b0dd..c37bbaac4 100644 --- a/api/cluster/stats.js +++ b/api/cluster/stats.js @@ -27,6 +27,8 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @param {object} [params] * @param {boolean} [params.flat_settings=false] - If `true`, returns settings in flat format. * @param {string} [params.timeout] - Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response's `_nodes.failed` property. Defaults to no timeout. + * @param {array} [params.index_metric] - Limit the information returned for indexes metric to the specific index metrics. It can be used only if indexes (or all) metric is specified. + * @param {array} [params.metric] - Limit the information returned to the specified metrics * @param {string} [params.node_id] - Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} @@ -37,10 +39,12 @@ const { normalizeArguments, parsePathParam } = require('../utils'); function statsFunc(params, options, callback) { [params, options, callback] = normalizeArguments(params, options, callback); - let { body, node_id, ...querystring } = params; + let { body, index_metric, metric, node_id, ...querystring } = params; + index_metric = parsePathParam(index_metric); + metric = parsePathParam(metric); node_id = parsePathParam(node_id); - const path = ['/_cluster/stats/nodes/', node_id].filter(c => c).join('').replace('//', '/'); + const path = ['/_cluster/stats/', metric, '/', index_metric, '/nodes/', node_id].filter(c => c).join('').replace('//', '/'); const method = 'GET'; body = body || ''; diff --git a/api/danglingIndices/listDanglingIndices.js b/api/danglingIndices/listDanglingIndices.js index e6ec780db..9041597ca 100644 --- a/api/danglingIndices/listDanglingIndices.js +++ b/api/danglingIndices/listDanglingIndices.js @@ -19,7 +19,7 @@ const { normalizeArguments } = require('../utils'); /** - * Returns all dangling indices. + * Returns all dangling indexes. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ - dangling_indices.list_dangling_indices} * * @memberOf API-Dangling-Indices diff --git a/api/indices/addBlock.js b/api/indices/addBlock.js index fc0d833b7..45561fbf2 100644 --- a/api/indices/addBlock.js +++ b/api/indices/addBlock.js @@ -25,14 +25,14 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Indices * * @param {object} params - * @param {boolean} [params.allow_no_indices] - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + * @param {boolean} [params.allow_no_indices] - Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified) * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. - * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indices that are open, closed or both. - * @param {boolean} [params.ignore_unavailable] - Whether specified concrete indices should be ignored when unavailable (missing or closed) + * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indexes that are open, closed or both. + * @param {boolean} [params.ignore_unavailable] - Whether specified concrete indexes should be ignored when unavailable (missing or closed) * @param {string} [params.master_timeout] DEPRECATED - Specify timeout for connection to master * @param {string} [params.timeout] - Explicit operation timeout * @param {string} params.block - The block to add (one of read, write, read_only or metadata) - * @param {string} params.index - A comma separated list of indices to add a block to + * @param {string} params.index - A comma separated list of indexes to add a block to * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/indices/clearCache.js b/api/indices/clearCache.js index e0d8297d4..60c9eab55 100644 --- a/api/indices/clearCache.js +++ b/api/indices/clearCache.js @@ -19,19 +19,19 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Clears all or specific caches for one or more indices. + * Clears all or specific caches for one or more indexes. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/ - indices.clear_cache} * * @memberOf API-Indices * * @param {object} [params] - * @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 indices. This behavior applies even if the request targets other open indices. + * @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. * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * @param {boolean} [params.fielddata] - If `true`, clears the fields cache. Use the `fields` parameter to clear the cache of specific fields only. * @param {string} [params.fields] - Comma-separated list of field names used to limit the `fielddata` parameter. * @param {boolean} [params.file=false] - If true, clears the unused entries from the file cache on nodes with the Search role. * @param {boolean} [params.ignore_unavailable] - If `false`, the request returns an error if it targets a missing or closed index. - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * @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`. * @param {boolean} [params.query] - If `true`, clears the query cache. * @param {boolean} [params.request] - If `true`, clears the request cache. * diff --git a/api/indices/close.js b/api/indices/close.js index 02fe18a0e..23dbc00ac 100644 --- a/api/indices/close.js +++ b/api/indices/close.js @@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Indices * * @param {object} params - * @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 indices. This behavior applies even if the request targets other open indices. + * @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. * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * @param {boolean} [params.ignore_unavailable] - If `false`, the request returns an error if it targets a missing or closed index. diff --git a/api/indices/delete.js b/api/indices/delete.js index 9f0d7ac4c..c455e0df8 100644 --- a/api/indices/delete.js +++ b/api/indices/delete.js @@ -25,13 +25,13 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Indices * * @param {object} params - * @param {boolean} [params.allow_no_indices=false] - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. + * @param {boolean} [params.allow_no_indices=false] - 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. * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * @param {boolean} [params.ignore_unavailable=false] - If `false`, the request returns an error if it targets a missing or closed index. * @param {string} [params.master_timeout] DEPRECATED - Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. * @param {string} [params.timeout] - Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - * @param {string} params.index - Comma-separated list of indices to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (`*`) or `_all`. To use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`. + * @param {string} params.index - Comma-separated list of indexes to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (`*`) or `_all`. To use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/indices/deleteAlias.js b/api/indices/deleteAlias.js index 7cbb62969..347c87d83 100644 --- a/api/indices/deleteAlias.js +++ b/api/indices/deleteAlias.js @@ -28,7 +28,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. * @param {string} [params.master_timeout] DEPRECATED - Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. * @param {string} [params.timeout] - Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - * @param {string} params.index - Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). + * @param {string} params.index - Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). * @param {string} params.name - Comma-separated list of aliases to remove. Supports wildcards (`*`). To remove all aliases, use `*` or `_all`. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/indices/exists.js b/api/indices/exists.js index 18af4186a..28ab92772 100644 --- a/api/indices/exists.js +++ b/api/indices/exists.js @@ -25,14 +25,14 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Indices * * @param {object} params - * @param {boolean} [params.allow_no_indices=false] - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. + * @param {boolean} [params.allow_no_indices=false] - 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. * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * @param {boolean} [params.flat_settings=false] - If `true`, returns settings in flat format. * @param {boolean} [params.ignore_unavailable=false] - If `false`, the request returns an error if it targets a missing or closed index. * @param {boolean} [params.include_defaults=false] - If `true`, return all default settings in the response. * @param {boolean} [params.local=false] - If `true`, the request retrieves information from the local node only. - * @param {string} params.index - Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + * @param {string} params.index - Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/indices/existsAlias.js b/api/indices/existsAlias.js index 0cbe029de..82551f1d5 100644 --- a/api/indices/existsAlias.js +++ b/api/indices/existsAlias.js @@ -25,12 +25,12 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Indices * * @param {object} params - * @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 indices. This behavior applies even if the request targets other open indices. + * @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. * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - * @param {boolean} [params.ignore_unavailable] - If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. + * @param {boolean} [params.ignore_unavailable] - If `false`, requests that include a missing data stream or index in the target indexes or data streams return an error. * @param {boolean} [params.local=false] - If `true`, the request retrieves information from the local node only. * @param {string} params.name - Comma-separated list of aliases to check. Supports wildcards (`*`). - * @param {string} [params.index] - Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * @param {string} [params.index] - Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/indices/flush.js b/api/indices/flush.js index 8cb1e5eb8..a3af89591 100644 --- a/api/indices/flush.js +++ b/api/indices/flush.js @@ -19,18 +19,18 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Performs the flush operation on one or more indices. + * Performs the flush operation on one or more indexes. *
See Also: {@link https://opensearch.org/docs/latest - indices.flush} * * @memberOf API-Indices * * @param {object} [params] - * @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 indices. This behavior applies even if the request targets other open indices. + * @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. * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * @param {boolean} [params.force] - If `true`, the request forces a flush even if there are no changes to commit to the index. * @param {boolean} [params.ignore_unavailable] - If `false`, the request returns an error if it targets a missing or closed index. * @param {boolean} [params.wait_if_ongoing=true] - If `true`, the flush operation blocks until execution when another flush operation is running. If `false`, OpenSearch returns an error if you request a flush when another flush operation is running. - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases to flush. Supports wildcards (`*`). To flush all data streams and indices, omit this parameter or use `*` or `_all`. + * @param {string} [params.index] - Comma-separated list of data streams, indexes, and aliases to flush. Supports wildcards (`*`). To flush all data streams and indexes, omit this parameter or use `*` or `_all`. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/indices/forcemerge.js b/api/indices/forcemerge.js index 094fa4ea7..085768b98 100644 --- a/api/indices/forcemerge.js +++ b/api/indices/forcemerge.js @@ -19,21 +19,21 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Performs the force merge operation on one or more indices. + * Performs the force merge operation on one or more indexes. *
See Also: {@link https://opensearch.org/docs/latest - indices.forcemerge} * * @memberOf API-Indices * * @param {object} [params] - * @param {boolean} [params.allow_no_indices] - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) - * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indices that are open, closed or both. + * @param {boolean} [params.allow_no_indices] - Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified) + * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indexes that are open, closed or both. * @param {boolean} [params.flush=true] - Specify whether the index should be flushed after performing the operation. - * @param {boolean} [params.ignore_unavailable] - Whether specified concrete indices should be ignored when unavailable (missing or closed) + * @param {boolean} [params.ignore_unavailable] - Whether specified concrete indexes should be ignored when unavailable (missing or closed) * @param {number} [params.max_num_segments] - The number of larger segments into which smaller segments are merged. Set this parameter to 1 to merge all segments into one segment. The default behavior is to perform the merge as necessary. * @param {boolean} [params.only_expunge_deletes] - Specify whether the operation should only expunge deleted documents * @param {boolean} [params.primary_only=false] - Specify whether the operation should only perform on primary shards. Defaults to false. * @param {boolean} [params.wait_for_completion=true] - Should the request wait until the force merge is completed. - * @param {string} [params.index] - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + * @param {string} [params.index] - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indexes * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/indices/get.js b/api/indices/get.js index 7cfbb5b74..93ff4a4c7 100644 --- a/api/indices/get.js +++ b/api/indices/get.js @@ -19,13 +19,13 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Returns information about one or more indices. + * Returns information about one or more indexes. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/index-apis/get-index/ - indices.get} * * @memberOf API-Indices * * @param {object} params - * @param {boolean} [params.allow_no_indices=false] - If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + * @param {boolean} [params.allow_no_indices=false] - 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. * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. * @param {string} [params.expand_wildcards] - Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. * @param {boolean} [params.flat_settings=false] - If true, returns settings in flat format. @@ -33,7 +33,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @param {boolean} [params.include_defaults=false] - If true, return all default settings in the response. * @param {boolean} [params.local=false] - If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. * @param {string} [params.master_timeout] DEPRECATED - Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. - * @param {string} params.index - Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. + * @param {string} params.index - Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are supported. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/indices/getAlias.js b/api/indices/getAlias.js index 17409f48f..9244d55ee 100644 --- a/api/indices/getAlias.js +++ b/api/indices/getAlias.js @@ -25,12 +25,12 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @memberOf API-Indices * * @param {object} [params] - * @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 indices. This behavior applies even if the request targets other open indices. + * @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. * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * @param {boolean} [params.ignore_unavailable] - If `false`, the request returns an error if it targets a missing or closed index. * @param {boolean} [params.local=false] - If `true`, the request retrieves information from the local node only. * @param {string} [params.name] - Comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. - * @param {string} [params.index] - Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * @param {string} [params.index] - Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/indices/getFieldMapping.js b/api/indices/getFieldMapping.js index b05fc51ac..8fabf98e6 100644 --- a/api/indices/getFieldMapping.js +++ b/api/indices/getFieldMapping.js @@ -25,13 +25,13 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Indices * * @param {object} params - * @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 indices. This behavior applies even if the request targets other open indices. + * @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. * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * @param {boolean} [params.ignore_unavailable] - If `false`, the request returns an error if it targets a missing or closed index. * @param {boolean} [params.include_defaults] - If `true`, return all default settings in the response. * @param {boolean} [params.local=false] - If `true`, the request retrieves information from the local node only. * @param {string} params.fields - Comma-separated list or wildcard expression of fields used to limit returned information. - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * @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`. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/indices/getMapping.js b/api/indices/getMapping.js index db70001d0..c48e1a617 100644 --- a/api/indices/getMapping.js +++ b/api/indices/getMapping.js @@ -19,17 +19,17 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Returns mappings for one or more indices. + * Returns mappings for one or more indexes. *
See Also: {@link https://opensearch.org/docs/latest/field-types/index/#get-a-mapping - indices.get_mapping} * * @memberOf API-Indices * * @param {object} [params] - * @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 indices. This behavior applies even if the request targets other open indices. + * @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. * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * @param {boolean} [params.ignore_unavailable] - If `false`, the request returns an error if it targets a missing or closed index. - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * @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`. * @param {boolean} [params.local=false] - If `true`, the request retrieves information from the local node only. * @param {string} [params.master_timeout] DEPRECATED - Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. * diff --git a/api/indices/getSettings.js b/api/indices/getSettings.js index 2d3546543..8f14780a3 100644 --- a/api/indices/getSettings.js +++ b/api/indices/getSettings.js @@ -19,13 +19,13 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Returns settings for one or more indices. + * Returns settings for one or more indexes. *
See Also: {@link https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ - indices.get_settings} * * @memberOf API-Indices * * @param {object} [params] - * @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 indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with `bar`. + * @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`. * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. * @param {boolean} [params.flat_settings=false] - If `true`, returns settings in flat format. @@ -34,7 +34,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @param {boolean} [params.local=false] - If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. * @param {string} [params.master_timeout] DEPRECATED - Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. * @param {string} [params.name] - Comma-separated list or wildcard expression of settings to retrieve. - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * @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`. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/indices/getUpgrade.js b/api/indices/getUpgrade.js index 939fd9164..cb6873e0e 100644 --- a/api/indices/getUpgrade.js +++ b/api/indices/getUpgrade.js @@ -25,10 +25,10 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @memberOf API-Indices * * @param {object} [params] - * @param {boolean} [params.allow_no_indices] - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). - * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indices that are open, closed or both. - * @param {boolean} [params.ignore_unavailable] - Whether specified concrete indices should be ignored when unavailable (missing or closed). - * @param {array} [params.index] - Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + * @param {boolean} [params.allow_no_indices] - Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). + * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indexes that are open, closed or both. + * @param {boolean} [params.ignore_unavailable] - Whether specified concrete indexes should be ignored when unavailable (missing or closed). + * @param {array} [params.index] - Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/indices/open.js b/api/indices/open.js index 6b6dfdda3..07ed538fd 100644 --- a/api/indices/open.js +++ b/api/indices/open.js @@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Indices * * @param {object} params - * @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 indices. This behavior applies even if the request targets other open indices. + * @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. * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * @param {boolean} [params.ignore_unavailable] - If `false`, the request returns an error if it targets a missing or closed index. @@ -34,7 +34,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @param {string} [params.timeout] - Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. * @param {string} [params.wait_for_active_shards] - The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). * @param {boolean} [params.wait_for_completion=true] - Should this request wait until the operation has completed before returning. - * @param {string} params.index - Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). By default, you must explicitly name the indices you using to limit the request. To limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false. You can update this setting in the `opensearch.yml` file or using the cluster update settings API. + * @param {string} params.index - Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). By default, you must explicitly name the indexes you using to limit the request. To limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false. You can update this setting in the `opensearch.yml` file or using the cluster update settings API. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/indices/putAlias.js b/api/indices/putAlias.js index 3e6f4409e..dc255d1f0 100644 --- a/api/indices/putAlias.js +++ b/api/indices/putAlias.js @@ -29,7 +29,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @param {string} [params.master_timeout] DEPRECATED - Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. * @param {string} [params.timeout] - Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. * @param {string} [params.name] - Alias to update. If the alias doesn't exist, the request creates it. Index alias names support date math. - * @param {string} [params.index] - Comma-separated list of data streams or indices to add. Supports wildcards (`*`). Wildcard patterns that match both data streams and indices return an error. + * @param {string} [params.index] - Comma-separated list of data streams or indexes to add. Supports wildcards (`*`). Wildcard patterns that match both data streams and indexes return an error. * @param {object} [params.body] - The settings for the alias, such as `routing` or `filter` * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/indices/putMapping.js b/api/indices/putMapping.js index 4b817aab9..9a4e82238 100644 --- a/api/indices/putMapping.js +++ b/api/indices/putMapping.js @@ -25,14 +25,14 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Indices * * @param {object} params - * @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 indices. This behavior applies even if the request targets other open indices. + * @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. * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * @param {boolean} [params.ignore_unavailable] - If `false`, the request returns an error if it targets a missing or closed index. * @param {string} [params.master_timeout] DEPRECATED - Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. * @param {string} [params.timeout] - Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. * @param {boolean} [params.write_index_only=false] - If `true`, the mappings are applied only to the current write index for the target. - * @param {string} params.index - A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. + * @param {string} params.index - A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indexes. * @param {object} params.body - The mapping definition * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/indices/putSettings.js b/api/indices/putSettings.js index 2b64fc976..a6263f3aa 100644 --- a/api/indices/putSettings.js +++ b/api/indices/putSettings.js @@ -25,15 +25,15 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Indices * * @param {object} params - * @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 indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + * @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`. * @param {string} [params.cluster_manager_timeout] - Operation timeout for connection to cluster-manager node. * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. * @param {boolean} [params.flat_settings=false] - If `true`, returns settings in flat format. - * @param {boolean} [params.ignore_unavailable] - Whether specified concrete indices should be ignored when unavailable (missing or closed). + * @param {boolean} [params.ignore_unavailable] - Whether specified concrete indexes should be ignored when unavailable (missing or closed). * @param {string} [params.master_timeout] DEPRECATED - Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. * @param {boolean} [params.preserve_existing=false] - If `true`, existing index settings remain unchanged. * @param {string} [params.timeout] - Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * @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`. * @param {object} params.body - The index settings to be updated. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/indices/recovery.js b/api/indices/recovery.js index 001ffa3fc..7e1285abc 100644 --- a/api/indices/recovery.js +++ b/api/indices/recovery.js @@ -27,7 +27,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @param {object} [params] * @param {boolean} [params.active_only=false] - If `true`, the response only includes ongoing shard recoveries. * @param {boolean} [params.detailed=false] - If `true`, the response includes detailed information about shard recoveries. - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * @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`. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/indices/refresh.js b/api/indices/refresh.js index 8721b8a8a..f54109c9c 100644 --- a/api/indices/refresh.js +++ b/api/indices/refresh.js @@ -19,16 +19,16 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Performs the refresh operation in one or more indices. + * Performs the refresh operation in one or more indexes. *
See Also: {@link https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability - indices.refresh} * * @memberOf API-Indices * * @param {object} [params] - * @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 indices. This behavior applies even if the request targets other open indices. + * @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. * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * @param {boolean} [params.ignore_unavailable] - If `false`, the request returns an error if it targets a missing or closed index. - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * @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`. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/indices/resolveIndex.js b/api/indices/resolveIndex.js index 5d75274d4..a8353a7d2 100644 --- a/api/indices/resolveIndex.js +++ b/api/indices/resolveIndex.js @@ -19,14 +19,14 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Returns information about any matching indices, aliases, and data streams. + * Returns information about any matching indexes, aliases, and data streams. *
See Also: {@link https://opensearch.org/docs/latest - indices.resolve_index} * * @memberOf API-Indices * * @param {object} params * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - * @param {string} params.name - Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the ``:`` syntax. + * @param {string} params.name - Comma-separated name(s) or index pattern(s) of the indexes, aliases, and data streams to resolve. Resources on remote clusters can be specified using the ``:`` syntax. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/indices/segments.js b/api/indices/segments.js index 54d36260d..f448610e2 100644 --- a/api/indices/segments.js +++ b/api/indices/segments.js @@ -25,11 +25,11 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @memberOf API-Indices * * @param {object} [params] - * @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 indices. This behavior applies even if the request targets other open indices. + * @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. * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. * @param {boolean} [params.ignore_unavailable] - If `false`, the request returns an error if it targets a missing or closed index. * @param {boolean} [params.verbose=false] - If `true`, the request returns a verbose response. - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + * @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`. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/indices/shardStores.js b/api/indices/shardStores.js index e0946a0a6..c441b1d5b 100644 --- a/api/indices/shardStores.js +++ b/api/indices/shardStores.js @@ -19,17 +19,17 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Provides store information for shard copies of indices. + * Provides store information for shard copies of indexes. *
See Also: {@link https://opensearch.org/docs/latest - indices.shard_stores} * * @memberOf API-Indices * * @param {object} [params] - * @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 indices. This behavior applies even if the request targets other open indices. + * @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. * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - * @param {boolean} [params.ignore_unavailable] - If true, missing or closed indices are not included in the response. + * @param {boolean} [params.ignore_unavailable] - If true, missing or closed indexes are not included in the response. * @param {string} [params.status] - List of shard health statuses used to limit the request. - * @param {string} [params.index] - List of data streams, indices, and aliases used to limit the request. + * @param {string} [params.index] - List of data streams, indexes, and aliases used to limit the request. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/indices/stats.js b/api/indices/stats.js index bbe833251..cc3ed7d0d 100644 --- a/api/indices/stats.js +++ b/api/indices/stats.js @@ -29,13 +29,13 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @param {string} [params.expand_wildcards] - Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. * @param {string} [params.fielddata_fields] - Comma-separated list or wildcard expressions of fields to include in fielddata statistics. * @param {string} [params.fields] - Comma-separated list or wildcard expressions of fields to include in the statistics. - * @param {boolean} [params.forbid_closed_indices=true] - If true, statistics are not collected from closed indices. + * @param {boolean} [params.forbid_closed_indices=true] - If true, statistics are not collected from closed indexes. * @param {string} [params.groups] - Comma-separated list of search groups to include in the search statistics. * @param {boolean} [params.include_segment_file_sizes=false] - If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). * @param {boolean} [params.include_unloaded_segments=false] - If true, the response includes information from segments that are not loaded into memory. * @param {string} [params.level] - Indicates whether statistics are aggregated at the cluster, index, or shard level. * @param {string} [params.metric] - Limit the information returned the specific metrics. - * @param {string} [params.index] - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + * @param {string} [params.index] - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indexes * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/indices/upgrade.js b/api/indices/upgrade.js index 00eeb2a93..6080974d9 100644 --- a/api/indices/upgrade.js +++ b/api/indices/upgrade.js @@ -25,12 +25,12 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @memberOf API-Indices * * @param {object} [params] - * @param {boolean} [params.allow_no_indices] - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). - * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indices that are open, closed or both. - * @param {boolean} [params.ignore_unavailable] - Whether specified concrete indices should be ignored when unavailable (missing or closed). + * @param {boolean} [params.allow_no_indices] - Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). + * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indexes that are open, closed or both. + * @param {boolean} [params.ignore_unavailable] - Whether specified concrete indexes should be ignored when unavailable (missing or closed). * @param {boolean} [params.only_ancient_segments] - If true, only ancient (an older Lucene major release) segments will be upgraded. * @param {boolean} [params.wait_for_completion=false] - Should this request wait until the operation has completed before returning. - * @param {array} [params.index] - Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + * @param {array} [params.index] - Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/indices/validateQuery.js b/api/indices/validateQuery.js index 3153215d5..8861274e9 100644 --- a/api/indices/validateQuery.js +++ b/api/indices/validateQuery.js @@ -26,7 +26,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * * @param {object} [params] * @param {boolean} [params.all_shards] - If `true`, the validation is executed on all shards instead of one random shard per index. - * @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 indices. This behavior applies even if the request targets other open indices. + * @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. * @param {boolean} [params.analyze_wildcard=false] - If `true`, wildcard and prefix queries are analyzed. * @param {string} [params.analyzer] - Analyzer to use for the query string. This parameter can only be used when the `q` query string parameter is specified. * @param {string} [params.default_operator] - The default operator for query string query: `AND` or `OR`. @@ -37,7 +37,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @param {boolean} [params.lenient] - If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. * @param {string} [params.q] - Query in the Lucene query string syntax. * @param {boolean} [params.rewrite] - If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`. + * @param {string} [params.index] - Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams or indexes, omit this parameter or use `*` or `_all`. * @param {object} [params.body] - The query definition specified with the Query DSL * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/ism/addPolicy.js b/api/ism/addPolicy.js index c9b4505b9..e42f401b2 100644 --- a/api/ism/addPolicy.js +++ b/api/ism/addPolicy.js @@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @memberOf API-Ism * * @param {object} [params] - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + * @param {string} [params.index] - Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). * @param {object} [params.body] * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/ism/changePolicy.js b/api/ism/changePolicy.js index aa5026d7d..c0224aa4f 100644 --- a/api/ism/changePolicy.js +++ b/api/ism/changePolicy.js @@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @memberOf API-Ism * * @param {object} [params] - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + * @param {string} [params.index] - Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). * @param {object} [params.body] * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/ism/explainPolicy.js b/api/ism/explainPolicy.js index 1218c0da8..7ad25874e 100644 --- a/api/ism/explainPolicy.js +++ b/api/ism/explainPolicy.js @@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @memberOf API-Ism * * @param {object} [params] - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + * @param {string} [params.index] - Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). * @param {string} [params.body] * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/ism/refreshSearchAnalyzers.js b/api/ism/refreshSearchAnalyzers.js index 7874fe134..3bb59e051 100644 --- a/api/ism/refreshSearchAnalyzers.js +++ b/api/ism/refreshSearchAnalyzers.js @@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Ism * * @param {object} params - * @param {string} params.index - Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + * @param {string} params.index - Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/ism/removePolicy.js b/api/ism/removePolicy.js index d29f5dbc0..87390b9cf 100644 --- a/api/ism/removePolicy.js +++ b/api/ism/removePolicy.js @@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @memberOf API-Ism * * @param {object} [params] - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + * @param {string} [params.index] - Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/ism/retryIndex.js b/api/ism/retryIndex.js index 4ead79c7d..bdd6eade3 100644 --- a/api/ism/retryIndex.js +++ b/api/ism/retryIndex.js @@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @memberOf API-Ism * * @param {object} [params] - * @param {string} [params.index] - Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + * @param {string} [params.index] - Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). * @param {object} [params.body] * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/knn/searchModels.js b/api/knn/searchModels.js index 411103a5a..a3bba5d90 100644 --- a/api/knn/searchModels.js +++ b/api/knn/searchModels.js @@ -28,7 +28,7 @@ const { normalizeArguments } = require('../utils'); * @param {array} [params._source] - 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] - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + * @param {boolean} [params.allow_no_indices] - Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). * @param {boolean} [params.allow_partial_search_results=true] - Indicate if an error should be returned if there is a partial search failure or timeout. * @param {boolean} [params.analyze_wildcard=false] - Specify whether wildcard and prefix queries should be analyzed. * @param {string} [params.analyzer] - The analyzer to use for the query string. @@ -37,11 +37,11 @@ const { normalizeArguments } = require('../utils'); * @param {string} [params.default_operator] - The default operator for query string query (AND or OR). * @param {string} [params.df] - The field to use as default where no field prefix is given in the query string. * @param {array} [params.docvalue_fields] - Comma-separated list of fields to return as the docvalue representation of a field for each hit. - * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indices that are open, closed or both. + * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indexes that are open, closed or both. * @param {boolean} [params.explain] - Specify whether to return detailed information about score computation as part of a hit. * @param {number} [params.from=0] - Starting offset. - * @param {boolean} [params.ignore_throttled] - Whether specified concrete, expanded or aliased indices should be ignored when throttled. - * @param {boolean} [params.ignore_unavailable] - Whether specified concrete indices should be ignored when unavailable (missing or closed). + * @param {boolean} [params.ignore_throttled] - Whether specified concrete, expanded or aliased indexes should be ignored when throttled. + * @param {boolean} [params.ignore_unavailable] - Whether specified concrete indexes should be ignored when unavailable (missing or closed). * @param {boolean} [params.lenient] - Specify whether format-based query failures (such as providing text to a numeric field) should be ignored. * @param {number} [params.max_concurrent_shard_requests=5] - The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. * @param {number} [params.pre_filter_shard_size] - Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. diff --git a/api/knn/warmup.js b/api/knn/warmup.js index d33acf2b7..815cee29c 100644 --- a/api/knn/warmup.js +++ b/api/knn/warmup.js @@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Knn * * @param {object} params - * @param {array} params.index - Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + * @param {array} params.index - Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/nodes/stats.js b/api/nodes/stats.js index 0c2de6bbd..9e08d7834 100644 --- a/api/nodes/stats.js +++ b/api/nodes/stats.js @@ -35,7 +35,7 @@ const { normalizeArguments, parsePathParam } = require('../utils'); * @param {array} [params.types] - A comma-separated list of document types for the indexing index metric. * @param {string} [params.node_id] - Comma-separated list of node IDs or names used to limit returned information. * @param {array} [params.metric] - Limit the information returned to the specified metrics - * @param {array} [params.index_metric] - Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified. + * @param {array} [params.index_metric] - Limit the information returned for indexes metric to the specific index metrics. It can be used only if indexes (or all) metric is specified. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/security/createAllowlist.js b/api/security/createAllowlist.js index 8b4315b57..c504ae7eb 100644 --- a/api/security/createAllowlist.js +++ b/api/security/createAllowlist.js @@ -19,7 +19,7 @@ const { normalizeArguments, handleMissingParam } = require('../utils'); /** - * Creates or replaces the allowlisted APIs. Accessible via Super Admin certificate or REST API permission. + * Creates or replaces the permitted APIs. Accessible using Super Admin certificate or REST API permission. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api - security.create_allowlist} * * @memberOf API-Security diff --git a/api/snapshot/clone.js b/api/snapshot/clone.js index aedb11285..88eace928 100644 --- a/api/snapshot/clone.js +++ b/api/snapshot/clone.js @@ -19,7 +19,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Clones indices from one snapshot into another snapshot in the same repository. + * Clones indexes from one snapshot into another snapshot in the same repository. *
See Also: {@link https://opensearch.org/docs/latest - snapshot.clone} * * @memberOf API-Snapshot diff --git a/api/wlm/createQueryGroup.js b/api/wlm/createQueryGroup.js index 887b9b19c..91b37339c 100644 --- a/api/wlm/createQueryGroup.js +++ b/api/wlm/createQueryGroup.js @@ -19,7 +19,7 @@ const { normalizeArguments, handleMissingParam } = require('../utils'); /** - * Creates the specified query group. + * Creates a new query group and sets the resource limits for the new query group. *
See Also: {@link undefined - wlm.create_query_group} * * @memberOf API-Wlm diff --git a/api/wlm/deleteQueryGroup.js b/api/wlm/deleteQueryGroup.js index e8af2461d..ce33b2289 100644 --- a/api/wlm/deleteQueryGroup.js +++ b/api/wlm/deleteQueryGroup.js @@ -19,13 +19,13 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Deletes the specified QueryGroup. + * Deletes the specified query group. *
See Also: {@link undefined - wlm.delete_query_group} * * @memberOf API-Wlm * * @param {object} params - * @param {string} params.name - QueryGroup name. + * @param {string} params.name - The name of the query group. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/wlm/getQueryGroup.js b/api/wlm/getQueryGroup.js index c5c2f55d2..219610ba4 100644 --- a/api/wlm/getQueryGroup.js +++ b/api/wlm/getQueryGroup.js @@ -19,13 +19,13 @@ const { normalizeArguments, parsePathParam } = require('../utils'); /** - * Gets the specified QueryGroup or get all if no name is provided. + * Retrieves the specified query group. If no query group is specified, all query groups in the cluster are retrieved. *
See Also: {@link undefined - wlm.get_query_group} * * @memberOf API-Wlm * * @param {object} [params] - * @param {string} [params.name] - QueryGroup name. + * @param {string} [params.name] - The name of the query group. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/wlm/updateQueryGroup.js b/api/wlm/updateQueryGroup.js index e9c44f1e1..e31e262aa 100644 --- a/api/wlm/updateQueryGroup.js +++ b/api/wlm/updateQueryGroup.js @@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Wlm * * @param {object} params - * @param {string} params.name - QueryGroup name. + * @param {string} params.name - The name of the query group. * @param {object} params.body * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request}