Add more body fields to indices APIs

Author: sethmlarson

elasticsearch/_async/client/__init__.py

@@ -1945,6 +1945,7 @@ async def termvectors(
             "scripted_upsert",
             "upsert",
         ],
+        body_required=True,
     )
     async def update(self, index, id, body, doc_type=None, params=None, headers=None):
         """

elasticsearch/_async/client/indices.py

@@ -99,7 +99,11 @@ async def flush(self, index=None, params=None, headers=None):
         )
 
     @query_params(
-        "include_type_name", "master_timeout", "timeout", "wait_for_active_shards"
+        "include_type_name",
+        "master_timeout",
+        "timeout",
+        "wait_for_active_shards",
+        body_params=["aliases", "mappings", "settings"],
     )
     async def create(self, index, body=None, params=None, headers=None):
         """
@@ -110,9 +114,14 @@ async def create(self, index, body=None, params=None, headers=None):
         :arg index: The name of the index
         :arg body: The configuration for the index (`settings` and
             `mappings`)
+        :arg aliases:
         :arg include_type_name: Whether a type should be expected in the
             body of the mappings.
+        :arg mappings: Mapping for fields in the index. If specified,
+            this mapping can include: - Field names - Field data types - Mapping
+            parameters
         :arg master_timeout: Specify timeout for connection to master
+        :arg settings:
         :arg timeout: Explicit operation timeout
         :arg wait_for_active_shards: Set the number of active shards to
             wait for before the operation returns.
@@ -168,23 +177,29 @@ async def get(self, index, params=None, headers=None):
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/indices-get-index.html>`_
 
-        :arg index: A comma-separated list of index names
+        :arg index: Comma-separated list of data streams, indices, and
+            index aliases used to limit the request. Wildcard expressions (*) are
+            supported.
         :arg allow_no_indices: Ignore if a wildcard expression resolves
-            to no concrete indices (default: false)
-        :arg expand_wildcards: Whether wildcard expressions should get
-            expanded to open or closed indices (default: open)  Valid choices: open,
-            closed, hidden, none, all  Default: open
-        :arg flat_settings: Return settings in flat format (default:
-            false)
-        :arg ignore_unavailable: Ignore unavailable indexes (default:
-            false)
-        :arg include_defaults: Whether to return all default setting for
-            each of the indices.
-        :arg include_type_name: Whether to add the type name to the
-            response (default: false)
-        :arg local: Return local information, do not retrieve the state
-            from master node (default: false)
-        :arg master_timeout: Specify timeout for connection to master
+            to no concrete indices (default: false)  Default: True
+        :arg 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.  Valid choices:
+            open, closed, hidden, none, all  Default: open
+        :arg flat_settings: If true, returns settings in flat format.
+        :arg ignore_unavailable: If false, requests that target a
+            missing index return an error.
+        :arg include_defaults: If true, return all default settings in
+            the response.
+        :arg include_type_name: If true, a mapping type is expected in
+            the body of mappings.
+        :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.
+        :arg master_timeout: 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.  Default: 30s
         """
         if index in SKIP_IN_PATH:
             raise ValueError("Empty value passed for a required argument 'index'.")
@@ -374,6 +389,20 @@ async def exists_type(self, index, doc_type, params=None, headers=None):
         "master_timeout",
         "timeout",
         "write_index_only",
+        body_params=[
+            "_field_names",
+            "_meta",
+            "_routing",
+            "_source",
+            "date_detection",
+            "dynamic",
+            "dynamic_date_formats",
+            "dynamic_templates",
+            "numeric_detection",
+            "properties",
+            "runtime",
+        ],
+        body_required=True,
     )
     async def put_mapping(
         self, body, index=None, doc_type=None, params=None, headers=None
@@ -388,9 +417,26 @@ async def put_mapping(
             should be added to (supports wildcards); use `_all` or omit to add the
             mapping on all indices.
         :arg doc_type: The name of the document type
+        :arg _field_names: Control whether field names are enabled for
+            the index.
+        :arg _meta: A mapping type can have custom meta data associated
+            with it. These are not used at all by Elasticsearch, but can be used to
+            store application-specific metadata.
+        :arg _routing: Enable making a routing value required on indexed
+            documents.
+        :arg _source: Control whether the _source field is enabled on
+            the index.
         :arg 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)
+        :arg date_detection: Controls whether dynamic date detection is
+            enabled.
+        :arg dynamic: Controls whether new fields are added dynamically.
+        :arg dynamic_date_formats: If date detection is enabled then new
+            string fields are checked against 'dynamic_date_formats' and if the
+            value matches then a new date field is added instead of string.
+        :arg dynamic_templates: Specify dynamic templates for the
+            mapping.
         :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
@@ -399,6 +445,11 @@ async def put_mapping(
         :arg include_type_name: Whether a type should be expected in the
             body of the mappings.
         :arg master_timeout: Specify timeout for connection to master
+        :arg numeric_detection: Automatically map strings into numeric
+            data types for all fields.
+        :arg properties: Mapping for a field. For new fields, this
+            mapping can include: - Field name - Field data type - Mapping parameters
+        :arg runtime: Mapping of runtime fields for the index.
         :arg timeout: Explicit operation timeout
         :arg write_index_only: When true, applies mappings only to the
             write index of an alias or data stream
@@ -411,7 +462,7 @@ async def put_mapping(
 
         return await self.transport.perform_request(
             "PUT",
-            _make_path(index, doc_type, "_mapping"),
+            _make_path(index, doc_type, "_mappings"),
             params=params,
             headers=headers,
             body=body,
@@ -498,7 +549,17 @@ async def get_field_mapping(
             headers=headers,
         )
 
-    @query_params("master_timeout", "timeout")
+    @query_params(
+        "master_timeout",
+        "timeout",
+        body_params=[
+            "filter",
+            "index_routing",
+            "is_write_index",
+            "routing",
+            "search_routing",
+        ],
+    )
     async def put_alias(self, index, name, body=None, params=None, headers=None):
         """
         Creates or updates an alias.
@@ -511,7 +572,12 @@ async def put_alias(self, index, name, body=None, params=None, headers=None):
         :arg name: The name of the alias to be created or updated
         :arg body: The settings for the alias, such as `routing` or
             `filter`
+        :arg filter:
+        :arg index_routing:
+        :arg is_write_index:
         :arg master_timeout: Specify timeout for connection to master
+        :arg routing:
+        :arg search_routing:
         :arg timeout: Explicit timestamp for the document
         """
         for param in (index, name):
@@ -520,7 +586,7 @@ async def put_alias(self, index, name, body=None, params=None, headers=None):
 
         return await self.transport.perform_request(
             "PUT",
-            _make_path(index, "_alias", name),
+            _make_path(index, "_aliases", name),
             params=params,
             headers=headers,
             body=body,
@@ -616,10 +682,28 @@ async def delete_alias(self, index, name, params=None, headers=None):
                 raise ValueError("Empty value passed for a required argument.")
 
         return await self.transport.perform_request(
-            "DELETE", _make_path(index, "_alias", name), params=params, headers=headers
+            "DELETE",
+            _make_path(index, "_aliases", name),
+            params=params,
+            headers=headers,
         )
 
-    @query_params("create", "include_type_name", "master_timeout", "order")
+    @query_params(
+        "create",
+        "flat_settings",
+        "include_type_name",
+        "master_timeout",
+        "timeout",
+        body_params=[
+            "aliases",
+            "index_patterns",
+            "mappings",
+            "order",
+            "settings",
+            "version",
+        ],
+        body_required=True,
+    )
     async def put_template(self, name, body, params=None, headers=None):
         """
         Creates or updates an index template.
@@ -628,14 +712,26 @@ async def put_template(self, name, body, params=None, headers=None):
 
         :arg name: The name of the template
         :arg body: The template definition
-        :arg create: Whether the index template should only be added if
-            new or can also replace an existing one
+        :arg aliases: Aliases for the index.
+        :arg create: If true, this request cannot replace or update
+            existing index templates.
+        :arg flat_settings:
         :arg include_type_name: Whether a type should be returned in the
             body of the mappings.
-        :arg master_timeout: Specify timeout for connection to master
-        :arg order: The order for this template when merging multiple
-            matching ones (higher numbers are merged later, overriding the lower
-            numbers)
+        :arg index_patterns: Array of wildcard expressions used to match
+            the names of indices during creation.
+        :arg mappings: Mapping for fields in the index.
+        :arg master_timeout: 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.  Default: 30s
+        :arg order: Order in which Elasticsearch applies this template
+            if index matches multiple templates. Templates with lower 'order' values
+            are merged first. Templates with higher 'order' values are merged later,
+            overriding templates with lower values.
+        :arg settings: Configuration options for the index.
+        :arg timeout:
+        :arg version: Version number used to manage index templates
+            externally. This number is not automatically generated by Elasticsearch.
         """
         for param in (name, body):
             if param in SKIP_IN_PATH:
@@ -814,9 +910,7 @@ async def stats(self, index=None, metric=None, params=None, headers=None):
         :arg index: A comma-separated list of index names; use `_all` or
             empty string to perform the operation on all indices
         :arg metric: Limit the information returned the specific
-            metrics.  Valid choices: _all, completion, docs, fielddata, query_cache,
-            flush, get, indexing, merge, request_cache, refresh, search, segments,
-            store, warmer, suggest
+            metrics.
         :arg completion_fields: A comma-separated list of fields for
             `fielddata` and `suggest` index metric (supports wildcards)
         :arg expand_wildcards: Whether to expand wildcard expression to