Release 7.8.0a1

Author: sethmlarson

Changelog.rst

@@ -105,24 +105,24 @@ async def submit(self, body=None, index=None, params=None, headers=None):
  expression resolves into no concrete indices. (This includes `_all`
  string or when no indices have been specified)
  :arg allow_partial_search_results: Indicate if an error should
- be returned if there is a partial search failure or timeout  Default:
+ be returned if there is a partial search failure or timeout Default:
  True
  :arg analyze_wildcard: Specify whether wildcard and prefix
  queries should be analyzed (default: false)
  :arg analyzer: The analyzer to use for the query string
  :arg batched_reduce_size: The number of shard results that
  should be reduced at once on the coordinating node. This value should be
  used as the granularity at which progress results will be made
- available.  Default: 5
+ available. Default: 5
  :arg default_operator: The default operator for query string
- query (AND or OR)  Valid choices: AND, OR  Default: OR
+ query (AND or OR) Valid choices: AND, OR Default: OR
  :arg df: The field to use as default where no field prefix is
  given in the query string
  :arg docvalue_fields: A comma-separated list of fields to return
  as the docvalue representation of a field for each hit
  :arg expand_wildcards: Whether to expand wildcard expression to
- concrete indices that are open, closed or both.  Valid choices: open,
- closed, hidden, none, all  Default: open
+ concrete indices that are open, closed or both. Valid choices: open,
+ closed, hidden, none, all Default: open
  :arg explain: Specify whether to return detailed information
  about score computation as part of a hit
  :arg from_: Starting offset (default: 0)
@@ -131,7 +131,7 @@ async def submit(self, body=None, index=None, params=None, headers=None):
  :arg ignore_unavailable: Whether specified concrete indices
  should be ignored when unavailable (missing or closed)
  :arg keep_alive: Update the time interval in which the results
- (partial or final) for this search will be available  Default: 5d
+ (partial or final) for this search will be available Default: 5d
  :arg keep_on_completion: Control whether the response should be
  stored in the cluster if it completed within the provided
  [wait_for_completion] time (default: false)
@@ -140,14 +140,14 @@ async def submit(self, body=None, index=None, params=None, headers=None):
  :arg max_concurrent_shard_requests: 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  Default: 5
+ to limit the number of concurrent shard requests Default: 5
  :arg preference: Specify the node or shard the operation should
  be performed on (default: random)
  :arg q: Query in the Lucene query string syntax
  :arg request_cache: Specify if request cache should be used for
  this request or not, defaults to true
  :arg routing: A comma-separated list of specific routing values
- :arg search_type: Search operation type  Valid choices:
+ :arg search_type: Search operation type Valid choices:
  query_then_fetch, dfs_query_then_fetch
  :arg seq_no_primary_term: Specify whether to return sequence
  number and primary term of the last modification of each hit
@@ -158,8 +158,8 @@ async def submit(self, body=None, index=None, params=None, headers=None):
  :arg stored_fields: A comma-separated list of stored fields to
  return as part of a hit
  :arg suggest_field: Specify which field to use for suggestions
- :arg suggest_mode: Specify suggest mode  Valid choices:
- missing, popular, always  Default: missing
+ :arg suggest_mode: Specify suggest mode Valid choices: missing,
+ popular, always Default: missing
  :arg suggest_size: How many suggestions to return in response
  :arg suggest_text: The source text for which the suggestions
  should be returned
@@ -176,7 +176,7 @@ async def submit(self, body=None, index=None, params=None, headers=None):
  :arg version: Specify whether to return document version as part
  of a hit
  :arg wait_for_completion_timeout: Specify the time that the
- request should block waiting for the final response  Default: 1s
+ request should block waiting for the final response Default: 1s
  """
  # from is a reserved word so it cannot be used, use from_ instead
  if "from_" in params:

elasticsearch/_async/client/__init__.py

@@ -15,8 +15,8 @@ async def aliases(self, name=None, params=None, headers=None):
 
  :arg name: A comma-separated list of alias names to return
  :arg expand_wildcards: Whether to expand wildcard expression to
- concrete indices that are open, closed or both.  Valid choices: open,
- closed, hidden, none, all  Default: all
+ concrete indices that are open, closed or both. Valid choices: open,
+ closed, hidden, none, all Default: all
  :arg format: a short version of the Accept header, e.g. json,
  yaml
  :arg h: Comma-separated list of column names to display
@@ -40,7 +40,7 @@ async def allocation(self, node_id=None, params=None, headers=None):
 
  :arg node_id: A comma-separated list of node IDs or names to
  limit the returned information
- :arg bytes: The unit in which to display byte values  Valid
+ :arg bytes: The unit in which to display byte values Valid
  choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
  :arg format: a short version of the Accept header, e.g. json,
  yaml
@@ -94,9 +94,9 @@ async def health(self, params=None, headers=None):
  :arg help: Return help information
  :arg s: Comma-separated list of column names or column aliases
  to sort by
- :arg time: The unit in which to display time values  Valid
+ :arg time: The unit in which to display time values Valid
  choices: d, h, m, s, ms, micros, nanos
- :arg ts: Set to false to disable timestamping  Default: True
+ :arg ts: Set to false to disable timestamping Default: True
  :arg v: Verbose mode. Display column headers
  """
  return await self.transport.perform_request(
@@ -140,17 +140,17 @@ async def indices(self, index=None, params=None, headers=None):
 
  :arg index: A comma-separated list of index names to limit the
  returned information
- :arg bytes: The unit in which to display byte values  Valid
+ :arg bytes: The unit in which to display byte values Valid
  choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
  :arg expand_wildcards: Whether to expand wildcard expression to
- concrete indices that are open, closed or both.  Valid choices: open,
- closed, hidden, none, all  Default: all
+ concrete indices that are open, closed or both. Valid choices: open,
+ closed, hidden, none, all Default: all
  :arg format: a short version of the Accept header, e.g. json,
  yaml
  :arg h: Comma-separated list of column names to display
  :arg health: A health status ("green", "yellow", or "red" to
- filter only indices matching the specified health status  Valid
- choices: green, yellow, red
+ filter only indices matching the specified health status Valid choices:
+ green, yellow, red
  :arg help: Return help information
  :arg include_unloaded_segments: If set to true segment stats
  will include stats for segments that are not currently loaded into
@@ -162,7 +162,7 @@ async def indices(self, index=None, params=None, headers=None):
  :arg pri: Set to true to return stats only for primary shards
  :arg s: Comma-separated list of column names or column aliases
  to sort by
- :arg time: The unit in which to display time values  Valid
+ :arg time: The unit in which to display time values Valid
  choices: d, h, m, s, ms, micros, nanos
  :arg v: Verbose mode. Display column headers
  """
@@ -209,7 +209,7 @@ async def nodes(self, params=None, headers=None):
  Returns basic statistics about performance of cluster nodes.
  `<https://www.elastic.co/guide/en/elasticsearch/reference/7.8/cat-nodes.html>`_
 
- :arg bytes: The unit in which to display byte values  Valid
+ :arg bytes: The unit in which to display byte values Valid
  choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
  :arg format: a short version of the Accept header, e.g. json,
  yaml
@@ -223,7 +223,7 @@ async def nodes(self, params=None, headers=None):
  to master node
  :arg s: Comma-separated list of column names or column aliases
  to sort by
- :arg time: The unit in which to display time values  Valid
+ :arg time: The unit in which to display time values Valid
  choices: d, h, m, s, ms, micros, nanos
  :arg v: Verbose mode. Display column headers
  """
@@ -243,7 +243,7 @@ async def recovery(self, index=None, params=None, headers=None):
  names to limit the returned information
  :arg active_only: If `true`, the response only includes ongoing
  shard recoveries
- :arg bytes: The unit in which to display byte values  Valid
+ :arg bytes: The unit in which to display byte values Valid
  choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
  :arg detailed: If `true`, the response includes detailed
  information about shard recoveries
@@ -253,7 +253,7 @@ async def recovery(self, index=None, params=None, headers=None):
  :arg help: Return help information
  :arg s: Comma-separated list of column names or column aliases
  to sort by
- :arg time: The unit in which to display time values  Valid
+ :arg time: The unit in which to display time values Valid
  choices: d, h, m, s, ms, micros, nanos
  :arg v: Verbose mode. Display column headers
  """
@@ -271,7 +271,7 @@ async def shards(self, index=None, params=None, headers=None):
 
  :arg index: A comma-separated list of index names to limit the
  returned information
- :arg bytes: The unit in which to display byte values  Valid
+ :arg bytes: The unit in which to display byte values Valid
  choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
  :arg format: a short version of the Accept header, e.g. json,
  yaml
@@ -283,7 +283,7 @@ async def shards(self, index=None, params=None, headers=None):
  to master node
  :arg s: Comma-separated list of column names or column aliases
  to sort by
- :arg time: The unit in which to display time values  Valid
+ :arg time: The unit in which to display time values Valid
  choices: d, h, m, s, ms, micros, nanos
  :arg v: Verbose mode. Display column headers
  """
@@ -299,7 +299,7 @@ async def segments(self, index=None, params=None, headers=None):
 
  :arg index: A comma-separated list of index names to limit the
  returned information
- :arg bytes: The unit in which to display byte values  Valid
+ :arg bytes: The unit in which to display byte values Valid
  choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
  :arg format: a short version of the Accept header, e.g. json,
  yaml
@@ -329,7 +329,7 @@ async def pending_tasks(self, params=None, headers=None):
  to master node
  :arg s: Comma-separated list of column names or column aliases
  to sort by
- :arg time: The unit in which to display time values  Valid
+ :arg time: The unit in which to display time values Valid
  choices: d, h, m, s, ms, micros, nanos
  :arg v: Verbose mode. Display column headers
  """
@@ -356,7 +356,7 @@ async def thread_pool(self, thread_pool_patterns=None, params=None, headers=None
  to master node
  :arg s: Comma-separated list of column names or column aliases
  to sort by
- :arg size: The multiplier in which to display values  Valid
+ :arg size: The multiplier in which to display values Valid
  choices: , k, m, g, t, p
  :arg v: Verbose mode. Display column headers
  """
@@ -376,7 +376,7 @@ async def fielddata(self, fields=None, params=None, headers=None):
 
  :arg fields: A comma-separated list of fields to return in the
  output
- :arg bytes: The unit in which to display byte values  Valid
+ :arg bytes: The unit in which to display byte values Valid
  choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
  :arg format: a short version of the Accept header, e.g. json,
  yaml
@@ -479,7 +479,7 @@ async def snapshots(self, repository=None, params=None, headers=None):
  to master node
  :arg s: Comma-separated list of column names or column aliases
  to sort by
- :arg time: The unit in which to display time values  Valid
+ :arg time: The unit in which to display time values Valid
  choices: d, h, m, s, ms, micros, nanos
  :arg v: Verbose mode. Display column headers
  """
@@ -523,7 +523,7 @@ async def tasks(self, params=None, headers=None):
  Set to -1 to return all.
  :arg s: Comma-separated list of column names or column aliases
  to sort by
- :arg time: The unit in which to display time values  Valid
+ :arg time: The unit in which to display time values Valid
  choices: d, h, m, s, ms, micros, nanos
  :arg v: Verbose mode. Display column headers
  """
@@ -564,15 +564,15 @@ async def ml_data_frame_analytics(self, id=None, params=None, headers=None):
  :arg allow_no_match: Whether to ignore if a wildcard expression
  matches no configs. (This includes `_all` string or when no configs have
  been specified)
- :arg bytes: The unit in which to display byte values  Valid
+ :arg bytes: The unit in which to display byte values Valid
  choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
  :arg format: a short version of the Accept header, e.g. json,
  yaml
  :arg h: Comma-separated list of column names to display
  :arg help: Return help information
  :arg s: Comma-separated list of column names or column aliases
  to sort by
- :arg time: The unit in which to display time values  Valid
+ :arg time: The unit in which to display time values Valid
  choices: d, h, m, s, ms, micros, nanos
  :arg v: Verbose mode. Display column headers
  """
@@ -599,7 +599,7 @@ async def ml_datafeeds(self, datafeed_id=None, params=None, headers=None):
  :arg help: Return help information
  :arg s: Comma-separated list of column names or column aliases
  to sort by
- :arg time: The unit in which to display time values  Valid
+ :arg time: The unit in which to display time values Valid
  choices: d, h, m, s, ms, micros, nanos
  :arg v: Verbose mode. Display column headers
  """
@@ -620,15 +620,15 @@ async def ml_jobs(self, job_id=None, params=None, headers=None):
  :arg allow_no_jobs: Whether to ignore if a wildcard expression
  matches no jobs. (This includes `_all` string or when no jobs have been
  specified)
- :arg bytes: The unit in which to display byte values  Valid
+ :arg bytes: The unit in which to display byte values Valid
  choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
  :arg format: a short version of the Accept header, e.g. json,
  yaml
  :arg h: Comma-separated list of column names to display
  :arg help: Return help information
  :arg s: Comma-separated list of column names or column aliases
  to sort by
- :arg time: The unit in which to display time values  Valid
+ :arg time: The unit in which to display time values Valid
  choices: d, h, m, s, ms, micros, nanos
  :arg v: Verbose mode. Display column headers
  """
@@ -659,8 +659,8 @@ async def ml_trained_models(self, model_id=None, params=None, headers=None):
  :arg model_id: The ID of the trained models stats to fetch
  :arg allow_no_match: Whether to ignore if a wildcard expression
  matches no trained models. (This includes `_all` string or when no
- trained models have been specified)  Default: True
- :arg bytes: The unit in which to display byte values  Valid
+ trained models have been specified) Default: True
+ :arg bytes: The unit in which to display byte values Valid
  choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
  :arg format: a short version of the Accept header, e.g. json,
  yaml
@@ -671,7 +671,7 @@ async def ml_trained_models(self, model_id=None, params=None, headers=None):
  to sort by
  :arg size: specifies a max number of trained models to get
  Default: 100
- :arg time: The unit in which to display time values  Valid
+ :arg time: The unit in which to display time values Valid
  choices: d, h, m, s, ms, micros, nanos
  :arg v: Verbose mode. Display column headers
  """
@@ -708,7 +708,7 @@ async def transforms(self, transform_id=None, params=None, headers=None):
  to sort by
  :arg size: specifies a max number of transforms to get, defaults
  to 100
- :arg time: The unit in which to display time values  Valid
+ :arg time: The unit in which to display time values Valid
  choices: d, h, m, s, ms, micros, nanos
  :arg v: Verbose mode. Display column headers
  """

elasticsearch/_async/client/async_search.py

@@ -37,7 +37,7 @@ async def follow(self, index, body, params=None, headers=None):
  that must be active before returning. Defaults to 0. Set to `all` for
  all shard copies, otherwise set to any non-negative value less than or
  equal to the total number of copies for the shard (number of replicas +
- 1)  Default: 0
+ 1) Default: 0
  """
  for param in (index, body):
  if param in SKIP_IN_PATH: