diff --git a/CHANGELOG.md b/CHANGELOG.md index ca02573c..eb2d2c41 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ### Fixed - Fixed Search helper to ensure proper retention of the _collapse attribute in chained operations. ([#771](https://github.com/opensearch-project/opensearch-py/pull/771)) ### Updated APIs +- Updated opensearch-py APIs to reflect [opensearch-api-specification@0b033a9](https://github.com/opensearch-project/opensearch-api-specification/commit/0b033a92cac4cb20ec3fb51350c139afc753b089) - Updated opensearch-py APIs to reflect [opensearch-api-specification@d5ca873](https://github.com/opensearch-project/opensearch-api-specification/commit/d5ca873d20ff54be16ec48e7bd629cda7c4a6332) - Updated opensearch-py APIs to reflect [opensearch-api-specification@7452827](https://github.com/opensearch-project/opensearch-api-specification/commit/745282767026703ea27967d2705633c3e2661c97) - Updated opensearch-py APIs to reflect [opensearch-api-specification@f2afd71](https://github.com/opensearch-project/opensearch-api-specification/commit/f2afd7171406c7477fbd644d74087bb0e2948c75) diff --git a/opensearchpy/_async/client/__init__.py b/opensearchpy/_async/client/__init__.py index 52cb54a6..fa2b9f65 100644 --- a/opensearchpy/_async/client/__init__.py +++ b/opensearchpy/_async/client/__init__.py @@ -373,8 +373,8 @@ async def create( control.The specified version must match the current version of the document for the request to succeed. :arg version_type: Specific version type: `external`, - `external_gte`. Valid choices are internal, external, external_gte, - force. + `external_gte`. Valid choices are external, external_gte, force, + internal. :arg 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 @@ -463,8 +463,8 @@ async def index( control.The specified version must match the current version of the document for the request to succeed. :arg version_type: Specific version type: `external`, - `external_gte`. Valid choices are internal, external, external_gte, - force. + `external_gte`. Valid choices are external, external_gte, force, + internal. :arg 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 @@ -658,8 +658,8 @@ async def count( :arg 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 choices are all, open, - closed, hidden, none. + separated values, such as `open,hidden`. Valid choices are all, closed, + hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg human: Whether to return human readable values for @@ -746,8 +746,8 @@ async def delete( control.The specified version must match the current version of the document for the request to succeed. :arg version_type: Specific version type: `external`, - `external_gte`. Valid choices are internal, external, external_gte, - force. + `external_gte`. Valid choices are external, external_gte, force, + internal. :arg 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 @@ -875,7 +875,7 @@ async def delete_by_query( request.Defaults to no timeout. :arg search_type: The type of the search operation.Available options: `query_then_fetch`, `dfs_query_then_fetch`. Valid choices are - query_then_fetch, dfs_query_then_fetch. + dfs_query_then_fetch, query_then_fetch. :arg size: Deprecated, please use `max_docs` instead. :arg slices: The number of slices this task should be divided into. Valid choices are auto. @@ -1066,8 +1066,8 @@ async def exists( control.The specified version must match the current version of the document for the request to succeed. :arg version_type: Specific version type: `external`, - `external_gte`. Valid choices are internal, external, external_gte, - force. + `external_gte`. Valid choices are external, external_gte, force, + internal. """ for param in (index, id): if param in SKIP_IN_PATH: @@ -1134,8 +1134,8 @@ async def exists_source( control.The specified version must match the current version of the document for the request to succeed. :arg version_type: Specific version type: `external`, - `external_gte`. Valid choices are internal, external, external_gte, - force. + `external_gte`. Valid choices are external, external_gte, force, + internal. """ for param in (index, id): if param in SKIP_IN_PATH: @@ -1266,8 +1266,8 @@ async def field_caps( :arg 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 choices are all, open, - closed, hidden, none. + separated values, such as `open,hidden`. Valid choices are all, closed, + hidden, none, open. :arg fields: Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. :arg filter_path: Comma-separated list of filters used to reduce @@ -1353,7 +1353,7 @@ async def get( The specified version must match the current version of the document for the request to succeed. :arg version_type: Specific version type: internal, external, - external_gte. Valid choices are internal, external, external_gte, force. + external_gte. Valid choices are external, external_gte, force, internal. """ for param in (index, id): if param in SKIP_IN_PATH: @@ -1463,7 +1463,7 @@ async def get_source( The specified version must match the current version of the document for the request to succeed. :arg version_type: Specific version type: internal, external, - external_gte. Valid choices are internal, external, external_gte, force. + external_gte. Valid choices are external, external_gte, force, internal. """ for param in (index, id): if param in SKIP_IN_PATH: @@ -1606,7 +1606,7 @@ async def msearch( Default is false. :arg search_type: Indicates whether global term and document frequencies should be used when scoring returned documents. Valid - choices are query_then_fetch, dfs_query_then_fetch. + choices are dfs_query_then_fetch, query_then_fetch. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg typed_keys: Specifies whether aggregation and suggester @@ -1669,7 +1669,7 @@ async def msearch_template( object. Default is false. :arg search_type: The type of the search operation.Available options: `query_then_fetch`, `dfs_query_then_fetch`. Valid choices are - query_then_fetch, dfs_query_then_fetch. + dfs_query_then_fetch, query_then_fetch. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg typed_keys: If `true`, the response prefixes aggregation @@ -1757,7 +1757,7 @@ async def mtermvectors( :arg version: If `true`, returns the document version as part of a hit. :arg version_type: Specific version type. Valid choices are - internal, external, external_gte, force. + external, external_gte, force, internal. """ path = _make_path(index, "_mtermvectors") @@ -1864,7 +1864,7 @@ async def rank_eval( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg human: Whether to return human readable values for @@ -2229,8 +2229,8 @@ async def search( :arg 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 choices are all, open, - closed, hidden, none. + separated values, such as `open,hidden`. Valid choices are all, closed, + hidden, none, open. :arg explain: If `true`, returns detailed information about score computation as part of a hit. :arg filter_path: Comma-separated list of filters used to reduce @@ -2307,8 +2307,8 @@ async def search( :arg search_pipeline: Customizable sequence of processing stages applied to search queries. :arg search_type: How distributed term frequencies are - calculated for relevance scoring. Valid choices are query_then_fetch, - dfs_query_then_fetch. + calculated for relevance scoring. Valid choices are + dfs_query_then_fetch, query_then_fetch. :arg seq_no_primary_term: If `true`, returns sequence number and primary term of the last modification of each hit. :arg size: Defines the number of hits to return.By default, you @@ -2329,7 +2329,7 @@ async def search( suggestions. :arg suggest_mode: Specifies the suggest mode.This parameter can only be used when the `suggest_field` and `suggest_text` query string - parameters are specified. Valid choices are missing, popular, always. + parameters are specified. Valid choices are always, missing, popular. :arg 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. @@ -2502,7 +2502,7 @@ async def search_template( :arg scroll: Specifies how long a consistent view of the indexshould be maintained for scrolled search. :arg search_type: The type of the search operation. Valid - choices are query_then_fetch, dfs_query_then_fetch. + choices are dfs_query_then_fetch, query_then_fetch. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg typed_keys: If `true`, the response prefixes aggregation @@ -2588,7 +2588,7 @@ async def termvectors( :arg version: If `true`, returns the document version as part of a hit. :arg version_type: Specific version type. Valid choices are - internal, external, external_gte, force. + external, external_gte, force, internal. """ if index in SKIP_IN_PATH: raise ValueError("Empty value passed for a required argument 'index'.") @@ -2656,7 +2656,7 @@ async def update( :arg refresh: If 'true', OpenSearch refreshes the affected shards to make this operationvisible to search, if 'wait_for' then wait for a refresh to make this operationvisible to search, if 'false' do - nothing with refreshes. Valid choices are true, false, wait_for. + nothing with refreshes. Valid choices are false, true, wait_for. :arg require_alias: If true, the destination must be an index alias. Default is false. :arg retry_on_conflict: Specify how many times should the @@ -2805,7 +2805,7 @@ async def update_by_query( :arg search_timeout: Explicit timeout for each search request. :arg search_type: The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`. Valid choices are - query_then_fetch, dfs_query_then_fetch. + dfs_query_then_fetch, query_then_fetch. :arg size: Deprecated, please use `max_docs` instead. :arg slices: The number of slices this task should be divided into. Valid choices are auto. @@ -2965,7 +2965,7 @@ async def create_pit( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg human: Whether to return human readable values for diff --git a/opensearchpy/_async/client/cat.py b/opensearchpy/_async/client/cat.py index 6e29839b..203af978 100644 --- a/opensearchpy/_async/client/cat.py +++ b/opensearchpy/_async/client/cat.py @@ -72,7 +72,7 @@ async def aliases( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg format: A short version of the Accept header, e.g. json, @@ -118,7 +118,7 @@ async def all_pit_segments( :arg bytes: The unit in which to display byte values. Valid - choices are b, k, kb, m, mb, g, gb, t, tb, p, pb. + choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg error_trace: Whether to include the stack trace of returned errors. :arg filter_path: Comma-separated list of filters used to reduce @@ -171,7 +171,7 @@ async def allocation( :arg node_id: Comma-separated list of node identifiers or names used to limit the returned information. :arg bytes: The unit used to display byte values. Valid choices - are b, k, kb, m, mb, g, gb, t, tb, p, pb. + are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned @@ -332,7 +332,7 @@ async def fielddata( :arg fields: Comma-separated list of fields used to limit returned information. :arg bytes: The unit used to display byte values. Valid choices - are b, k, kb, m, mb, g, gb, t, tb, p, pb. + are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg error_trace: Whether to include the stack trace of returned errors. :arg filter_path: Comma-separated list of filters used to reduce @@ -398,7 +398,7 @@ async def health( :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg time: The unit used to display time values. Valid choices - are nanos, micros, ms, s, m, h, d. + are d, h, m, micros, ms, nanos, s. :arg ts: If true, returns `HH:MM:SS` and Unix epoch timestamps. Default is True. :arg v: Verbose mode. Display column headers. Default is false. @@ -468,13 +468,13 @@ async def indices( aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. :arg bytes: The unit used to display byte values. Valid choices - are b, k, kb, m, mb, g, gb, t, tb, p, pb. + are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: The type of index that wildcard patterns - can match. Valid choices are all, open, closed, hidden, none. + can match. Valid choices are all, closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg format: A short version of the Accept header, e.g. json, @@ -482,7 +482,7 @@ async def indices( :arg h: Comma-separated list of column names to display. :arg health: The health status used to limit returned indices. By default, the response includes indices of any health status. Valid - choices are green, yellow, red. + choices are green, red, yellow. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for statistics. @@ -503,7 +503,7 @@ async def indices( :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg time: The unit used to display time values. Valid choices - are nanos, micros, ms, s, m, h, d. + are d, h, m, micros, ms, nanos, s. :arg v: Verbose mode. Display column headers. Default is false. """ return await self.transport.perform_request( @@ -649,7 +649,7 @@ async def nodes( :arg bytes: The unit used to display byte values. Valid choices - are b, k, kb, m, mb, g, gb, t, tb, p, pb. + are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned @@ -677,7 +677,7 @@ async def nodes( :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg time: The unit in which to display time values. Valid - choices are nanos, micros, ms, s, m, h, d. + choices are d, h, m, micros, ms, nanos, s. :arg v: Verbose mode. Display column headers. Default is false. """ return await self.transport.perform_request( @@ -733,7 +733,7 @@ async def pending_tasks( :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg time: The unit in which to display time values. Valid - choices are nanos, micros, ms, s, m, h, d. + choices are d, h, m, micros, ms, nanos, s. :arg v: Verbose mode. Display column headers. Default is false. """ return await self.transport.perform_request( @@ -764,7 +764,7 @@ async def pit_segments( :arg bytes: The unit in which to display byte values. Valid - choices are b, k, kb, m, mb, g, gb, t, tb, p, pb. + choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg error_trace: Whether to include the stack trace of returned errors. :arg filter_path: Comma-separated list of filters used to reduce @@ -871,7 +871,7 @@ async def recovery( :arg active_only: If `true`, the response only includes ongoing shard recoveries. Default is false. :arg bytes: The unit used to display byte values. Valid choices - are b, k, kb, m, mb, g, gb, t, tb, p, pb. + are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg detailed: If `true`, the response includes detailed information about shard recoveries. Default is false. :arg error_trace: Whether to include the stack trace of returned @@ -891,7 +891,7 @@ async def recovery( :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg time: The unit in which to display time values. Valid - choices are nanos, micros, ms, s, m, h, d. + choices are d, h, m, micros, ms, nanos, s. :arg v: Verbose mode. Display column headers. Default is false. """ return await self.transport.perform_request( @@ -993,7 +993,7 @@ async def segment_replication( expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). :arg bytes: The unit in which to display byte values. Valid - choices are b, k, kb, m, mb, g, gb, t, tb, p, pb. + choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg completed_only: If `true`, the response only includes latest completed segment replication events. Default is false. :arg detailed: If `true`, the response includes detailed @@ -1002,7 +1002,7 @@ async def segment_replication( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg format: A short version of the Accept header, e.g. json, @@ -1023,7 +1023,7 @@ async def segment_replication( :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg time: The unit in which to display time values. Valid - choices are nanos, micros, ms, s, m, h, d. + choices are d, h, m, micros, ms, nanos, s. :arg timeout: Operation timeout. :arg v: Verbose mode. Display column headers. Default is false. """ @@ -1063,7 +1063,7 @@ async def segments( aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. :arg bytes: The unit used to display byte values. Valid choices - are b, k, kb, m, mb, g, gb, t, tb, p, pb. + are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned @@ -1122,7 +1122,7 @@ async def shards( aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. :arg bytes: The unit used to display byte values. Valid choices - are b, k, kb, m, mb, g, gb, t, tb, p, pb. + are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned @@ -1147,7 +1147,7 @@ async def shards( :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg time: The unit in which to display time values. Valid - choices are nanos, micros, ms, s, m, h, d. + choices are d, h, m, micros, ms, nanos, s. :arg v: Verbose mode. Display column headers. Default is false. """ return await self.transport.perform_request( @@ -1270,7 +1270,7 @@ async def snapshots( :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg time: The unit in which to display time values. Valid - choices are nanos, micros, ms, s, m, h, d. + choices are d, h, m, micros, ms, nanos, s. :arg v: Verbose mode. Display column headers. Default is false. """ return await self.transport.perform_request( @@ -1334,7 +1334,7 @@ async def tasks( :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg time: The unit in which to display time values. Valid - choices are nanos, micros, ms, s, m, h, d. + choices are d, h, m, micros, ms, nanos, s. :arg v: Verbose mode. Display column headers. Default is false. """ return await self.transport.perform_request( diff --git a/opensearchpy/_async/client/cluster.py b/opensearchpy/_async/client/cluster.py index e9691308..9ca9432e 100644 --- a/opensearchpy/_async/client/cluster.py +++ b/opensearchpy/_async/client/cluster.py @@ -82,14 +82,14 @@ async def health( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg human: Whether to return human readable values for statistics. :arg level: Can be one of cluster, indices or shards. Controls the details level of the health information returned. Valid choices are - cluster, indices, shards, awareness_attributes. + awareness_attributes, cluster, indices, shards. :arg local: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. Default is false. @@ -109,8 +109,8 @@ async def health( be active, or 0 to not wait. Valid choices are all, index-setting. :arg wait_for_events: Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the - given priority are processed. Valid choices are immediate, urgent, high, - normal, low, languid. + given priority are processed. Valid choices are high, immediate, + languid, low, normal, urgent. :arg wait_for_no_initializing_shards: A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will @@ -126,7 +126,7 @@ async def health( :arg wait_for_status: One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will - not wait for any status. Valid choices are green, yellow, red. + not wait for any status. Valid choices are green, red, yellow. """ return await self.transport.perform_request( "GET", @@ -219,7 +219,7 @@ async def state( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg flat_settings: Return settings in flat format. Default is diff --git a/opensearchpy/_async/client/indices.py b/opensearchpy/_async/client/indices.py index 40632808..2f421ebf 100644 --- a/opensearchpy/_async/client/indices.py +++ b/opensearchpy/_async/client/indices.py @@ -348,7 +348,7 @@ async def get( can match. If the request can target data streams, this argumentdetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,such as open,hidden. Valid - choices are all, open, closed, hidden, none. + choices are all, closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg flat_settings: If true, returns settings in flat format. @@ -1377,8 +1377,8 @@ async def get_settings( :arg 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 choices are all, open, - closed, hidden, none. + separated values, such as `open,hidden`. Valid choices are all, closed, + hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg flat_settings: If `true`, returns settings in flat format. @@ -1447,8 +1447,8 @@ async def put_settings( :arg expand_wildcards: Type of index that wildcard patterns can match. If the request can targetdata streams, this argument determines whether wildcard expressions matchhidden data streams. Supports comma- - separated values, such as`open,hidden`. Valid choices are all, open, - closed, hidden, none. + separated values, such as`open,hidden`. Valid choices are all, closed, + hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg flat_settings: If `true`, returns settings in flat format. @@ -1520,8 +1520,8 @@ async def stats( :arg expand_wildcards: Type of index that wildcard patterns can match. If the request can target data streams, this argumentdetermines whether wildcard expressions match hidden data streams. Supports comma- - separated values,such as `open,hidden`. Valid choices are all, open, - closed, hidden, none. + separated values,such as `open,hidden`. Valid choices are all, closed, + hidden, none, open. :arg fielddata_fields: Comma-separated list or wildcard expressions of fields to include in fielddata statistics. :arg fields: Comma-separated list or wildcard expressions of @@ -1820,7 +1820,7 @@ async def upgrade( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg human: Whether to return human readable values for @@ -1869,7 +1869,7 @@ async def get_upgrade( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg human: Whether to return human readable values for @@ -1917,7 +1917,7 @@ async def shard_stores( :arg 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. Valid choices - are all, open, closed, hidden, none. + are all, closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg human: Whether to return human readable values for @@ -1969,7 +1969,7 @@ async def forcemerge( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg flush: Specify whether the index should be flushed after @@ -2712,7 +2712,7 @@ async def add_block( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg human: Whether to return human readable values for diff --git a/opensearchpy/_async/client/nodes.py b/opensearchpy/_async/client/nodes.py index eba76488..1a22352f 100644 --- a/opensearchpy/_async/client/nodes.py +++ b/opensearchpy/_async/client/nodes.py @@ -220,8 +220,8 @@ async def hot_threads( the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. - :arg doc_type: The type to sample. Valid choices are cpu, wait, - block. + :arg doc_type: The type to sample. Valid choices are block, cpu, + wait. :arg error_trace: Whether to include the stack trace of returned errors. :arg filter_path: Comma-separated list of filters used to reduce diff --git a/opensearchpy/_async/client/tasks.py b/opensearchpy/_async/client/tasks.py index 7302cbac..62a20654 100644 --- a/opensearchpy/_async/client/tasks.py +++ b/opensearchpy/_async/client/tasks.py @@ -73,7 +73,7 @@ async def list( :arg filter_path: Comma-separated list of filters used to reduce the response. :arg group_by: Key used to group tasks in the response. Valid - choices are nodes, parents, none. + choices are nodes, none, parents. :arg human: Whether to return human readable values for statistics. :arg nodes: Comma-separated list of node IDs or names to limit diff --git a/opensearchpy/_async/plugins/knn.py b/opensearchpy/_async/plugins/knn.py index 033a2559..5a3e668d 100644 --- a/opensearchpy/_async/plugins/knn.py +++ b/opensearchpy/_async/plugins/knn.py @@ -180,7 +180,7 @@ async def search_models( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg explain: Specify whether to return detailed information about score computation as part of a hit. :arg filter_path: Comma-separated list of filters used to reduce @@ -219,7 +219,7 @@ async def search_models( :arg scroll: Specify how long a consistent view of the index should be maintained for scrolled search. :arg search_type: Search operation type. Valid choices are - query_then_fetch, dfs_query_then_fetch. + dfs_query_then_fetch, query_then_fetch. :arg seq_no_primary_term: Specify whether to return sequence number and primary term of the last modification of each hit. :arg size: Number of hits to return. Default is 10. @@ -232,7 +232,7 @@ async def search_models( return. :arg suggest_field: Specify which field to use for suggestions. :arg suggest_mode: Specify suggest mode. Valid choices are - missing, popular, always. + always, missing, popular. :arg suggest_size: How many suggestions to return in response. :arg suggest_text: The source text for which the suggestions should be returned. diff --git a/opensearchpy/_async/plugins/notifications.py b/opensearchpy/_async/plugins/notifications.py index 0a7e38a1..660c5fe1 100644 --- a/opensearchpy/_async/plugins/notifications.py +++ b/opensearchpy/_async/plugins/notifications.py @@ -212,8 +212,8 @@ async def get_configs( :arg config_type: Type of notification configuration. Valid - choices are slack, chime, microsoft_teams, webhook, email, sns, - ses_account, smtp_account, email_group. + choices are chime, email, email_group, microsoft_teams, ses_account, + slack, smtp_account, sns, webhook. :arg error_trace: Whether to include the stack trace of returned errors. :arg filter_path: Comma-separated list of filters used to reduce diff --git a/opensearchpy/client/__init__.py b/opensearchpy/client/__init__.py index 77343473..37d69b54 100644 --- a/opensearchpy/client/__init__.py +++ b/opensearchpy/client/__init__.py @@ -373,8 +373,8 @@ def create( control.The specified version must match the current version of the document for the request to succeed. :arg version_type: Specific version type: `external`, - `external_gte`. Valid choices are internal, external, external_gte, - force. + `external_gte`. Valid choices are external, external_gte, force, + internal. :arg 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 @@ -463,8 +463,8 @@ def index( control.The specified version must match the current version of the document for the request to succeed. :arg version_type: Specific version type: `external`, - `external_gte`. Valid choices are internal, external, external_gte, - force. + `external_gte`. Valid choices are external, external_gte, force, + internal. :arg 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 @@ -658,8 +658,8 @@ def count( :arg 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 choices are all, open, - closed, hidden, none. + separated values, such as `open,hidden`. Valid choices are all, closed, + hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg human: Whether to return human readable values for @@ -746,8 +746,8 @@ def delete( control.The specified version must match the current version of the document for the request to succeed. :arg version_type: Specific version type: `external`, - `external_gte`. Valid choices are internal, external, external_gte, - force. + `external_gte`. Valid choices are external, external_gte, force, + internal. :arg 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 @@ -875,7 +875,7 @@ def delete_by_query( request.Defaults to no timeout. :arg search_type: The type of the search operation.Available options: `query_then_fetch`, `dfs_query_then_fetch`. Valid choices are - query_then_fetch, dfs_query_then_fetch. + dfs_query_then_fetch, query_then_fetch. :arg size: Deprecated, please use `max_docs` instead. :arg slices: The number of slices this task should be divided into. Valid choices are auto. @@ -1066,8 +1066,8 @@ def exists( control.The specified version must match the current version of the document for the request to succeed. :arg version_type: Specific version type: `external`, - `external_gte`. Valid choices are internal, external, external_gte, - force. + `external_gte`. Valid choices are external, external_gte, force, + internal. """ for param in (index, id): if param in SKIP_IN_PATH: @@ -1134,8 +1134,8 @@ def exists_source( control.The specified version must match the current version of the document for the request to succeed. :arg version_type: Specific version type: `external`, - `external_gte`. Valid choices are internal, external, external_gte, - force. + `external_gte`. Valid choices are external, external_gte, force, + internal. """ for param in (index, id): if param in SKIP_IN_PATH: @@ -1266,8 +1266,8 @@ def field_caps( :arg 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 choices are all, open, - closed, hidden, none. + separated values, such as `open,hidden`. Valid choices are all, closed, + hidden, none, open. :arg fields: Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. :arg filter_path: Comma-separated list of filters used to reduce @@ -1353,7 +1353,7 @@ def get( The specified version must match the current version of the document for the request to succeed. :arg version_type: Specific version type: internal, external, - external_gte. Valid choices are internal, external, external_gte, force. + external_gte. Valid choices are external, external_gte, force, internal. """ for param in (index, id): if param in SKIP_IN_PATH: @@ -1463,7 +1463,7 @@ def get_source( The specified version must match the current version of the document for the request to succeed. :arg version_type: Specific version type: internal, external, - external_gte. Valid choices are internal, external, external_gte, force. + external_gte. Valid choices are external, external_gte, force, internal. """ for param in (index, id): if param in SKIP_IN_PATH: @@ -1606,7 +1606,7 @@ def msearch( Default is false. :arg search_type: Indicates whether global term and document frequencies should be used when scoring returned documents. Valid - choices are query_then_fetch, dfs_query_then_fetch. + choices are dfs_query_then_fetch, query_then_fetch. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg typed_keys: Specifies whether aggregation and suggester @@ -1669,7 +1669,7 @@ def msearch_template( object. Default is false. :arg search_type: The type of the search operation.Available options: `query_then_fetch`, `dfs_query_then_fetch`. Valid choices are - query_then_fetch, dfs_query_then_fetch. + dfs_query_then_fetch, query_then_fetch. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg typed_keys: If `true`, the response prefixes aggregation @@ -1757,7 +1757,7 @@ def mtermvectors( :arg version: If `true`, returns the document version as part of a hit. :arg version_type: Specific version type. Valid choices are - internal, external, external_gte, force. + external, external_gte, force, internal. """ path = _make_path(index, "_mtermvectors") @@ -1864,7 +1864,7 @@ def rank_eval( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg human: Whether to return human readable values for @@ -2229,8 +2229,8 @@ def search( :arg 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 choices are all, open, - closed, hidden, none. + separated values, such as `open,hidden`. Valid choices are all, closed, + hidden, none, open. :arg explain: If `true`, returns detailed information about score computation as part of a hit. :arg filter_path: Comma-separated list of filters used to reduce @@ -2307,8 +2307,8 @@ def search( :arg search_pipeline: Customizable sequence of processing stages applied to search queries. :arg search_type: How distributed term frequencies are - calculated for relevance scoring. Valid choices are query_then_fetch, - dfs_query_then_fetch. + calculated for relevance scoring. Valid choices are + dfs_query_then_fetch, query_then_fetch. :arg seq_no_primary_term: If `true`, returns sequence number and primary term of the last modification of each hit. :arg size: Defines the number of hits to return.By default, you @@ -2329,7 +2329,7 @@ def search( suggestions. :arg suggest_mode: Specifies the suggest mode.This parameter can only be used when the `suggest_field` and `suggest_text` query string - parameters are specified. Valid choices are missing, popular, always. + parameters are specified. Valid choices are always, missing, popular. :arg 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. @@ -2502,7 +2502,7 @@ def search_template( :arg scroll: Specifies how long a consistent view of the indexshould be maintained for scrolled search. :arg search_type: The type of the search operation. Valid - choices are query_then_fetch, dfs_query_then_fetch. + choices are dfs_query_then_fetch, query_then_fetch. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg typed_keys: If `true`, the response prefixes aggregation @@ -2588,7 +2588,7 @@ def termvectors( :arg version: If `true`, returns the document version as part of a hit. :arg version_type: Specific version type. Valid choices are - internal, external, external_gte, force. + external, external_gte, force, internal. """ if index in SKIP_IN_PATH: raise ValueError("Empty value passed for a required argument 'index'.") @@ -2656,7 +2656,7 @@ def update( :arg refresh: If 'true', OpenSearch refreshes the affected shards to make this operationvisible to search, if 'wait_for' then wait for a refresh to make this operationvisible to search, if 'false' do - nothing with refreshes. Valid choices are true, false, wait_for. + nothing with refreshes. Valid choices are false, true, wait_for. :arg require_alias: If true, the destination must be an index alias. Default is false. :arg retry_on_conflict: Specify how many times should the @@ -2805,7 +2805,7 @@ def update_by_query( :arg search_timeout: Explicit timeout for each search request. :arg search_type: The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`. Valid choices are - query_then_fetch, dfs_query_then_fetch. + dfs_query_then_fetch, query_then_fetch. :arg size: Deprecated, please use `max_docs` instead. :arg slices: The number of slices this task should be divided into. Valid choices are auto. @@ -2965,7 +2965,7 @@ def create_pit( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg human: Whether to return human readable values for diff --git a/opensearchpy/client/cat.py b/opensearchpy/client/cat.py index eaa155ca..16255cd4 100644 --- a/opensearchpy/client/cat.py +++ b/opensearchpy/client/cat.py @@ -72,7 +72,7 @@ def aliases( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg format: A short version of the Accept header, e.g. json, @@ -118,7 +118,7 @@ def all_pit_segments( :arg bytes: The unit in which to display byte values. Valid - choices are b, k, kb, m, mb, g, gb, t, tb, p, pb. + choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg error_trace: Whether to include the stack trace of returned errors. :arg filter_path: Comma-separated list of filters used to reduce @@ -171,7 +171,7 @@ def allocation( :arg node_id: Comma-separated list of node identifiers or names used to limit the returned information. :arg bytes: The unit used to display byte values. Valid choices - are b, k, kb, m, mb, g, gb, t, tb, p, pb. + are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned @@ -332,7 +332,7 @@ def fielddata( :arg fields: Comma-separated list of fields used to limit returned information. :arg bytes: The unit used to display byte values. Valid choices - are b, k, kb, m, mb, g, gb, t, tb, p, pb. + are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg error_trace: Whether to include the stack trace of returned errors. :arg filter_path: Comma-separated list of filters used to reduce @@ -398,7 +398,7 @@ def health( :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg time: The unit used to display time values. Valid choices - are nanos, micros, ms, s, m, h, d. + are d, h, m, micros, ms, nanos, s. :arg ts: If true, returns `HH:MM:SS` and Unix epoch timestamps. Default is True. :arg v: Verbose mode. Display column headers. Default is false. @@ -468,13 +468,13 @@ def indices( aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. :arg bytes: The unit used to display byte values. Valid choices - are b, k, kb, m, mb, g, gb, t, tb, p, pb. + are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: The type of index that wildcard patterns - can match. Valid choices are all, open, closed, hidden, none. + can match. Valid choices are all, closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg format: A short version of the Accept header, e.g. json, @@ -482,7 +482,7 @@ def indices( :arg h: Comma-separated list of column names to display. :arg health: The health status used to limit returned indices. By default, the response includes indices of any health status. Valid - choices are green, yellow, red. + choices are green, red, yellow. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for statistics. @@ -503,7 +503,7 @@ def indices( :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg time: The unit used to display time values. Valid choices - are nanos, micros, ms, s, m, h, d. + are d, h, m, micros, ms, nanos, s. :arg v: Verbose mode. Display column headers. Default is false. """ return self.transport.perform_request( @@ -649,7 +649,7 @@ def nodes( :arg bytes: The unit used to display byte values. Valid choices - are b, k, kb, m, mb, g, gb, t, tb, p, pb. + are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned @@ -677,7 +677,7 @@ def nodes( :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg time: The unit in which to display time values. Valid - choices are nanos, micros, ms, s, m, h, d. + choices are d, h, m, micros, ms, nanos, s. :arg v: Verbose mode. Display column headers. Default is false. """ return self.transport.perform_request( @@ -733,7 +733,7 @@ def pending_tasks( :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg time: The unit in which to display time values. Valid - choices are nanos, micros, ms, s, m, h, d. + choices are d, h, m, micros, ms, nanos, s. :arg v: Verbose mode. Display column headers. Default is false. """ return self.transport.perform_request( @@ -764,7 +764,7 @@ def pit_segments( :arg bytes: The unit in which to display byte values. Valid - choices are b, k, kb, m, mb, g, gb, t, tb, p, pb. + choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg error_trace: Whether to include the stack trace of returned errors. :arg filter_path: Comma-separated list of filters used to reduce @@ -871,7 +871,7 @@ def recovery( :arg active_only: If `true`, the response only includes ongoing shard recoveries. Default is false. :arg bytes: The unit used to display byte values. Valid choices - are b, k, kb, m, mb, g, gb, t, tb, p, pb. + are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg detailed: If `true`, the response includes detailed information about shard recoveries. Default is false. :arg error_trace: Whether to include the stack trace of returned @@ -891,7 +891,7 @@ def recovery( :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg time: The unit in which to display time values. Valid - choices are nanos, micros, ms, s, m, h, d. + choices are d, h, m, micros, ms, nanos, s. :arg v: Verbose mode. Display column headers. Default is false. """ return self.transport.perform_request( @@ -993,7 +993,7 @@ def segment_replication( expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). :arg bytes: The unit in which to display byte values. Valid - choices are b, k, kb, m, mb, g, gb, t, tb, p, pb. + choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg completed_only: If `true`, the response only includes latest completed segment replication events. Default is false. :arg detailed: If `true`, the response includes detailed @@ -1002,7 +1002,7 @@ def segment_replication( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg format: A short version of the Accept header, e.g. json, @@ -1023,7 +1023,7 @@ def segment_replication( :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg time: The unit in which to display time values. Valid - choices are nanos, micros, ms, s, m, h, d. + choices are d, h, m, micros, ms, nanos, s. :arg timeout: Operation timeout. :arg v: Verbose mode. Display column headers. Default is false. """ @@ -1063,7 +1063,7 @@ def segments( aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. :arg bytes: The unit used to display byte values. Valid choices - are b, k, kb, m, mb, g, gb, t, tb, p, pb. + are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned @@ -1122,7 +1122,7 @@ def shards( aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. :arg bytes: The unit used to display byte values. Valid choices - are b, k, kb, m, mb, g, gb, t, tb, p, pb. + are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned @@ -1147,7 +1147,7 @@ def shards( :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg time: The unit in which to display time values. Valid - choices are nanos, micros, ms, s, m, h, d. + choices are d, h, m, micros, ms, nanos, s. :arg v: Verbose mode. Display column headers. Default is false. """ return self.transport.perform_request( @@ -1270,7 +1270,7 @@ def snapshots( :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg time: The unit in which to display time values. Valid - choices are nanos, micros, ms, s, m, h, d. + choices are d, h, m, micros, ms, nanos, s. :arg v: Verbose mode. Display column headers. Default is false. """ return self.transport.perform_request( @@ -1334,7 +1334,7 @@ def tasks( :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg time: The unit in which to display time values. Valid - choices are nanos, micros, ms, s, m, h, d. + choices are d, h, m, micros, ms, nanos, s. :arg v: Verbose mode. Display column headers. Default is false. """ return self.transport.perform_request( diff --git a/opensearchpy/client/cluster.py b/opensearchpy/client/cluster.py index 6bffedfe..ecf2f159 100644 --- a/opensearchpy/client/cluster.py +++ b/opensearchpy/client/cluster.py @@ -82,14 +82,14 @@ def health( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg human: Whether to return human readable values for statistics. :arg level: Can be one of cluster, indices or shards. Controls the details level of the health information returned. Valid choices are - cluster, indices, shards, awareness_attributes. + awareness_attributes, cluster, indices, shards. :arg local: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. Default is false. @@ -109,8 +109,8 @@ def health( be active, or 0 to not wait. Valid choices are all, index-setting. :arg wait_for_events: Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the - given priority are processed. Valid choices are immediate, urgent, high, - normal, low, languid. + given priority are processed. Valid choices are high, immediate, + languid, low, normal, urgent. :arg wait_for_no_initializing_shards: A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will @@ -126,7 +126,7 @@ def health( :arg wait_for_status: One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will - not wait for any status. Valid choices are green, yellow, red. + not wait for any status. Valid choices are green, red, yellow. """ return self.transport.perform_request( "GET", @@ -219,7 +219,7 @@ def state( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg flat_settings: Return settings in flat format. Default is diff --git a/opensearchpy/client/indices.py b/opensearchpy/client/indices.py index 5ebb95da..5e5aa27c 100644 --- a/opensearchpy/client/indices.py +++ b/opensearchpy/client/indices.py @@ -348,7 +348,7 @@ def get( can match. If the request can target data streams, this argumentdetermines whether wildcard expressions match hidden data streams. Supports comma-separated values,such as open,hidden. Valid - choices are all, open, closed, hidden, none. + choices are all, closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg flat_settings: If true, returns settings in flat format. @@ -1377,8 +1377,8 @@ def get_settings( :arg 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 choices are all, open, - closed, hidden, none. + separated values, such as `open,hidden`. Valid choices are all, closed, + hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg flat_settings: If `true`, returns settings in flat format. @@ -1447,8 +1447,8 @@ def put_settings( :arg expand_wildcards: Type of index that wildcard patterns can match. If the request can targetdata streams, this argument determines whether wildcard expressions matchhidden data streams. Supports comma- - separated values, such as`open,hidden`. Valid choices are all, open, - closed, hidden, none. + separated values, such as`open,hidden`. Valid choices are all, closed, + hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg flat_settings: If `true`, returns settings in flat format. @@ -1520,8 +1520,8 @@ def stats( :arg expand_wildcards: Type of index that wildcard patterns can match. If the request can target data streams, this argumentdetermines whether wildcard expressions match hidden data streams. Supports comma- - separated values,such as `open,hidden`. Valid choices are all, open, - closed, hidden, none. + separated values,such as `open,hidden`. Valid choices are all, closed, + hidden, none, open. :arg fielddata_fields: Comma-separated list or wildcard expressions of fields to include in fielddata statistics. :arg fields: Comma-separated list or wildcard expressions of @@ -1820,7 +1820,7 @@ def upgrade( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg human: Whether to return human readable values for @@ -1869,7 +1869,7 @@ def get_upgrade( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg human: Whether to return human readable values for @@ -1917,7 +1917,7 @@ def shard_stores( :arg 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. Valid choices - are all, open, closed, hidden, none. + are all, closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg human: Whether to return human readable values for @@ -1969,7 +1969,7 @@ def forcemerge( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg flush: Specify whether the index should be flushed after @@ -2712,7 +2712,7 @@ def add_block( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg filter_path: Comma-separated list of filters used to reduce the response. :arg human: Whether to return human readable values for diff --git a/opensearchpy/client/nodes.py b/opensearchpy/client/nodes.py index 7eff84ac..69734e2b 100644 --- a/opensearchpy/client/nodes.py +++ b/opensearchpy/client/nodes.py @@ -220,8 +220,8 @@ def hot_threads( the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. - :arg doc_type: The type to sample. Valid choices are cpu, wait, - block. + :arg doc_type: The type to sample. Valid choices are block, cpu, + wait. :arg error_trace: Whether to include the stack trace of returned errors. :arg filter_path: Comma-separated list of filters used to reduce diff --git a/opensearchpy/client/tasks.py b/opensearchpy/client/tasks.py index 03705432..237db1e0 100644 --- a/opensearchpy/client/tasks.py +++ b/opensearchpy/client/tasks.py @@ -73,7 +73,7 @@ def list( :arg filter_path: Comma-separated list of filters used to reduce the response. :arg group_by: Key used to group tasks in the response. Valid - choices are nodes, parents, none. + choices are nodes, none, parents. :arg human: Whether to return human readable values for statistics. :arg nodes: Comma-separated list of node IDs or names to limit diff --git a/opensearchpy/plugins/knn.py b/opensearchpy/plugins/knn.py index 992180cd..9e2f61e2 100644 --- a/opensearchpy/plugins/knn.py +++ b/opensearchpy/plugins/knn.py @@ -180,7 +180,7 @@ def search_models( errors. :arg expand_wildcards: Whether to expand wildcard expression to concrete indices that are open, closed or both. Valid choices are all, - open, closed, hidden, none. + closed, hidden, none, open. :arg explain: Specify whether to return detailed information about score computation as part of a hit. :arg filter_path: Comma-separated list of filters used to reduce @@ -219,7 +219,7 @@ def search_models( :arg scroll: Specify how long a consistent view of the index should be maintained for scrolled search. :arg search_type: Search operation type. Valid choices are - query_then_fetch, dfs_query_then_fetch. + dfs_query_then_fetch, query_then_fetch. :arg seq_no_primary_term: Specify whether to return sequence number and primary term of the last modification of each hit. :arg size: Number of hits to return. Default is 10. @@ -232,7 +232,7 @@ def search_models( return. :arg suggest_field: Specify which field to use for suggestions. :arg suggest_mode: Specify suggest mode. Valid choices are - missing, popular, always. + always, missing, popular. :arg suggest_size: How many suggestions to return in response. :arg suggest_text: The source text for which the suggestions should be returned. diff --git a/opensearchpy/plugins/notifications.py b/opensearchpy/plugins/notifications.py index ed1e4f1a..97f95974 100644 --- a/opensearchpy/plugins/notifications.py +++ b/opensearchpy/plugins/notifications.py @@ -212,8 +212,8 @@ def get_configs( :arg config_type: Type of notification configuration. Valid - choices are slack, chime, microsoft_teams, webhook, email, sns, - ses_account, smtp_account, email_group. + choices are chime, email, email_group, microsoft_teams, ses_account, + slack, smtp_account, sns, webhook. :arg error_trace: Whether to include the stack trace of returned errors. :arg filter_path: Comma-separated list of filters used to reduce