Make all parameters keyword-only in type stubs

Author: sethmlarson

elasticsearch/_async/client/__init__.py

@@ -471,15 +471,15 @@ async def bulk(self, body, index=None, doc_type=None, params=None, headers=None)
         )
 
     @query_params()
-    async def clear_scroll(self, body=None, scroll_id=None, params=None, headers=None):
+    async def clear_scroll(self, scroll_id=None, body=None, params=None, headers=None):
         """
         Explicitly clears the search context for a scroll.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/clear-scroll-api.html>`_
 
+        :arg scroll_id: A comma-separated list of scroll IDs to clear
         :arg body: A comma-separated list of scroll IDs to clear if none
             was specified via the scroll_id parameter
-        :arg scroll_id: A comma-separated list of scroll IDs to clear
         """
         if scroll_id in SKIP_IN_PATH and body in SKIP_IN_PATH:
             raise ValueError("You need to supply scroll_id or body.")
@@ -509,15 +509,13 @@ async def clear_scroll(self, body=None, scroll_id=None, params=None, headers=Non
         "terminate_after",
     )
     async def count(
-        self, body=None, index=None, doc_type=None, params=None, headers=None
+        self, index=None, doc_type=None, body=None, params=None, headers=None
     ):
         """
         Returns number of documents matching a query.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-count.html>`_
 
-        :arg body: A query to restrict the results specified with the
-            Query DSL (optional)
         :arg index: A comma-separated list of indices to restrict the
             results
         :arg doc_type: A comma-separated list of types to restrict the
@@ -549,6 +547,8 @@ async def count(
         :arg routing: A comma-separated list of specific routing values
         :arg terminate_after: The maximum count for each shard, upon
             reaching which the query execution will terminate early
+        :arg body: A query to restrict the results specified with the
+            Query DSL (optional)
         """
         return await self.transport.perform_request(
             "POST",
@@ -899,7 +899,7 @@ async def exists_source(self, index, id, doc_type=None, params=None, headers=Non
         "stored_fields",
     )
     async def explain(
-        self, index, id, body=None, doc_type=None, params=None, headers=None
+        self, index, id, doc_type=None, body=None, params=None, headers=None
     ):
         """
         Returns information about why a specific matches (or doesn't match) a query.
@@ -908,7 +908,6 @@ async def explain(
 
         :arg index: The name of the index
         :arg id: The document ID
-        :arg body: The query definition using the Query DSL
         :arg doc_type: The type of the document
         :arg _source: True or false to return the _source field or not,
             or a list of fields to return
@@ -931,6 +930,7 @@ async def explain(
         :arg routing: Specific routing value
         :arg stored_fields: A comma-separated list of stored fields to
             return in the response
+        :arg body: The query definition using the Query DSL
         """
         for param in (index, id):
             if param in SKIP_IN_PATH:
@@ -952,14 +952,13 @@ async def explain(
         "ignore_unavailable",
         "include_unmapped",
     )
-    async def field_caps(self, body=None, index=None, params=None, headers=None):
+    async def field_caps(self, index=None, body=None, params=None, headers=None):
         """
         Returns the information about the capabilities of fields among multiple
         indices.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-field-caps.html>`_
 
-        :arg body: An index filter specified with the Query DSL
         :arg index: A comma-separated list of index names; use `_all` or
             empty string to perform the operation on all indices
         :arg allow_no_indices: Whether to ignore if a wildcard indices
@@ -973,6 +972,7 @@ async def field_caps(self, body=None, index=None, params=None, headers=None):
             should be ignored when unavailable (missing or closed)
         :arg include_unmapped: Indicates whether unmapped fields should
             be included in the response.
+        :arg body: An index filter specified with the Query DSL
         """
         return await self.transport.perform_request(
             "POST",
@@ -1266,16 +1266,13 @@ async def msearch_template(
         "version_type",
     )
     async def mtermvectors(
-        self, body=None, index=None, doc_type=None, params=None, headers=None
+        self, index=None, doc_type=None, body=None, params=None, headers=None
     ):
         """
         Returns multiple termvectors in one request.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-multi-termvectors.html>`_
 
-        :arg body: Define ids, documents, parameters or a list of
-            parameters per document here. You must at least provide a list of
-            document ids. See documentation.
         :arg index: The index in which the document resides.
         :arg doc_type: The type of the document.
         :arg field_statistics: Specifies if document count, sum of
@@ -1309,6 +1306,9 @@ async def mtermvectors(
         :arg version: Explicit version number for concurrency control
         :arg version_type: Specific version type  Valid choices:
             internal, external, external_gte, force
+        :arg body: Define ids, documents, parameters or a list of
+            parameters per document here. You must at least provide a list of
+            document ids. See documentation.
         """
         if doc_type in SKIP_IN_PATH:
             path = _make_path(index, "_mtermvectors")
@@ -1328,7 +1328,7 @@ async def put_script(self, id, body, context=None, params=None, headers=None):
 
         :arg id: Script ID
         :arg body: The document
-        :arg context: Context name to compile script against
+        :arg context: Script context
         :arg master_timeout: Specify timeout for connection to master
         :arg timeout: Explicit operation timeout
         """
@@ -1455,15 +1455,15 @@ async def reindex_rethrottle(self, task_id, params=None, headers=None):
 
     @query_params()
     async def render_search_template(
-        self, body=None, id=None, params=None, headers=None
+        self, id=None, body=None, params=None, headers=None
     ):
         """
         Allows to use the Mustache language to pre-render a search definition.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/render-search-template-api.html>`_
 
-        :arg body: The search definition template and its params
         :arg id: The id of the stored search template
+        :arg body: The search definition template and its params
         """
         return await self.transport.perform_request(
             "POST",
@@ -1496,19 +1496,19 @@ async def scripts_painless_execute(self, body=None, params=None, headers=None):
         )
 
     @query_params("rest_total_hits_as_int", "scroll")
-    async def scroll(self, body=None, scroll_id=None, params=None, headers=None):
+    async def scroll(self, scroll_id=None, body=None, params=None, headers=None):
         """
         Allows to retrieve a large numbers of results from a single search request.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-request-body.html#request-body-search-scroll>`_
 
-        :arg body: The scroll ID if not passed by URL or query
-            parameter.
-        :arg scroll_id: The scroll ID for scrolled search
+        :arg scroll_id: The scroll ID
         :arg rest_total_hits_as_int: Indicates whether hits.total should
             be rendered as an integer or an object in the rest search response
         :arg scroll: Specify how long a consistent view of the index
             should be maintained for scrolled search
+        :arg body: The scroll ID if not passed by URL or query
+            parameter.
         """
         if scroll_id in SKIP_IN_PATH and body in SKIP_IN_PATH:
             raise ValueError("You need to supply scroll_id or body.")
@@ -1567,14 +1567,13 @@ async def scroll(self, body=None, scroll_id=None, params=None, headers=None):
         "version",
     )
     async def search(
-        self, body=None, index=None, doc_type=None, params=None, headers=None
+        self, index=None, doc_type=None, body=None, params=None, headers=None
     ):
         """
         Returns results matching a query.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-search.html>`_
 
-        :arg body: The search definition using the Query DSL
         :arg index: A comma-separated list of index names to search; use
             `_all` or empty string to perform the operation on all indices
         :arg doc_type: A comma-separated list of document types to
@@ -1672,6 +1671,7 @@ async def search(
             should be prefixed by their respective types in the response
         :arg version: Specify whether to return document version as part
             of a hit
+        :arg body: The search definition using the Query DSL
         """
         # from is a reserved word so it cannot be used, use from_ instead
         if "from_" in params:
@@ -1801,7 +1801,7 @@ async def search_template(
         "version_type",
     )
     async def termvectors(
-        self, index, body=None, doc_type=None, id=None, params=None, headers=None
+        self, index, doc_type=None, id=None, body=None, params=None, headers=None
     ):
         """
         Returns information and statistics about terms in the fields of a particular
@@ -1810,8 +1810,6 @@ async def termvectors(
         `<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-termvectors.html>`_
 
         :arg index: The index in which the document resides.
-        :arg body: Define parameters and or supply a document to get
-            termvectors for. See documentation.
         :arg doc_type: The type of the document.
         :arg id: The id of the document, when not specified a doc param
             should be supplied.
@@ -1835,6 +1833,8 @@ async def termvectors(
         :arg version: Explicit version number for concurrency control
         :arg version_type: Specific version type  Valid choices:
             internal, external, external_gte, force
+        :arg body: Define parameters and or supply a document to get
+            termvectors for. See documentation.
         """
         if index in SKIP_IN_PATH:
             raise ValueError("Empty value passed for a required argument 'index'.")
@@ -1953,7 +1953,7 @@ async def update(self, index, id, body, doc_type=None, params=None, headers=None
         "wait_for_completion",
     )
     async def update_by_query(
-        self, index, body=None, doc_type=None, params=None, headers=None
+        self, index, doc_type=None, body=None, params=None, headers=None
     ):
         """
         Performs an update on every document in the index without changing the source,
@@ -1963,7 +1963,6 @@ async def update_by_query(
 
         :arg index: A comma-separated list of index names to search; use
             `_all` or empty string to perform the operation on all indices
-        :arg body: The search definition using the Query DSL
         :arg doc_type: A comma-separated list of document types to
             search; leave empty to perform the operation on all types
         :arg _source: True or false to return the _source field or not,
@@ -2037,6 +2036,7 @@ async def update_by_query(
             + 1)
         :arg wait_for_completion: Should the request should block until
             the update by query operation is complete.  Default: True
+        :arg body: The search definition using the Query DSL
         """
         # from is a reserved word so it cannot be used, use from_ instead
         if "from_" in params:
@@ -2197,7 +2197,6 @@ async def search_mvt(
         :arg zoom: Zoom level for the vector tile to search
         :arg x: X coordinate for the vector tile to search
         :arg y: Y coordinate for the vector tile to search
-        :arg body: Search request body.
         :arg exact_bounds: If false, the meta layer's feature is the
             bounding box of the tile. If true, the meta layer's feature is a
             bounding box resulting from a `geo_bounds` aggregation.
@@ -2209,6 +2208,7 @@ async def search_mvt(
             aggs layer.  Valid choices: grid, point  Default: grid
         :arg size: Maximum number of features to return in the hits
             layer. Accepts 0-10000.  Default: 10000
+        :arg body: Search request body.
         """
         for param in (index, field, zoom, x, y):
             if param in SKIP_IN_PATH: